Submission of Customer Bank Account Data to be Stored.

post

https://stage.check21.com/c2/api/customer-account

The POST Customer-Account Endpoint is, in most cases, the second endpoint utilized in the initial transaction submission workflow. The Endpoint can also be used with subsequent transaction submissions, if the Customer Account used is different than what was captured previously (i.e. Customer has more than one bank account). This Endpoint allows clients to store customer bank account data within the Check21.com Gateway and use the Customer Account ID in lieu of the full customer bank account. With the tokenization of sensitive information, the Client mitigates security risks.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerId

int32

required

The Customer ID is provided as a response to the usage of the POST Customer Endpoint.

routingNumber

string

required

length between 9 and 9

The routing number submitted must be valid. If posting a Canadian routing number, the first digit must be a 0 followed by a three digit bank number and a five digit branch number.

accountNumber

string

required

length between 5 and 25

isDefault

string

enum

Defaults to false

This field is used to determine whether the Customer Account being submitted is the default account to be utilized. By setting the default account, the Client may streamline the transaction creation process within the Check21.com Gateway User Interface.

Allowed:

achEntryTypeId

string

enum

required

Defaults to 7

This field is used to determine, in most cases, whether the bank account is a corporate account (CCD), a personal account (PPD), or a Web payment (WEB). Please note the clients financial institution must allow the submission of CCD, PPD, WEB or all other Entry payments. If submitting a Canadian EFT, Entry Types are not required.

isSavings

string

enum

required

Defaults to false

This field is extremely important when submitting ACH transactions, changing the way funds are pulled. If submitting a Canadian EFT, this value is not required.

Allowed:

nickname

string

nameOnAccount

string

status

string

Defaults to ACTIVE

When creating a Customer Account within the Check21.com gateway, the initial Customer Account status must always be Active.

Headers

string

required

application/json should be set.

Content-Type

string

required

application/json should be set.

X-Auth-ApiKeyContent

string

required

Can be found in the administrative user profile within the Check21.com Gateway

X-Auth-ApiKeyAccess

string

required

Can be found in the administrative user profile within the Check21.com Gateway

Responses

200Successful response. Please see Response and Response Model for new or different field names or values being provided.

400Indication that the API Authentication values are incorrect. See message for more details.

422A required field is null or the field value is not valid. In most cases, this represents the routing field whose value is incorrect. See message for more details.