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

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 fields to initiate a Push to Card payment. You must include all required fields to initiate a successful payment. The conditional and optional fields provide additional functionality, and aren't required to initiate a successful payment. 

Tip

This page serves as an overview of required, conditional, and optional fields. For detailed JSON specifications when constructing a request, refer to the API specification.

Required

The following table contains the required payment parameters to initiate a Push to Card payment:

Required payment parameters to initiate a Push to Card payment
Field Description Minimum Maximum Notes  
  requestedExecutionDate The requested execution date.

10

10

 Must be the current day based on the Eastern Time zone.
  
  paymentIdentifiers.endToEndId The unique payment ID assigned by the sender.

1

16

 Must only contain letters and numbers.  
  value.currency The currency in which the sender wants to pay.

3

3

Must be CAD or USD.

  
  value.amount The amount of the payment.

1

18
  • Numeric characters only.
  • Maximum of two decimal places.
  • In Canada, the amount can range from 0.01 to 125000.00.
  • In the United States, the amount can range from 0.01 to 50000 for use cases that support money transfer and gaming, or 0.01 to 125000 for disbursement use cases.
  
  transferType The transfer type.

6

6

 Must be CREDIT.  
  paymentType The payment type.

4

4

 Must be CARD.
  
  debtor.account.alternateAccountIdentifiers.identifier The debtor’s Push to Card program ID.

1

19

 Provided during onboarding. For example: P2CCAAP00001  
  debtor.account.alternateAccountIdentifiers.idType The alternate account ID’s type. 10 10 Must be PROGRAM_ID.  
 

debtor.name

 The debtor’s name.

1

30

 Must be the name used as the sender name in the issuer notifications sent to the beneficiary.
  debtorAgent.financialInstitutionIds[].id The debtor agent’s financial institution ID. 8

8
  • In Canada, must be CHASCATT.
  • In the United States, must be CHASUS33.
  
  debtorAgent.financialInstitutionIds[].idType The debtor agent’s financial institution ID type. 3 3 Must be BIC.  
  creditor.account.card.pan The creditor’s primary account number (PAN). 16 19 Must be the card number.  
  creditor.account.card.expiryDate The creditor’s card expiration date. 4 4 Must be formatted as YYMM.  
  creditor.name The creditor's name. 1 30

No special characters allowed, including ‘*/,$@&.

  

Conditional

The following table contains the conditional payment parameters to initiate a Push to Card payment:

Conditional payment parameters to initiate a Push to Card payment
Field Description Minimum Maximum Notes
additionalParties.ultimateDebtor.name The ultimate debtor’s name. 1 20
  • Required for third-party processor (TP3) use case.
  • No special characters, including the following: ‘*/,$@&.
additionalParties.ultimateDebtor.postalAddress.streetName The ultimate debtor's street name. 1 35
  • Required for TP3 use case.
  • No special characters.
additionalParties.ultimateDebtor.postalAddress.city The ultimate debtor's city. 1 25
  • Required for TP3 use case.
  • No special characters. 
additionalParties.ultimateDebtor.postalAddress.postalCode The ultimate debtor's postal code. 1 9
  • Required for TP3 use case.
  • Can include dashes, but not the following: [#*&%$@=?{}"|&<>+":;!~`/\()''.].
additionalParties.ultimateDebtor.postalAddress.countrySubDivision The ultimate debtor's state or province. 2 3
  • Required for TP3 use case.
  • No special characters.
additionalParties.ultimateDebtor.postalAddress.country The ultimate debtor's country. 2 2
  • Required for a TP3 use case.
  • Must be a two-letter country code.

Optional

The following table contains the optional payment parameters to initiate a Push to Card payment:

Optional payment parameters to initiate a Push to Card payment
Field Description Minimum Maximum Notes
remittanceInformation.unstructuredInformation.text Unstructured remittance information for the payment. 1 16 Defaults to the debtorName.
creditor.postalAddress.type The creditor's postal address type. 4 4

Must be one of the following:

  • ADDR for a complete postal address
  • BIZZ for a business address
  • DLVY for a DeliveryTo address
  • HOME for a residential address
  • MLTO for a MailTo address
  • PBOX for a PO box address
creditor.postalAddress.addressLines The creditor's unstructured address. 1 70  

creditor.postalAddress.buildingNumber

 The creditor's building number. 1 16 No special characters.
creditor.postalAddress.streetName The creditor's street name. 1 70

No special characters.
creditor.postalAddress.city The creditor's city. 1 25

No special characters. 
creditor.postalAddress.postalCode The creditor's postal code. 1 16

Can include dashes, but not [#*&%$@=?{}"|&<>+":;!~`/\()''.].
creditor.postalAddress.countrySubDivision The creditor's state or province. 2 3

No special characters.
creditor.postalAddress.country The creditor's country. 2 2 Must be a two-letter country code.
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate The ultimate debtor's date of birth. 10 10 Must be formatted as YYYY-MM-DD.
additionalParties.ultimateDebtor.postalAddress.type
 The ultimate debtor's postal address type. 4 4

Must be one of the following:

  • ADDR for a complete postal address
  • BIZZ for a business address
  • DLVY for a DeliveryTo address
  • HOME for a residential address
  • MLTO for a MailTo address
  • PBOX for a PO box address
additionalParties.ultimateDebtor.postalAddress.addressLines The ultimate debtor's unstructured address. 0 70  
additionalParties.ultimateDebtor.postalAddress.buildingNumber The ultimate debtor's building number. 1 16  
paymentPurpose.purpose.code The payment's purpose code. 6 6 For supported values, see Purpose codes.
taxInformation.debtorTaxInformation.taxId The sender’s Value-Added-Tax (VAT) registration number or single business reference number (SBSRN).  1 20 May be needed for reporting or other regulatory reasons.

For more information about Push to Card, see Overview. 

Next steps

Learn about the supported values and resources for Push to Card payment parameters.