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 Zelle® 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 Zelle® payment:

Required payment parameters to initiate a Zelle® payment

Field

Description

Min length

Max length

 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

16

 Must only contain letters and numbers.

value.currency

The value's currency.

.

3

3

Must be USD.

value.amount

The value's amount.

. 

1

18
  • Numeric characters only.
  • Maximum of two decimal places.
  • Must be a value from 0.01 to 100000.

transferType

The transfer type.

6

6

 Must be CREDIT.

paymentType

The payment type.

5

5
Must be ZELLE.

debtor.account.accountNumber

The debtor's account number.

1

35

  

debtor.name

 The debtor's name.

1

50

  

debtorAgent.financialInstitutionIds[].id

 The debtor agent's financial institution ID.

8

8

 Must be CHASUS33.

debtorAgent.financialInstitutionIds[].idType

 The debtor agent's financial institution ID type.

3

3

 Must be BIC.

creditor.account.alternateAccountIdentifiers.identifier

The creditor's alternate account ID.

1

255

 Must be an email address or phone number.
creditor.account.alternateAccountIdentifiers.idType The creditor's alternate account ID type. 10 10  
creditor.account.alternateAccountIdentifiers.proprietarySchemeName

The proxy account type.

 4 4
  • Required when  account.alternateAccountIdentifiers.[].idType is set to PROPRIETARY.
  • Must be EMAL or TELI.

creditor.account.accountType

The creditor's account type.

 5

5

 Must be ZELLE.
creditor.name The creditor's name. 1 101  

Conditional

The following table contains a conditional payment parameter to initiate a Zelle® payment:

Conditional payment parameters to initiate a Zelle® payment

Field

Description

Min length

Max length

 Notes

additionalParties.ultimateDebtor.Name

The ultimate debtor's name. 

1

20

 Required for third-party processors (TP3s).

Optional

The following table contains the optional payment parameters to initiate a Zelle® payment:

Optional payment parameters to initiate a Zelle® payment

Field

Description

Min length

Max length

 Notes
creditor.postalAddress.type The creditor's post address type. 1 10 Must be ADDR.
creditor.postalAddress.buildingNumber The creditor's building number,. 1 16  
creditor.postalAddress.streetName The creditor's street name. 1 35  
creditor.postalAddress.city The creditor's city. 1 25  
creditor.postaladdress.postalCode The creditor's postal code. 1 9  
creditor.postalAddress.countrySubDivision The creditor's country subdivision. 2 3  
creditor.postalAddress.country The creditor's country. 2 2 Must be a two-letter country code.
paymentPurpose.purpose.code

The payment's purpose code.

 1 6
 
remittanceInformation.unstructuredInformation.text Unstructured information. 1 16  

For more information about Zelle®, see Overview.

Next steps

Learn about the supported values and resources for Zelle® payment parameters.