Submission of ACH Credits, Debits or Check Transactions.

post https://stage.check21.com/c2/api/transaction

The POST Transaction Endpoint is the final step in the transaction submission workflow. The Endpoint is used to submit ACH Credits, Debits or Check Transactions.

Body Params

accountId

int32

required

This value is provided by Check21.com and is required for all transaction submissions. The value determines which Client Account (i.e. Client Company) is utilized for transaction submission.

creditBankId

int32

This value is provided by Check21.com and is required if submitting an ACH credit. The value of this field determines the Client bank account which will be utilized to credit the Customer.

checkNumber

string

length between 1 and 15

depositBankId

int32

This value is provided by Check21.com and is required if submitting an ACH or Check Deposit/Debit. The value of this field determines the Client bank account which will be utilized to deposit the check or ACH Debit.

tif64Front

string

Must be a valid cropped front check image in Tiff format. This field is required when submitted a check.

tif64Rear

string

Must be a valid cropped rear check image in Tiff format. This field is required when submitted a check.

companyName

string

length between 3 and 100

companyName is required if firstName and lasName fields are empty. Only commas, hyphens, periods, ampersands, apostrophe symbols are allowed.

firstName

string

length between 3 and 50

firstName is not required if companyName field is not null. Only commas, hyphens, periods, ampersands, apostrophe symbols are allowed. No numbers are allowed.

lastName

string

length between 3 and 50

lastName is not required if companyName field is not null. Only commas, hyphens, periods, ampersands, apostrophe symbols are allowed. No numbers are allowed.

address1

string

length ≤ 100

address2

string

length ≤ 100

city

string

length between 3 and 100

Symbols and numbers are not allowed.

state

string

length between 2 and 20

State data is limited to US States (2 Letter Abbreviation)if Country selected is US. All other countries allow free-form text to be applied within the field. Symbols and numbers are not allowed.

zip

string

length between 5 and 10

If Country selected is US, zip code requires 5 numeric characters. Zip field will be used in lieu of postal code should other countries be selected.

country

string

length between 2 and 2

If a value for the field is not provided, US will be selected by default. If you are unsure of the country code abbreviations, please contact your account manager for a full glossary of data.

phone

string

length between 10 and 13

Parentheses and hyphens are the only symbols allowed. No alpha characters allowed.

string

length between 6 and 50

customerId

int32

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

customerAccountId

int32

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

routingNumber

string

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

length between 5 and 25

isDefault

string

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.

achEntryTypeId

string

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

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.

nickname

string

nameOnAccount

string

externalId

string

length between 1 and 50

This field should be used only if attempting to correlate between your internal customer ID and the Check21.com system.

status

string

required

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

amount

string

required

orderId

string

memo

string

micr

string

length between 18 and 50

Must be a valid MICR using Ts and Us. This field is required when submitted a check.

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 submission to Check21.com returned with a Customer ID.

400Check is duplicated. Can also be an indication that the API Authentication values are incorrect. See message for more details.

422A required field is null. In most cases, this represents the Status field. See message for more details.

500Account ID is not authorized. Ensure the proper API keys and Account ID is being utilized.