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. 

Payment parameters

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 for same-currency wire payment types. To ensure a successful request, you must include all required fields. Optional fields offer additional functionality but are not necessary for a successful request.

Tip

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

Requirements by country

This section details the region-specific requirements. Review the information for your region to understand the requirements before coding.

Europe, Middle East, and Africa (EMEA)

Germany wire transfer

Germany wire transfer required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction (for example, value date).    
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current date or a future date.
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the payment initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

15
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency The value’s currency.  3 3 Currency of the payment based on the ISO 4217 Alpha-3 currency code.
value.amount The value’s amount.  0 15

The amount entered is limited to 15 characters, including the decimal point.
transferType

Indicates the direction of the money movement.

The transaction can be either a credit push transfer or a direct debit pull transfer.

     Must be CREDIT.
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.
paymentTypeInformation.serviceLevelCode

Specifies an agreed service level under which the payment should be processed based on a set of pre-defined categories.

  • ServiceLevelCode - Meaning
  • NURG - Non-urgent
  • URGP - Urgent
  • SDVA - Same Day Value
  • URNS - Urgent Payment Net Settlement
  • BKTR - Book
     Must be URGP.
debtor.account.accountNumber This field captures the debtor's account number 1 34 Provide IBAN if not providing debtorAccount.accountNumber
debtor.account.accountCurrency ISO 4217 Alpha-3 currency code 3 3 N/A
debtor.name Party name 1 140 J.P. Morgan overlays with static data from our client files.
debtorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).    

Must be CHASBEBX or CHASBEBXXXX.
debtorAgent.financialInstitutionIds[].idType Debtor agent’s financial institution ID type.      Must be BIC.
debtorAgent.postalAddress.country Country 2 2 Must be 2-character ISO country code corresponding to debtor agent BIC.
creditor.account.accountNumber This field captures a regular account number     Provide IBAN if not providing creditTransferTransactionInformation.creditorAccount.accountNumber
creditor.name Party name 1 70 J.P. Morgan uses the first 70 characters of your data.
creditor.postalAddress.country Country 2 2 J.P. Morgan uses 105 characters for the complete postal address.
creditorAgent.additionalInstitutions[].postalAddress.country Country 2

2

Required when a creditor agent is present in the transaction.

  • debtorAgent
  • country
  • creditorAgent

country must be different, or payment must not be in local currency.

Switzerland wire transfer

Switzerland wire transfer required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction (for example, value date).    
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current date or a future date.
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the payment initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

15
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment based on the ISO 4217 Alpha-3 currency code. 3 3 Currency of the payment based on the ISO 4217 Alpha-3 currency code.
value.amount

A string representation of a (potentially) whole number or decimal positive number.

Amount is more than 0.01 with maximum of two decimal places allowed in most markets.

 0 15

The amount entered is limited to 15 characters, including the decimal point.
transferType

Indicates the direction of the money movement.

The transaction can be either a credit push transfer or a direct debit pull transfer.

     Must be CREDIT.
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.
paymentTypeInformation.serviceLevelCode Specifies an agreed service level under which the payment should be processed based on a set of pre-defined categories.
  • ServiceLevelCode - Meaning
  • NURG - Non Urgent
  • URGP - Urgent
  • SDVA - Same Day Value
  • URNS - Urgent Payment Net Settlement
  • BKTR - Book
     Must be URGP.
debtor.account.accountNumber This field captures the debtor's account number 1 34 Provide IBAN if not providing debtorAccount.accountNumber.
debtor.account.accountCurrency ISO 4217 Alpha-3 currency code 3 3 Valid ISO CCY code
debtor.name Party name 1 140 J.P. Morgan overlays with static data from our client files.
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     Must be CHASCHGX or CHASCHGXXXX.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must be BIC.
debtorAgent.postalAddress.country Country 2 2 Must be 2-character ISO country code corresponding to debtor agent BIC.
creditor.account.accountNumber This field captures a regular account number.     Provide IBAN if not providing creditTransferTransactionInformation.creditorAccount.accountNumber.
creditor.name Party name 1 70 J.P. Morgan uses the first 70 characters of your data.
creditor.postalAddress.country Country 2 2 J.P. Morgan uses 140 characters for the complete postal address.
creditorAgent.additionalInstitutions[].postalAddress.country Country 2 2

Required when a creditor agent is present in the transaction:

  • debtorAgent
  • country
  • creditorAgent
  • country

country must be different, or payment must not be in local currency.

United Kingdom wire transfer

United Kingdom wire transfer required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction (for example, value date).    
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current date or a future date.
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the payment initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

15
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment based on the ISO 4217 Alpha-3 currency code. 3 3 Currency of the payment based on ISO 4217 Alpha-3 currency code.
value.amount

A string representation of a (potentially) whole number or decimal positive number.

Amount is more than 0.01 with maximum of two decimal places allowed in most markets.

 0 15

The amount entered is limited to 15 characters, including the decimal point.
transferType

Indicates the direction of the money movement.

The transaction is either a credit push transfer or a direct debit pull transfer.

     Must be CREDIT.
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.
paymentTypeInformation.serviceLevelCode Specifies an agreed service level under which the payment should be processed based on a set of pre-defined categories.
  • ServiceLevelCode - Meaning
  • NURG - Non-urgent
  • URGP - Urgent
  • SDVA - Same Day Value
  • URNS - Urgent Payment Net Settlement
  • BKTR - Book
     Must be URGP.
debtor.account.accountNumber This field captures the debtor's account number 1 34 Provide IBAN if not providing debtorAccount.accountNumber. Use for physical account or virtual account, depending on your customer profile.
debtor.account.accountCurrency ISO 4217 Alpha-3 currency code 3 3 Valid ISO CCY code
debtor.name Party name 1 140 J.P. Morgan overlays with static data from our client files.
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).    

Must be one of CHASGB2L, CHASGB2LXXX.

Note: codes CHASLULX, CHASLULXXXX, CHASDEFX, CHASDEFXXXX, CHASIE4L, CHASIE4LXXX will be active April 1, 2019.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must be BIC.
debtorAgent.postalAddress.country Country 2 2 Must be 2-character ISO country code corresponding to debtor agent BIC.
creditor.account.accountNumber This field captures a regular account number     Provide IBAN if not providing creditTransferTransactionInformation.creditorAccount.accountNumber.
creditor.name Party name 1 70 J.P. Morgan uses the first 70 characters of your data.
creditor.postalAddress.country Country 2 2 J.P. Morgan uses 140 characters for the complete postal address.
creditorAgent.additionalInstitutions[].postalAddress.country Country 2 2

Required when a creditor agent is present in the transaction:

  • debtorAgent
  • country
  • creditorAgent
  • country

country must be different, or payment must not be in local currency.

North America (NA)

Canada wire transfer

Canada wire transfer required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction (for example, value date).    
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current date or a future date.
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the payment initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

15
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on the ISO 4217 Alpha-3 currency code. 3 3 Currency of the payment based on the ISO 4217 Alpha-3 currency code. Must be CAD.
value.amount A string representation of a (potentially) whole number or decimal positive number.

Amount is more than 0.01 with maximum of two decimal places allowed in most markets.

 0 15

The amount entered is limited to 15 characters, including the decimal point.
transferType Indicates the direction of the money movement. The transaction is either a credit push transfer or a direct debit pull transfer.     Must be CREDIT.
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.
paymentTypeInformation.serviceLevelCode

Specifies an agreed service level under which the payment should be processed based on a set of pre-defined categories.

  • ServiceLevelCode - Meaning
  • NURG - Non-urgent
  • URGP - Urgent
  • SDVA - Same Day Value
  • URNS - Urgent Payment Net Settlement
  • BKTR - Book
    

Use URGP.

BKTR must be used for book transfer wires.
debtor.account.accountNumber Debtor's account number 1 34  
debtor.account.accountCurrency ISO 4217 Alpha-3 currency code 3 3 Valid ISO CCY code
debtor.name Party name 1 140 J.P. Morgan overlays with static data from our client files.
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     Accepted values include: CHASCATT or CHASCATTXXX.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must be BIC.
debtorAgent.postalAddress.country Country 2 2 Must be 2-character ISO country code corresponding to debtor agent BIC. Must be BR.
creditor.account.accountNumber This field captures a regular account number 1 16 Provide creditTransferTransactionInformation.creditorAccount.accountNumber if not providing IBAN. Up to 16 digit account number. May optionally include any check digits, separators (hyphens, blanks, slashes; no need to insert leading zeros).
creditor.name Party name 1 70 J.P. Morgan uses the first 70 characters of your data.
creditor.postalAddress.country Country 2 2 J.P. Morgan uses 140 characters for the complete postal address.
creditor.postalAddress.addressLines Unstructured addresses 1 70

For regulatory reasons. J.P. Morgan recommends that the beneficiary party fields always includes an account ID, full name and address regardless of the beneficiary party’s country of domicile. Complete information is defined as having the following fields completed for the beneficiary party.

  • Account identifier (for example, account number or other identifier such as passport number, SSN, or government ID number)
  • Full name
  • Up to two lines of physical address (avoid P.O. Box numbers if possible)
  • City, state/province, country, postal code

J.P. Morgan uses 140 characters for the complete postal address. 
creditor.postalAddress.buildingNumber Building number 1 16

For regulatory reasons. J.P. Morgan recommends that the beneficiary party fields always includes an account ID, full name and address regardless of the beneficiary party’s country of domicile. Complete information is defined as having the following fields completed for the beneficiary party.

  • Account identifier (for example, account number or other identifier such as passport number, SSN, or government ID number)
  • Full name
  • Up to two lines of physical address (avoid P.O. Box numbers if possible)
  • City, state/province, country, postal code

J.P. Morgan uses 140 characters for the complete postal address.  
creditor.postalAddress.streetName Street name 1 70

For regulatory reasons. J.P. Morgan recommends that the beneficiary party fields always includes an account ID, full name and address regardless of the beneficiary party’s country of domicile. Complete information is defined as having the following fields completed for the beneficiary party.

  • Account Identifier (for example, account number or other identifier such as passport number, SSN, or government ID number)
  • Full name
  • Up to two lines of physical address (avoid P.O. Box numbers if possible)
  • City, state/province, country, postal code

J.P. Morgan uses 140 characters for the complete postal address.  
creditor.postalAddress.city City 1 35

For regulatory reasons. J.P. Morgan recommends that the beneficiary party fields always includes an account ID, full name and address regardless of the beneficiary party’s country of domicile. Complete information is defined as having the following fields completed for the beneficiary party.

  • Account identifier (for example, account number or other identifier such as passport number, SSN, or government ID number)
  • Full name
  • Up to two lines of physical address (avoid P.O. Box numbers if possible)
  • City, state/province, country, postal code

J.P. Morgan uses 140 characters for the complete postal address.  
creditor.postaladress.postalCode Postal code 1 16

For regulatory reasons. J.P. Morgan recommends that the beneficiary party fields always includes an account ID, full name and address regardless of the beneficiary party’s country of domicile. Complete information is defined as having the following fields completed for the beneficiary party.

  • Account identifier (for example, account number or other identifier such as passport number, SSN, or government ID number)
  • Full name
  • Up to two lines of physical address (avoid P.O. Box numbers if possible)
  • City, state/province, country, postal code

J.P. Morgan uses 140 characters for the complete postal address.  
creditor.postalAddress.countrySubDivision Country subdivision code 1 35

For regulatory reasons. J.P. Morgan recommends that the beneficiary party fields always includes an account ID, full name and address regardless of the beneficiary party’s country of domicile. Complete information is defined as having the following fields completed for the beneficiary party.

  • Account identifier (for example, account number or other identifier such as passport number, SSN, or government ID number)
  • Full name
  • Up to two lines of physical address (avoid P.O. Box numbers if possible)
  • City, state/province, country, postal code

J.P. Morgan uses 140 characters for the complete postal address.  
creditor.postalAddress.country Country 2 2 J.P. Morgan uses 140 characters for the complete postal address. 
creditorAgent.name Party name 1 140  
creditorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID). 1 35 Must be a valid local bank code. BIC and memberId are both required.
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Mandatory if previous field is used. Use BIC or clearing_system_ID.
creditorAgent.additionalInstitutions[].postalAddress.country Country 2 2 J.P. Morgan uses 140 characters for the complete postal address. 
additionalParties.intermediaryAgents[].postalAddress.country Country 2 2

Required when an intermediary agent is present in the transaction. J.P. Morgan uses 105 characters for the complete postal address. Refer to the postal addressing worksheet for formatting options.

As a value added service (outside of CGI) to increase straight through processing rates, we recommend supplying as much information as possible. J.P. Morgan uses 70 characters for the complete postal address or 104 characters if BIC is not provided. Refer to the postal addressing worksheet for formatting options.

United States (customer transfer)

United States customer transfer required fields
Field Description Minimum Maximum Notes  
requestedExecutionDate Requested execution date of the payment instruction (for example., value date).    
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current date or a future date.
  
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the payment initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

35
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
  
value.currency Currency of the payment based on the ISO 4217 Alpha-3 currency code. 3 3 Currency of the payment based on the ISO 4217 Alpha-3 currency code.  
value.amount

A string representation of a (potentially) whole number or decimal positive number.

Amount is more than 0.01 with maximum of two decimal places allowed in most markets.

 0 15

The amount entered is limited to 15 characters, including the decimal point.

  
transferType

Indicates the direction of the money movement.

The transaction is either a credit push transfer or a direct debit pull transfer.

     Must be CREDIT.  
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.  
paymentTypeInformation.paymentContext Specifies the context of the payment flow. Wires-secific payment context:
  • FI - Financial Instition initiated flow
  • CUSTOMER - Customer Initated flow
     Must be set to CUSTOMER.  
debtor.account.accountNumber This field captures the debtor's account number.     Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.  
debtor.name   1 14 Mandatory for ACH payments: Chile & US  
debtorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.  
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     BIC or USABA  
creditorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).        
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     Mandatory if previous field is used.  
additionalParties.instructedAgent.id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     CHASUS33XXX  
additionalParties.instructedAgent.idType Type of identifier.     N/A  
settlementInformation.settlementAmount.accountNumber Settlement account number. 1 34 Use this field to distinguish PACS.008 from PAIN.001.  

United States (financial institution transfer)

United States financial institution transfer required fields
Field Description Minimum Maximum Notes  
requestedExecutionDate Requested execution date of the payment instruction (for example, value date).    
  • Must be formatted as YYYY-MM-DD.
  • Must be either the current date or a future date.
  
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the Payment Initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

35
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
  
value.currency Currency of the payment based on the ISO 4217 Alpha-3 currency code. 3 3 Currency of the payment based on the ISO 4217 Alpha-3 currency code.  
value.amount

A string representation of a (potentially) whole number or decimal positive number.

Amount is more than 0.01 with maximum of two decimal places allowed in most markets.

 0 15

The amount entered is limited to 15 characters, including the decimal point.

  
transferType

Indicates the direction of the money movement.

The transaction is either a credit push transfer or a direct debit pull transfer.

     Must be CREDIT.  
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.  
debtorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.  
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     BIC or USABA  
creditorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"  
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     Mandatory if previous field is used. Use BIC.  

United States (corporate intiated payment)

United States corporate initiated payment required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction (for example, value date).    
  • Must be formatted as YYYY-MM-DD.
  • Must be either the current date or a future date.
paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the Payment Initiation request.

This identification remains unchanged as it is passed along the entire end-to-end chain.

 1

35
  • Must be unique for each transaction within the file. No special characters allowed.
  • Industry best practice recommendation is to limit the size of your end-to-end payment reference to 16 characters (15-characters if you do NACHA payments).
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment based on the ISO 4217 Alpha-3 currency code. 3 3 Currency of the payment based on the ISO 4217 Alpha-3 currency code.
value.amount

A string representation of a (potentially) whole number or decimal positive number.

Amount is more than 0.01 with maximum of two decimal places allowed in most markets.

 0 15

The amount entered is limited to 15 characters, including the decimal point.
transferType

Indicates the direction of the money movement.

The transaction is either a credit push transfer or a direct debit pull transfer.

     Must be CREDIT.
paymentType Type of payment being initiated. Use WIRE for wire payments.     Must be WIRE.
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).     CHASUS33XXX
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     Use BIC.
creditorAgent.financialInstitutionIds[].id Financial institution identifier (for example, BIC, USABA, CLEARING_SYSTEM_ID).      
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     Mandatory if previous field is used.

For conditional and optional payment parameters for same currency wire payments, see the API specification.

Next steps