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 required fields for Kinexys Digital Payments payment requests. You must include all required fields for a successful request. Optional fields provide additional functionality and are not required to create a successful request.

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 fields

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

Required fields for Kinexys Digital Payments payment initiation.
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction (e.g. value date) in yyyy-mm-dd format, must be either the current or future date. N/A N/A
  • Field is expected to match ISO date format (YYYY-MM-DD)
  • Kinexys Digital Payments supports:
    • Current dated transactions
    • Future dated transactions (until the next business day or the payment will be rejected)
    • Backdated transactions (the payment will be processed with the current booking date)
paymentIdentifiers.endToEndId Customer-assigned unique identifier to unambiguously identify the Payment Initiation request. This identification is passed on, unchanged, throughout the entire end-to-end chain. 16 16
  • Field is expected to have maximum of 16 characters.
  • If invalid or missing EndtoEnd ID provided, Kinexys Digital Payments will send an error code.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Field is expected to have 3- character ISO currency code.
  • Must be USD. USD is the only supported value.
value.amount

A String representation of a (potentially) whole number or decimal positive number. - Amount should be more than 0.01 with maximum of two decimal places allowed in most markets.

 1 18
  • Field is expected to have maximum of 18 characters.
  • Field is expected to have no more than 2 decimal places.
  • Field is expected to be above 0.00
transferType Indicates the direction of the money movement. The transaction is either a credit push transfer or a direct debit pull transfer. N/A N/A Use CREDIT for Kinexys Digital Payments
paymentType The type of payment being initiated.  N/A N/A Use BLOCKCHAIN for payments via Kinexys Digital Payments 
debtor.account.accountNumber This field captures the debtor's account number. 8 10
  • For BDA accounts it will be the BDA account number, For DDA accounts it will be DDA account number.
  • Field is expected to have maximum of 10 numeric characters.
debtor.account.accountType This field captures the debtor's account type. 8 10
  • Field is mandatory.
  • Allowed values: DDA - DDA account; BDA - Blockchain Deposit Account
  • The Debtor or Credit Account type should have at least BDA as allowed value in one of the fields.
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier. i.e BIC, USABA, CLEARING_SYSTEM_ID 8 8
  • Field is mandatory.
  • Field only supports BIC values.
  • SWIFT BIC allowed values - 8 characters: (Valid SWIFT BIC-only allow [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
  • Blockchain deposit account - allowed value is 8 characters:
    • NY (314) - CHASUS33
  • For DDA accounts, this will be BIC of the DDA Branch Account. DDA - allowed value is 8 characters.
    • Luxemburg (655) – CHASLULX
    • London (671) - CHASGB2L
    • Frankfurt (616) – CHASDEFX
    • Singapore (883) – CHASSGSG
    • Hong Kong (613) – CHASHKHH
    • Amsterdam - CHASNL2X
    • Dublin- CHASIE4L
    • Sydney - CHASAU2X
    • NY (802) - CHASUS33
debtorAgent.financialInstitutionIds[].idType  The type of financial institution identifier.   3 Value must be "BIC".
creditor.account.accountNumber This field captures a regular account number. 8 10
  • For BDA accounts it will be the BDA account number, For DDA accounts it will be DDA account number.
  • Field is expected to have maximum of 10 numeric characters.
creditor.account.accountType This field captures the creditor's account type. 8 11
  • Field is mandatory.
  • Allowed values (DDA, BDA)
    • DDA - DDA account
    • BDA- Blockchain Deposit Account
  • The Debtor or Credit Account type should have at least BDA as an allowed value in one of the fields.
creditorAgent.financialInstitutionIds[].id Financial Institution Identifier, i.e., BIC, USABA, CLEARING_SYSTEM_ID 8 8
  • Field is mandatory.
  • Field only supports BIC values.
  • SWIFT BIC allowed values - 8 characters: (Valid SWIFT BIC-only allow [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
  • Blockchain deposit account - allowed value is 8 characters:
    • NY (314) - CHASUS33
  • For DDA accounts, this will be BIC of the DDA Branch Account. DDA - allowed value is 8 characters.
    • Luxemburg (655) – CHASLULX
    • London (671) - CHASGB2L
    • Frankfurt (616) – CHASDEFX
    • Singapore (883) – CHASSGSG
    • Hong Kong (613) – CHASHKHH
    • Amsterdam - CHASNL2X
    • Dublin- CHASIE4L
    • Sydney - CHASAU2X
    • NY (802) - CHASUS33
creditorAgent.financialInstitutionIds[].idType  The type of financial institution identifier.   3 Value must be "BIC".

Optional fields

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

Optional fields for Kinexys Digital Payments payment initiation
Field Description Minimum Maximum Notes
remittanceInformation.unstructuredInformation.text Unstructured information 1 140
  • Field is expected to have maximum of 140 characters
  • Number of fields is expected to be 1 or less

Next Steps