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 outlines the required fields for Kinexys Digital Payments requests. To ensure a successful request, you must include all required fields. Optional fields offer additional functionality but are not necessary for creating a successful request.

Tip

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

The following table lists required JSON fields for all Kinexys Digital Payments.

Kinexys Digital Payments payment parameters
JSON field name	Description
`payments.requestedExecutionDate`	The requested date the transaction is executed using ISO Date format (YYYY-MM-DD).
`payments.paymentIdentifiers.endToEndId`	The customer-assigned reference to the transaction. The maximum length supported is based on the instrument and market. See the API specification for more information.
`payments.paymentCurrency`	For Kinexys Digital Payments, only the 3-character ISO currency codes USD and EUR are supported.
`payments.paymentAmount`	The payment amount. The minimum amount is 0.01 with a maximum of two decimal places allowed. For details on the maximum amount permitted per market or instrument, see the payment limits.
`payments.paymentType`	The instrument type. Use “BLOCKCHAIN” for Kinexys Digital Payments.
`payments.debtor.debtorAccount.accountId`	The debtor’s DDA or BDA account ID.
`payments.debtor.debtorAccount.accountType`	The debtor account type (“DDA” or “BDA”).
`payments.debtorAgent.financialInstitutionId.bic`	The financial institution identifier of the debtor. Supported values for this field are located in the next table.
`payments.creditor.creditorAccount.accountId`	The creditor’s DDA or BDA account ID.
`payments.creditor.creditorAccount.account`	The creditor account type (“DDA” or “BDA”).
`payments.creditorAgent.financialInstitutionId.bic`	Enter the financial institution identifier of the creditor. Valid values for the field are located within the API specification.
`payments.transferType`	Indicate the transaction as a credit transfer or a direct debit transfer. This indicator also determines who the originator and receiver are based on the debit and credit side of this transaction. For Kinexys Digital Payments, use “CREDIT”.

Next Steps

Review Kinexys Digital Payments Resources.
Learn how to initiate a Kinexys Digital Payments deposit.