Skip to main content
Beta version

Welcome to the beta version of the Global Payments 2 API! For the generally available Global Payments API, refer to Global Payments

Payment parameters (debit)

Disclaimer

These payment parameters are subject to change as we test the beta release of Global Payments 2 API. 

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.

Tip

This page serves as an overview of required fields. For all available fields, including conditional and optional fields, see the API specification.

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: 

Required payment parameters to initiate an ACH debit payment in SEPA

Field 

Description 

Minimum 

Maximum 

Notes 

requestedExecutionDate

The requested execution date. 

10 

10 

Must be formatted as YYYY-MM-DD. 

paymentIdentifiers.endToEndId

The payment's unique end-to-end ID that's assigned by the originator. 

16 

  • Must only contain letters and numbers.  
  • Must be unique for each transaction in the file. 
  • Recommended 15-character limit due to restrictions across global clearing channels and market infrastructure regarding the length of the ID that can travel with your payment. 

value.currency

The value’s currency. 

Must be EUR

value.amount

The value’s amount. 

12 

  • Must be less than or equal to 999999999.99.
  • The decimal counts as a character. 

transferType

The transfer type. 

Must be DEBIT

paymentType

The payment type. 

Must be ACH

paymentTypeInformation.serviceLevelCode

The payment’s service level code. 

Must be SEPA

debtor.name

The debtor’s name. 

140 

creditor.account.accountCurrency

The creditor’s account currency. 

For supported values, see Currency codes.

creditor.account.companyId

The J.P. Morgan company ID. 

creditor.postalAddress.country

The creditor’s country. 

Must be a two-letter country code.

creditor.partyId.individualIds[].individualId

The creditor’s individual ID. 

creditor.partyId.individualIds[].schemeName.proprietary

The scheme type’s proprietary code. 

Must be SEPA

creditorAgent.financialInstitutionIds[].id

The creditor agent’s financial institution ID. 

mandateInformation.mandateId

The mandate ID. 

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 
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 
0 1 2 3 4 5 6 7 8 9 
/ - ? : ( ) . , ' + 
Space 

mandateInformation.signatureDate

The mandate’s signature date. 

10 

10 

Must be formatted as YYYY-MM-DD. 

mandateInformation.amendmentInformation.originalDebtor.accountNumber

The regular account number. 

[IBAN]  
 
Any proprietary ID type can be given. User must not provide duplicate ID types unless the ID type is OTHERS_ID

United Kingdom

The following table contains the required payment parameters to initiate an ACH debit payment in the United Kingdom: 

Required payment parameters to initiate an ACH debit payment in the United Kingdom

Field 

Description 

Minimum 

Maximum 

Notes 

requestedExecutionDate

The requested execution date. 

10 

10 

Must be formatted as YYYY-MM-DD. 

paymentIdentifiers.endToEndId

The payment's unique end-to-end ID that's assigned by the originator. 

15 

  • Must only contain letters and numbers.  
  • Must be unique for each transaction in the file. 
  • Recommended 15-character limit due to restrictions across global clearing channels and market infrastructure regarding the length of the ID that can travel with a payment. 

value.currency

The value’s currency. 

Must be GBP

value.amount

The value’s amount. 

11 

  • Must be less than or equal to 20000000.00. 
  • The decimal counts as a character. 

transferType

The transfer type. 

Must be DEBIT

paymentType

The payment type. 

Must be ACH

paymentTypeInformation.serviceLevelCode

The payment’s service-level code. 

Must be NURG

paymentTypeInformation.localInstrumentCode.code

The payment’s local instrument code. 

Must be UK01 for initial presentation, UK17 for standard presentation, UK18 for representation, or UK19 for final presentation. 

debtor.account.accountNumber

The debtor’s account number. 

  • If not providing IBAN, must provide directDebitTransactionInformation.debtorAccount.accountNumber.   
  • If less than eight characters, add zeroes until it’s eight characters. 

debtor.account.accountCurrency

The debtor’s account currency. 

3  

For supported values, see Currency codes.

debtor.name

The debtor’s name. 

18 

debtor.postalAddress.country

The debtor’s country. 

Must be GB

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.

debtorAgent.financialInstitutionIds[].idType

The debtor agent's financial institution ID type. 

9

9

Must be sort_code

debtorAgent.postalAddress.country

The debtor agent’s country. 

Must be a two-letter country code.

creditor.account.accountCurrency

The creditor’s account currency. 

For supported values, see Currency codes.

creditor.account.companyId

The J.P. Morgan company ID. 

35 

creditor.name

The creditor’s name. 

70 

J.P. Morgan overlays this data with static data from its client files. 

creditor.postalAddress.country

The creditor’s country. 

Must be a two-letter country code.

creditorAgent.financialInstitutionIds.id

The creditor agent’s financial institution ID. 

11 

Must be CHASGB2L or CHASGB2LXXX

creditorAgent.financialInstitutionIds[].idType The creditor agent's financial instution ID type. 3 3 Must be BIC.

creditoragent.postalAddress.country

The creditor agent’s country. 

Must correspond to debtor agent’s BIC. 

mandateInformation.mandateId

The core reference number. 

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: 

Required payment parameters to initiate an ACH debit payment in Canada

Field 

Description 

Minimum 

Maximum 

Notes 

requestedExecutionDate

The requested execution date. 

10 

10 

Must be formatted as YYYY-MM-DD. 

paymentIdentifiers.endToEndId

The payment's unique end-to-end ID that's assigned by the originator. 

15 

  • Must only contain letters and numbers.  
  • Must be unique for each transaction in the file. 
  • Recommended 15-character limit due to restrictions across global clearing channels and market infrastructure regarding the length of the ID that can travel with a payment. 

value.currency

The value’s currency. 

  • Must be CAD when paying from a J.P. Morgan Toronto CAD debtor account.
  • Must be USD when paying from a J.P. Morgan Toronto USD debtor account. 

value.amount

The value’s amount. 

11 

  • Must be less than or equal to 99999999.99 for CAD and USD payments. 
  • The decimal counts as a character. 

transferType

The transfer type. 

Must be DEBIT

paymentType

The payment type. 

Must be ACH

paymentTypeInformation.serviceLevelCode

The payment’s service-level code. 

Must be NURG

debtor.account.accountNumber The debtor's account number. 12 12
  • Must be the payer's account number.
  • Must not contain leading or trailing zeroes.
debtor.account.accountCurrency The debtor's account currency. 3 3 Must be CAD or USD.

debtor.name

The debtor’s name. 

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: 

Required payment parameters to initiate an ACH debit payment in the United States

Field 

Description 

Minimum 

Maximum 

Notes 

requestedExecutionDate

The requested execution date. 

10 

10 

  • Must be formatted as YYYY-MM-DD. 
  • Can be up to 7 business days or 9 calendar days in the past, or 90 calendar days in the future. 

paymentIdentifiers.endToEndId

The payment's unique end-to-end ID that's assigned by the originator. 

15 

  • Must only contain letters and numbers.  
  • Must be unique for each transaction during the last 60 days. 
  • Recommended 15-character limit due to restrictions across global clearing channels and market infrastructure regarding the length of the ID that can travel with a payment. 

value.currency

The value’s currency. 

Must be USD

value.amount

The value’s amount. 

11 

Must be less than or equal to 1000000 for same-business-day payments, or 99999999.99 for next- and second-business-day payments. 

transferType

The transfer type. 

Must be DEBIT

paymentType

The payment type. 

Must be ACH

paymentTypeInformation.serviceLevelCode

The payment’s service-level code. 

Must be NURG

paymentTypeInformation.localInstrumentCode.code

The payment’s local instrument code. 

  • For day 1, must be CCDPPDWEB, or TEL
  • For International ACH Transactions (IAT), must be IAT

debtor.account.accountNumber

The debtor’s account number. 

  • 17 for non-IAT
  • 35 for IAT 
debtor.account.accountType The debtor's account type. 4 4
  • Can be CACC or SVGS.
  • Defaults to CACC.

debtor.account.accountCurrency

The debtor’s account currency. 

Must be USD

debtor.name

The debtor’s name. 

  • 22 for non-IAT
  • 35 for IAT
debtor.postalAddress.addressLines The debtor's unstructured address. 1 35
  • For IAT, must provide debtor.postalAddress.addressLines for unstructured addresses or debtor.postalAddress.buildingNumber and debtor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the unstructured address are sent to clearing.
debtor.postalAddress.buildingNumber

The debtor's building number. 1 35
  • For IAT, must provide debtor.postalAddress.addressLines for unstructured addresses or debtor.postalAddress.buildingNumber and debtor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the combined building number and street name are sent to clearing.

debtor.postalAddress.streetName

The debtor’s street name. 

35 

  • For IAT, must provide debtor.postalAddress.addressLines for unstructured addresses or debtor.postalAddress.buildingNumber and debtor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the combined building number and street name are sent to clearing.

debtor.postalAddress.city

The debtor’s city. 

35 

  • Required for IAT.
  • Only the first 35 characters of the combined city and country subdivision are sent to clearing.

debtor.postalAddress.postalCode

The debtor’s postal code. 

33

  • Required for IAT. 
  • Only the first 35 characters of the combined postal and country codes are sent to clearing.

debtor.postalAddress.countrySubDivision

The debtor’s country subdivision. 

1

35

  • Required for IAT
  • Only the first 35 characters of the combined city and country subdivision are sent to clearing.

debtor.postalAddress.country

The debtor’s country. 

Only the first 35 characters of the combined postal and country codes are sent to clearing.

debtorAgent.financialInstitutionIds[].id

The debtor agent’s financial institution ID. 

  • Must be a United States ABA number. 
  • Might contain leading zeroes. 
  • For example: 021000021

debtorAgent.financialInstitutionIds[].idType

The debtor agent’s financial institution ID type. 

Must be USABA

debtorAgent.postalAddress.country

The debtor agent’s country. 

Must be a two-letter country code.

creditor.account.accountNumber

The creditor’s account number. 

17 

35 

creditor.account.accountCurrency

The creditor’s account currency. 

Must be USD

creditor.account.companyId

The creditor’s company ID. 

10 

10 

Might include leading spaces, leading zeroes, or both. 

creditor.name

The creditor’s name. 

  • 15 for CIE
  • 22 for non-IAT
  • 35 for IAT
creditor.postalAddress.addressLines The creditor's unstructured address. 1 35
  • For IAT, must provide creditor.postalAddress.addressLines for unstructured addresses or creditor.postalAddress.buildingNumber and creditor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the unstructured address are sent to clearing.
creditor.postalAddress.buildingNumber The creditor's building number. 1 35
  • For IAT, must provide creditor.postalAddress.addressLines for unstructured addresses or creditor.postalAddress.buildingNumber and creditor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the combined building number and street name are sent to clearing.

creditor.postalAddress.streetName

The creditor's street name. 

35 

  • For IAT, must provide creditor.postalAddress.addressLines for unstructured addresses or creditor.postalAddress.buildingNumber and creditor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the combined building number and street name are sent to clearing.

creditor.postalAddress.city

The creditor's city. 

35 

  • Required for IAT.
  • Only the first 35 characters of the combined city and country subdivision are sent to clearing.

creditor.postalAddress.postalCode

The creditor's postal code. 

33

  • Required for IAT. 
  • Only the first 35 characters of the combined postal and country codes are sent to clearing.

creditor.postalAddress.countrySubDivision

The creditor's country subdivision. 

1

35

  • Required for IAT
  • Only the first 35 characters of the combined city and country subdivision are sent to clearing.

creditor.postalAddress.country

The creditor's country. 

  • Must be a two-letter country code.
  • For IAT, only the first 35 characters of the combined postal and country codes are sent to clearing.

creditorAgent.name

The creditor agent’s name. 

35 

Required for IAT. 

creditorAgent.financialInstitutionIds[].id

The creditor agent’s financial institution ID. 

  • Must be a United States ABA number. 
  • Might contain leading zeroes. 
  • For example: 021000021

creditorAgent.financialInstitutionIds[].idType

The financial institution ID type. 

Must be USABA

creditoragent.postalAddress.country

The creditor agent’s country. 

Must be a two-letter country code.

additionalParties.ultimateCreditor.name The ultimate creditor's name. 1
  • 15 for CIE
  • 22 for non-IAT
  • 35 for IAT
Required if different from creditor's details.
additionalParties.ultimateCreditor.postalAddress.addressLines The ultimate creditor's unstructured address. 1 35
  • For IAT, must provide additionalParties.ultimateCreditor.postalAddress.addressLines for unstructured addresses or additionalParties.ultimateCreditor.postalAddress.buildingNumber and additionalParties.ultimateCreditor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the unstructured address are sent to clearing.
additionalParties.ultimateCreditor.postalAddress.buildingNumber The ultimate creditor's building number.  1 35
  • For IAT, must provide additionalParties.ultimateCreditor.postalAddress.addressLines for unstructured addresses or additionalParties.ultimateCreditor.postalAddress.buildingNumber and additionalParties.ultimateCreditor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the combined building number and street name are sent to clearing.

additionalParties.ultimateCreditor.postalAddress.streetName

The ultimate creditor's street name. 

35 

  • For IAT, must provide additionalParties.ultimateCreditor.postalAddress.addressLines for unstructured addresses or additionalParties.ultimateCreditor.postalAddress.buildingNumber and additionalParties.ultimateCreditor.postalAddress.streetName for structured addresses.
  • Only the first 35 characters of the combined building number and street name are sent to clearing.

additionalParties.ultimateCreditor.postalAddress.city

The ultimate creditor's city. 

35 

  • For IAT, required if different from creditor's details.
  • Only the first 35 characters of the combined city and country subdivision are sent to clearing.

additionalParties.ultimateCreditor.postalAddress.postalCode

The ultimate creditor's postal code. 

33

  • For IAT, required if different from creditor's details. 
  • Only the first 35 characters of the combined postal and country codes are sent to clearing.

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

The ultimate creditor's country subdivision. 

1

35

  • For IAT, required if different from creditor's details
  • Only the first 35 characters of the combined city and country subdivision are sent to clearing.

additionalParties.ultimateCreditor.postalAddress.country

The ultimate creditor's country. 

  • For IAT, if different from creditor's details, must be a two-letter country code.
  • Only the first 35 characters of the combined postal and country codes are sent to clearing.

paymentPurpose.categoryPurpose.proprietary

The scheme type’s proprietary code. 

10 

Must be free form or one of the following:

  • ACCTVERIFY for micro entries
  • HCCLAIMPMT for health care claim payments
  • PAYROLL for payroll payments
  • PURCHASE for purchases
  • RECLAIM for reclamations
  • RETRY PMT for redepositing returned debits due to insufficient funds
  • REVERSAL for reversal of incorrectly originated payments

The following table contains an optional payment parameter that's often used to initiate an ACH debit payment in the United States: 

Optional payment parameter to initiate an ACH debit payment in the United States
Field Description Minimum Maximum Notes
remittanceInformation.unstructuredInformation.text The payment's remittance information. 1
  • For CIE, CPD, and non-IAT, 1 line of up to 80 characters
  • For IAT, 2 lines of up to 80 characters each
Must be in ANSI ASC X12 format.
  • 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.