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 topic details the fields necessary to initiate a Push to Wallet payment. It includes mandatory fields, conditionally required fields for specific use cases, and optional fields that enhance functionality.

Tip

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

Required fields

Required fields for Push to Wallet payment initiation
Field name	Description	Minimum	Maximum
`payments.requestedExecutionDate`	The transaction execution date must be in ISO date format (YYYY-MM-DD). This date can be set up to five calendar days in the future from the current day, based on the Eastern Standard Time (EST) zone.	10	10
`payments.paymentIdentifiers.endToEndId`	The unique payment identifier assigned by the client.	1	35
`payments.paymentCurrency`	Must always be `USD`.	3	3
`payments.paymentAmount`	The payment amount using numeric characters only, without a currency symbol. The amount must be at least 0.01 and can have up to two decimal places. The maximum allowable payment amount is 60,000.00.	1	18
`payments.transferType`	Value must be `CREDIT`.	6	6
`payments.debtor.debtorName`	J.P. Morgan client name.	1	140
`payments.debtor.debtorAccount.accountID`	Client account number with J.P. Morgan. No leading zeros.	1	35
`payments.debtorAgent.financialInstitutionId.bic`	The financial institution identifier of sender. Always send `CHASUS33`.	8	8
`payments.creditor.creditorName`	The name of the recipient. No special characters are allowed.	1	140
`payments.creditor.postalAddress.country`	Beneficiary’s country. Must always be `US`.	2	2
`payments.creditor.creditorAccount.accountType`	Wallet Type – `PAYPAL` or `VENMO`.	1	10
`payments.creditor.creditorAccount.alternateAccountIdentifier`	Email or mobile phone number of recipient.	1	127
`payments.creditor.creditorAccount.schemeName.proprietary`	Type of alias: `EMAL` or `TELI`.	1	4
`payments.remittanceInformation.unstructuredInformation`	Message included in notification to recipient.	1	140
`payments.purpose.code`	Underlying reason for payment. Must be upper case. See acceptable values here: Purpose Codes.	1	35
`payments.purpose.type`	Value must be `PROPRIETARY`.	1	11

Conditional fields - TP3/MSB/OBO

The following fields are required only when a Push to Wallet is made by a third-party payment provider (TP3), money service business (MSB), or on behalf of (OBO).

TP3/MSB/OBO fields for Push to Wallet
JSON field name	Description	Min	Max
`payments.debtor.ultimateDebtor.ultimateDebtorName`	Name of the ultimate sender.	1	140
`payments.debtor.ultimateDebtor.postalAddress.streetName`	Street name of the ultimate sender's address.	1	70
`payments.debtor.ultimateDebtor.postalAddress.buildingNumber`	Building number of the ultimate sender's address.	1	16
`payments.debtor.ultimateDebtor.postalAddress.postalCode`	ZIP or postal code of the ultimate sender's address.	1	16
`payments. debtor.ultimateDebtor.postalAddress.townName`	City or town of the ultimate sender's address.	1	40
`payments.debtor.ultimateDebtor.organizationId.id`	Unique identifier assigned to the ultimate sender, by the sender.	1	35
`payments.debtor.ultimateDebtor.postalAddress.countrySubDvsn`	Two-letter state code.	2	2
`payments.debtor.ultimateDebtor.postalAddress.country`	ISO 2-digit standard country code of ultimate sender. Must be `US`.	2	2

Optional fields

The following fields are optional for Push to Wallet.

Optional fields for Push to Wallet.
JSON field name	Description	Min	Max
`payments.creditor.postalAddress.addressType`	Accepted values are: `ADDR` - Complete Postal Address `BIZZ` - Business Address `DLVY` - DeliveryTo Address `HOME` - Residential Address `MLTO` - MailTo Address `PBOX` - PO Box Address	4	4
`payments.creditor.postalAddress.streetName`	Street name for the creditor's address.	1	70
`payments.creditor.postalAddress.postalCode`	U.S. ZIP Code. Can contain dashes. Must not include the following characters: [#*&%$@=?{}"\|&<>+":;!~`/\()''.]	1	16
`payments.creditor.postalAddress.buildingNumber`	Building number for the creditor's address.	1	35
`payments.creditor.postalAddress.townName`	Name of town for creditor's address.	1	35
`payments.creditor.postalAddress.countrySubDvsn`	Country subdivision for the creditor's address.	1	70

Next steps

Review Push to Wallet Resources.