Skip to main content
Note

CBPR+ fields are available in mock responses for select endpoints. Preview supported scenarios in the API specification for Global Payments 2. Learn more in our blog.

Payment parameters

This page provides information about the fields to initiate a Push to Wallet 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 Wallet payment:

Required payment parameters to initiate a Push to Wallet payment
Field

Description

Minimum

Maximum

Notes

  

requestedExecutionDate

The requested execution date.

 10 10
  • Must be formatted as YYYY-MM-DD. 
  • Can be dated from one day in the past to five days in the future based on the current day and Eastern Time zone.
  
paymentIdentifiers.endToEndId

The payment’s unique end-to-end ID that's assigned by the sender.

 1 35    

value.currency

 The value's currency. 3 3 Must be USD.  

value.amount

 The value's amount.  1 8
  • Numeric characters only.
  • Maximum of two decimal points.
  • Must be a value from 0.01 to 60,000.00.
  

transferType

 The transfer type. 6 6 Must be CREDIT.  

paymentType

 The payment type. 5 6 Must be PAYPAL or VENMO.  

debtor.account.accountNumber

The debtor’s account number.  

 1 35 Must not contain leading zeroes.  

debtor.name

 The debtor’s name. 1 140    

debtorAgent.financialInstitutionIds[].id

 The debtor agent's financial institution ID. 8 8 Must be CHASUS33.  

debtorAgent.financialInstitutionIds[].idType

 The debtor’s agent’s ID type. 3 3 Must be BIC.  
creditor.account.alternateAccountIdentifiers.identifier The creditor’s email address or phone number. 1 128    
creditor.account.alternateAccountIdentifiers.idType The alternate account ID's type. 11 11 Must be PROPRIETARY.  
creditor.account.alternateAccountIdentifiers.proprietarySchemeName The creditor’s alternate ID type. 4 4 Must be EMAL or TELI.  
creditor.name The creditor’s name. 1 140 Must not contain any special characters.  
creditor.postalAddress.country The creditor’s country.  2 2 Must be US.  
paymentPurpose.purpose.proprietary Purpose of the payment in proprietary form 5 21 For supported values, see Purpose codes.  
remittanceInformation.unstructuredInformation.text The message that's included in the notification that's sent to the beneficiary. 1 140    

Conditional

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

Conditional payment parameters to initiate a Push to Wallet payment
Field Description Minimum Maximum Notes
additionalParties.ultimateDebtor.organizationIds.organizationId

The ultimate debtor’s organization ID.

 1 35

Required in lieu of additionalParties.ultimateDebtor.individualIds[].individualId for financial institutions with a banking license.
additionalParties.ultimateDebtor.individualIds[].individualId The ultimate debtor's individual ID. 1 35 Required in lieu of additionalParties.ultimateDebtor.organizationIds.organizationId for financial institutions with a banking license.
additionalParties.ultimateDebtor.name

The ultimate debtor’s name.

 1 140 Required for financial institutions with a banking license.

additionalParties.ultimateDebtor.postalAddress.buildingNumber

The ultimate debtor’s building number.

1

16

 Required for financial institutions with a banking license.

additionalParties.ultimateDebtor.postalAddress.streetName

The ultimate debtor’s street name.

1

70

 Required for financial institutions with a banking license.

additionalParties.ultimateDebtor.postalAddress.city

The ultimate debtor’s city.

1

20

 Required for financial institutions with a banking license.

additionalParties.ultimateDebtor.postalAddress.postalCode

The ultimate debtor’s postal code.

1

16

 Required for financial institutions with a banking license.
additionalParties.ultimateDebtor.postalAddress.countrySubDivision The ultimate debtor's two-digit state code. 2 2 Required for financial institutions with a banking license.

additionalParties.ultimateDebtor.postalAddress.country

The ultimate debtor’s country.

2

2

 Required for financial institutions with a banking license.

Optional

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

Optional payment parameters to initiate a Push to Wallet payment

Field

Description

 Minimum Maximum Notes
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.streetName

 The creditor's street name.

1

70

  

creditor.postalAddress.city

 The creditor's city. 1 20  

creditor.postaladdress.postalCode

 The creditor's postal code.

1

16
  • Can include dashes.
  • Shouldn't contain the following:
    [#*&%$@=?{}"|&<>+":;!~`/\()''.]

creditor.postalAddress.countrySubDivision

The creditor's country subdivision.

1

3

  

For more information about Push to Wallet, see Overview.

Next steps

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