Beta version available

The Global Payments 2 API is currently available in beta. Contact our team to start your integration process.

Payment parameters

The following tables outline the required fields for making Zelle® Disbursements. You must include all required fields for your request to be successful.

Tip

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

Required fields

Required fields for payment initiation

Required fields for payment initiation
JSON field name	Description	Min length	Max length
`payments.requestedExecutionDate`	The transaction execution date in ISO Date format (YYYY-MM-DD). This value must be the current day, based on the EST time zone.	10	10
`payments.paymentIdentifiers.endToEndId`	The unique payment identifier assigned by the client.	6	16
`payments.paymentCurrency`	The currency in which the client wants to make the payment. This should be USD.	3	3
`payments.paymentAmount`	Enter the payment amount using numeric characters only, without a currency symbol. The amount must be greater than 0.01 and can have up to two decimal places, with a maximum payment limit of 100,000.00.	1	18
`payments.transferType`	All Zelle® disbursements must use `CREDIT`.	6	6
`payments.debtor.debtorName`	The sender name. This value will be used as the sender name in the issuer notifications sent to the recipient.	1	50
`payments.debtor.debtorAccount.accountId`	Debtor’s DDA account number (include leading zeros).	1	35
`payments.debtorAgent.financialInstitutionId.bic`	The financial institution identifier of sender. Must be: `CHASUS33`.	8	8
`payments.creditor.creditorName`	The name of the recipient. No special characters are allowed.	1	101
`payments.creditor.creditorAccount.accountType`	All Zelle® payments must use `ZELLE`.	5	5
`payments.creditor.creditorAccount.alternateAccountIdentifier`	This is the recipient's social alias, which can be either their email address or phone number.	1	255
`payments.creditor.creditorAccount.schemeName.proprietary`	All Zelle® Disbursements must use `EMAL` for email address or `TELI` for telephone number.	4	4

Optional fields

Optional fields
JSON field name	Description	Min length	Max length
`payments.remittanceInformation.unstructuredInformation`	Unstructured remittance information for the payment.	1	200
`payments.creditor.postalAddress.addressType`	This is `ADDR`	1	4
`payments.creditor.postalAddress.streetName`	The street name of the creditor.	1	70
`payments.creditor.postalAddress.buildingNumber`	The building number of the creditor.	1	35
`payments.creditor.postalAddress.postalCode`	The ZIP or postal code of the creditor.	1	16
`payments.creditor.postalAddress.townName`	The city or town of the creditor.	1	35
`payments.creditor.postalAddress.countrySubDvsn`	The state or province of the creditor.	2	3
`payments.creditor.postalAddress.country`	ISO country code. Must be ‘US’.	2	2

Next steps

Review Disbursements with Zelle® resources.