Payment parameters (debit)
This page provides information about the required fields to initiate an ACH debit payment. You must include all required fields to initiate a successful payment.
Requirements by country
This section provides the required fields for ACH debit payments by region and country. Review the required fields for the applicable region or country prior to coding.
Europe, the Middle East, and Africa (EMEA)
This section contains the required payment parameters to initiate an ACH debit payment in the EMEA region.
Single Euro Payments Area (SEPA)
The following table contains the required payment parameters to initiate an ACH debit payment in SEPA:
Field |
Description |
Minimum |
Maximum |
Notes |
---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
Must be formatted as YYYY-MM-DD. |
|
The payment's unique end-to-end ID that's assigned by the originator. |
1 |
16 |
|
|
The value’s currency. |
3 |
3 |
Must be |
|
The value’s amount. |
1 |
12 |
|
|
The transfer type. |
6 |
6 |
Must be |
|
The payment type. |
3 |
3 |
Must be |
|
The payment’s service level code. |
4 |
4 |
Must be |
|
The debtor’s name. |
1 |
140 |
|
|
The creditor’s account currency. |
3 |
3 |
For supported values, see Currency codes. |
|
The J.P. Morgan company ID. |
|||
|
The creditor’s country. |
2 |
2 |
Must be a two-letter country code. |
|
The creditor’s individual ID. |
|||
|
The scheme type’s proprietary code. |
4 |
4 |
Must be |
|
The creditor agent’s financial institution ID. |
|||
|
The mandate ID. |
1 |
35 |
Must only include the following characters: a b c d e f g h i j k l m n o p q r s t u v w x y z |
|
The mandate’s signature date. |
10 |
10 |
Must be formatted as YYYY-MM-DD. |
|
The regular account number. |
[IBAN] |
United Kingdom
The following table contains the required payment parameters to initiate an ACH debit payment in the United Kingdom:
Field |
Description |
Minimum |
Maximum |
Notes |
---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
Must be formatted as YYYY-MM-DD. |
|
The payment's unique end-to-end ID that's assigned by the originator. |
1 |
15 |
|
|
The value’s currency. |
3 |
3 |
Must be |
|
The value’s amount. |
1 |
11 |
|
|
The transfer type. |
6 |
6 |
Must be |
|
The payment type. |
3 |
3 |
Must be |
|
The payment’s service-level code. |
4 |
4 |
Must be |
|
The payment’s local instrument code. |
4 |
4 |
Must be |
|
The debtor’s account number. |
8 |
8 |
|
|
The debtor’s account currency. |
3 |
3 |
For supported values, see Currency codes. |
|
The debtor’s name. |
1 |
18 |
|
|
The debtor’s country. |
2 |
2 |
Must be |
debtorAgent.financialInstitutionIds[].id |
The debtor agent's financial institution ID. | 6 | 6 | Must be six-digit UK sort code if non-IBAN provided in directDebitTransactionInformation.debtorAccount.accountNumber . |
|
The debtor agent's financial institution ID type. |
9 |
9 |
Must be |
|
The debtor agent’s country. |
2 |
2 |
Must be a two-letter country code. |
|
The creditor’s account currency. |
3 |
3 |
For supported values, see Currency codes. |
|
The J.P. Morgan company ID. |
1 |
35 |
|
|
The creditor’s name. |
1 |
70 |
J.P. Morgan overlays this data with static data from its client files. |
|
The creditor’s country. |
2 |
2 |
Must be a two-letter country code. |
|
The creditor agent’s financial institution ID. |
8 |
11 |
Must be |
creditorAgent.financialInstitutionIds[].idType |
The creditor agent's financial instution ID type. | 3 | 3 | Must be BIC . |
|
The creditor agent’s country. |
2 |
2 |
Must correspond to debtor agent’s BIC. |
|
The core reference number. |
6 |
18 |
North America (NA)
This section contains the required payment parameters to initiate an ACH debit payment in the NA region.
Canada
The following table contains the required payment parameters to initiate an ACH debit payment in Canada:
Field |
Description |
Minimum |
Maximum |
Notes |
---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
Must be formatted as YYYY-MM-DD. |
|
The payment's unique end-to-end ID that's assigned by the originator. |
1 |
15 |
|
|
The value’s currency. |
3 |
3 |
|
|
The value’s amount. |
1 |
11 |
|
|
The transfer type. |
6 |
6 |
Must be |
|
The payment type. |
3 |
3 |
Must be |
|
The payment’s service-level code. |
4 |
4 |
Must be |
debtor.account.accountNumber |
The debtor's account number. | 12 | 12 |
|
debtor.account.accountCurrency |
The debtor's account currency. | 3 | 3 | Must be CAD or USD . |
|
The debtor’s name. |
1 |
140 |
Only the first 30 characters are sent to clearing. |
debtorAgent.financialInstitutionIds[].id |
The debtor agent's financial institution ID. | 9 | 9 | Must follow format for routing numbers, which is 0AAABBBBB, where AAA is the 3-digit financial institution ID and BBBBB is the branch ID. |
debtorAgent.financialInstitutionIds[].idType |
The debtor agent's financial institution ID type. |
14 | 14 | Must be ROUTING_NUMBER . |
debtorAgent.postalAddress.country |
The debtor's agent's country. | 2 | 2 | Must be CA . |
creditor.account.accountNumber |
The creditor's account number. | 12 | 12 | Must not include any leading or trailing zeroes. |
creditor.account.accountCurrency |
The creditor's account currency. | 3 | 3 | Must be CA or USD . |
creditor.account.companyId |
The creditor's company ID. | 9 | 9 | Must be seven digits followed by CA . |
creditor.name |
The creditor's name. | 1 | 140 | Only the first 30 characters are sent to clearing. |
creditorAgent.financialInstitutionIds[].id |
The creditor agent's financial instution ID. | 8 | 8 | Must be CHASCATT . |
creditorAgent.financialInstitutionIds[].idType |
The creditor agent's financial instution ID type. |
3 | 3 | Must be BIC . |
creditorAgent.postalAddress.country |
The creditor agent's country. | 2 | 2 | Must be CA . |
United States
The following table contains the required payment parameters to initiate an ACH debit payment in the United States:
Field |
Description |
Minimum |
Maximum |
Notes |
---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
|
|
The payment's unique end-to-end ID that's assigned by the originator. |
1 |
15 |
|
|
The value’s currency. |
3 |
3 |
Must be |
|
The value’s amount. |
1 |
11 |
Must be less than or equal to 1000000 for same-business-day payments, or 99999999.99 for next- and second-business-day payments. |
|
The transfer type. |
6 |
6 |
Must be |
|
The payment type. |
3 |
3 |
Must be |
|
The payment’s service-level code. |
4 |
4 |
Must be |
|
The payment’s local instrument code. |
3 |
3 |
|
|
The debtor’s account number. |
1 |
|
|
debtor.account.accountType |
The debtor's account type. | 4 | 4 |
|
|
The debtor’s account currency. |
3 |
3 |
Must be |
|
The debtor’s name. |
1 |
|
|
debtor.postalAddress.addressLines |
The debtor's unstructured address. | 1 | 35 |
|
debtor.postalAddress.buildingNumber |
The debtor's building number. | 1 | 35 |
|
|
The debtor’s street name. |
1 |
35 |
|
|
The debtor’s city. |
1 |
35 |
|
|
The debtor’s postal code. |
1 |
33 |
|
|
The debtor’s country subdivision. |
1 |
35 |
|
|
The debtor’s country. |
2 |
2 |
Only the first 35 characters of the combined postal and country codes are sent to clearing. |
|
The debtor agent’s financial institution ID. |
9 |
9 |
|
|
The debtor agent’s financial institution ID type. |
5 |
6 |
Must be |
|
The debtor agent’s country. |
2 |
2 |
Must be a two-letter country code. |
|
The creditor’s account number. |
17 |
35 |
|
|
The creditor’s account currency. |
3 |
3 |
Must be |
|
The creditor’s company ID. |
10 |
10 |
Might include leading spaces, leading zeroes, or both. |
|
The creditor’s name. |
1 |
|
|
creditor.postalAddress.addressLines |
The creditor's unstructured address. | 1 | 35 |
|
creditor.postalAddress.buildingNumber |
The creditor's building number. | 1 | 35 |
|
|
The creditor's street name. |
1 |
35 |
|
|
The creditor's city. |
1 |
35 |
|
|
The creditor's postal code. |
1 |
33 |
|
|
The creditor's country subdivision. |
1 |
35 |
|
|
The creditor's country. |
2 |
2 |
|
|
The creditor agent’s name. |
1 |
35 |
Required for IAT. |
|
The creditor agent’s financial institution ID. |
9 |
9 |
|
|
The financial institution ID type. |
5 |
5 |
Must be |
|
The creditor agent’s country. |
2 |
2 |
Must be a two-letter country code. |
additionalParties.ultimateCreditor.name |
The ultimate creditor's name. | 1 |
|
Required if different from creditor's details. |
additionalParties.ultimateCreditor.postalAddress.addressLines |
The ultimate creditor's unstructured address. | 1 | 35 |
|
additionalParties.ultimateCreditor.postalAddress.buildingNumber |
The ultimate creditor's building number. | 1 | 35 |
|
|
The ultimate creditor's street name. |
1 |
35 |
|
|
The ultimate creditor's city. |
1 |
35 |
|
|
The ultimate creditor's postal code. |
1 |
33 |
|
|
The ultimate creditor's country subdivision. |
1 |
35 |
|
|
The ultimate creditor's country. |
2 |
2 |
|
|
The scheme type’s proprietary code. |
1 |
10 |
Must be free form or one of the following:
|
The following table contains an optional payment parameter that's often used to initiate an ACH debit payment in the United States:
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
remittanceInformation.unstructuredInformation.text |
The payment's remittance information. | 1 |
|
Must be in ANSI ASC X12 format. |
Related
- For more information about ACH, see Overview.
- For conditional and optional ACH payment parameters, see the API specification.
Next steps
Learn about the supported values and resources for ACH payment parameters.