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

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.

North America (NA)

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-specific payment context:
  • FI - Financial Institution initiated flow
  • CUSTOMER - Customer Initiated 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 initiated 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