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 (credit)

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 credit 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 credit 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 credit payment in the EMEA region. 

Single Euro Payments Area (SEPA)

The following table contains the required payment parameters to initiate an ACH credit payment in SEPA: 

Required payment parameters to initiate an ACH credit 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 CREDIT

paymentType

The payment type. 

Must be ACH

paymentTypeInformation.serviceLevelCode

The payment’s service level code. 

Must be SEPA

debtor.account.accountNumber

The debtor’s account number. 

debtor.name

The debtor’s name. 

140 

debtor.postalAddress.country

The debtor’s country. 

Must be a two-letter country code.

debtor.partyId.organizationIds[].organizationId

The J.P. Morgan company ID. 

creditor.account.accountNumber

The creditor’s account number. 

creditor.name

The creditor’s name. 

140 

United Kingdom

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

Required payment parameters to initiate an ACH credit 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 your 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 CREDIT

paymentType

The payment type. 

Must be ACH

paymentTypeInformation.serviceLevelCode

The payment’s service-level code. 

Must be NURG for BACS and BACS to roll number. 

debtor.name

The debtor’s name. 

140 

Required for well-formed XML, but not used by J.P. Morgan. 

debtor.postalAddress.country

The debtor’s country. 

Required by payment processor, but not used by J.P. Morgan. 

debtor.partyId.organizationIds[].organizationId

The debtor’s formally issued organization ID. 

35 

  • Must be J.P. Morgan’s company ID.  
  • debtor.organizationId.others.schemeName.proprietary must be set to JPMCOID

debtorAgent.postalAddress.country

The debtor agent’s country. 

Must be GB

creditor.name The creditor's name. 1 35 J.P. Morgan uses the first 35 characters.

creditor.postalAddress.country

The creditor’s country. 

Must be a two-letter country code.

creditorAgent.financialInstitutionIds[].id

The creditor agent’s financial institution ID. 

Must be six-digit UK sort code. 

creditorAgent.financialInstitutionIds[].idType The creditor agent's financial institution ID type. 3 18
  • Required if creditorAgent.financialInstitutionIds[].id is provided.
  • Must be BIC, USABA, SORT_CODE, or CLEARING_SYSTEM_ID.

creditorAgent.additionalInstitutions[].postalAddress.country

The creditor agent’s country. 

Must be GB

Latin America (LATAM)

This section contains the required payment parameters to initiate an ACH credit payment in the LATAM region. 

Chile

The following table contains the required payment parameters to initiate an ACH credit payment in Chile: 

Required payment parameters to initiate an ACH credit payment in Chile

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 your payment. 

value.currency

The value’s currency. 

Must be CLP

value.amount

The value’s amount. 

10 

Must be less than or equal to 9999999999.

transferType

The transfer type. 

Must be CREDIT

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. 

17 

debtor.account.accountCurrency

The debtor’s account currency. 

For supported values, see Currency codes.

debtor.name

The debtor’s name. 

140 

debtorAgent.financialInstitutionIds[].id The debtor agent's financial institution ID.   35  
debtorAgent.financialInstitutionIds[].idType  The debtor agent's financial instiution ID type. 3 18
  • Required if debtorAgent.financialInstitutionIds[].id is provided.
  • Must be BIC, USABA, SORT_CODE, or CLEARING_SYSTEM_ID.

creditor.account.accountNumber

The creditor’s account number. 

17 

creditor.account.accountType

The creditor’s account type. 

Must be SVGS, CACC, or OTHER

creditor.account.accountCurrency

The creditor’s account currency. 

For supported values, see Currency codes.

creditor.name

The creditor’s name. 

70 

paymentPurpose.purpose.code

The payment’s purpose code. 

10 

10 

For supported values, see Purpose codes

paymentPurpose.purpose.type

The payment’s purpose type. 

35 

taxInformation.creditorTaxInformation.taxId

The creditor’s tax ID. 

35 

taxInformation.creditorTaxInformation.taxPayerCategory

The creditor’s taxpayer category. 

15 

taxInformation.debtorTaxInformation.taxId

The debtor’s tax ID. 

35 

taxInformation.debtorTaxInformation.taxPayerCategory

The debtor’s taxpayer category. 

15 

North America (NA)

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

Canada

The following table contains the required payment parameters to initiate an ACH credit payment in Canada: 

Required payment parameters to initiate an ACH credit 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 CREDIT

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 not contain leading or trailing zeroes. 

debtor.account.accountCurrency The debtor's account currency. 3 3 Must be CAD or USD.
debtor.account.companyId The debtor's company ID. 9 9 Must be seven digits followed by CA.

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.  8 8 Must be CHASCATT.  
debtorAgent.financialInstitutionIds[].idType The debtor agent's financial institution ID type. 3 3 Must be BIC.  
debtorAgent.postalAddress.country The debtor agent's country. 2 2 Must be CA.
creditor.account.accountNumber The creditor's account number. 12 12

Must not contain leading or trailing zeroes. 

creditor.name The creditor's name. 1 140

Only the first 30 characters are sent to clearing. 

creditorAgent.financialInstitutionIds[].id The creditor's 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.
creditorAgent.financialInstitutionIds[].idType
The creditor agent's financial institution ID type. 14 14 Must be ROUTING_NUMBER.
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 credit payment in the United States: 

Required payment parameters to initiate an ACH credit 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. 
  • The decimal counts as a character.

transferType

The transfer type. 

Must be CREDIT

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 CCDCIEPPD, or WEB.
  • 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.companyId

The debtor’s company ID. 

10 

10 

Might include leading spaces, leading zeroes, or both. 

debtor.name

The debtor’s name. 

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

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

debtorAgent.name

The debtor agent’s name. 

35 

Required for IAT. 

debtorAgent.financialInstitutionIds[].id

The debtor agent’s financial institution ID. 

  • Must be a J.P. Morgan ABA number.
  • Might contain leading zeroes.
  • For example: 021000021

debtorAgent.financialInstitutionIds[].idType

The debtor agent’s financial institution ID type. 

5

Must be USABA

debtorAgent.postalAddress.country

The debtor agent’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.

creditor.account.accountNumber

The creditor’s account number. 

1

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

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. 

Might contain leading zeroes. 

creditorAgent.financialInstitutionIds[].idType

The creditor agent's financial institution ID type. 

Must be USABA

creditorAgent.postalAddress.country

The creditor agent’s country. 

Must be a two-letter country code.

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

additionalParties.ultimateDebtor.postalAddress.streetName

The ultimate debtor’s street name. 

35 

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

additionalParties.ultimateDebtor.postalAddress.city

The ultimate debtor’s city. 

35 

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

additionalParties.ultimateDebtor.postalAddress.postalCode

The ultimate debtor’s postal code. 

33

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

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

The ultimate debtor’s country subdivision. 

1

35

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

additionalParties.ultimateDebtor.postalAddress.country

The ultimate debtor’s country. 

  • For IAT, if different from debtor'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
  • 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 credit payment in the United States: 

Optional payment parameter to initiate an ACH credit 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