Skip to main content
Beta version

Welcome to the beta version of the Global Payments 2 API. For the generally available Global Payments API, see Global Payments. 

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.

North America (NA)

This section contains the required payment parameters to initiate an ACH debit payment in the NA region. 

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. 

1 

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. 

3 

3 

Must be USD. 

value.amount

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. 

transferType

The transfer type. 

6 

6 

Must be DEBIT. 

paymentType

The payment type. 

3 

3 

Must be ACH. 

paymentTypeInformation.serviceLevelCode

The payment’s service-level code. 

4 

4 

Must be NURG. 

paymentTypeInformation.localInstrumentCode.code

The payment’s local instrument code. 

3 

3 
  • For day 1, must be CCD, PPD, WEB, or TEL. 
  • For International ACH Transactions (IAT), must be IAT. 

debtor.account.accountNumber

The debtor’s account number. 

1 
  • 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. 

3 

3 

Must be USD. 

debtor.name

The debtor’s name. 

1 
  • 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. 

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.city

The debtor’s city. 

1 

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. 

1 

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. 

2 

2 

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. 

9 

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

debtorAgent.financialInstitutionIds[].idType

The debtor agent’s financial institution ID type. 

5 

6 

Must be USABA. 

debtorAgent.postalAddress.country

The debtor agent’s country. 

2 

2 

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. 

3 

3 

Must be USD. 

creditor.account.companyId

The creditor’s company ID. 

10 

10 

May include leading spaces, leading zeroes, or both. 

creditor.name

The creditor’s name. 

1 
  • 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. 

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.city

The creditor's city. 

1 

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. 

1 

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. 

2 

2 
  • 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. 

1 

35 

Required for IAT. 

creditorAgent.financialInstitutionIds[].id

The creditor agent’s financial institution ID. 

9 

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

creditorAgent.financialInstitutionIds[].idType

The financial institution ID type. 

5 

5 

Must be USABA. 

creditoragent.postalAddress.country

The creditor agent’s country. 

2 

2 

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. 

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.city

The ultimate creditor's city. 

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.postalCode

The ultimate creditor's postal code. 

1 

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. 

2 

2 
  • 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. 

1 

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
  • RECCLAIM 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.