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 Real-Time 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 fields. For all available fields including every conditional and optional field, refer to the API specification.

Required fields for all Real-Time Payments

Real-Time Payments requests have different required fields based on their use case, but there are certain fields that are required for ALL Real-Time Payments requests, regardless of region or payment method. The following table describes these fields in more detail.

Required fields for all Real-Time Payments
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date. 1 10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 
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. 0.01 18
  • Field is expected to have no more than two decimal places.
  • Field is expected to be above 0.01
transferType Indicates the direction of the money movement.      Must be Credit.
paymentType

Type of payment being initiated. 

3 3 Must be RTP.
debtor.account.accountNumber This field captures the debtor's account number. 8 35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier of the debtor.   11 Field is expected to have an 8 or 11 BIC or USABA value.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier of the debtor.    

Allowed values are BIC, USABA, SORT_CODE, CLEARING_SYSTEM_ID. Populate the right value based on the financial institution ID provided in the previous field.

Requirements by country

Information in this section provides details for these region specific requirements. Review the information for the region to understand the requirements prior to coding. 

Asia Pacific

Australia (NPP)

Australia (NPP) Pay to Account required fields
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. 1 10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • For AU NPP Tax payment (category payment), populate ATO Payment Reference Number (PRN)
  • For AU NPP Superannuation payment (category payment), populate Payment Reference Number (PRN)
  • For AU NPP e-Invoice payment, populate PaymentID (as definied in the ANZ PEPPOL framework for e-Invoicing)
  • For the rest, populate Customer Ref
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 
  • Fixed value: AUD
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. 0.01 18
  • Field is expected to have no more than two decimal places.
  • Field is expected to be above 0.01
  • Max limit: AUD 100,000
transferType Indicates the direction of the money movement.      Must put Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   8 Field is expected to have an 8 digit BIC value: CHASAU2X
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     This value will be "BIC".
creditor.account.accountNumber This field captures a regular account number.   35 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.name Party name   140 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].id Financial Institution Identifier. i.e Bank Branch State Identifier (BSB code)   11 The Bank Branch State Identifier (BSB Code)
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   18

"CLEARING_SYSTEM_ID"

Australia (NPP) Pay to Proxy required fields
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. 1 10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • For AU NPP Tax payment (category payment), populate ATO Payment Reference Number (PRN)
  • For AU NPP Superannuation payment (category payment), populate Payment Reference Number (PRN)
  • For AU NPP e-Invoice payment, populate PaymentID (as definied in the ANZ PEPPOL framework for e-Invoicing)
  • For the rest, populate Customer Ref
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 
  • Fixed value: AUD
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. 0.01 18
  • Field is expected to have no more than two decimal places.
  • Field is expected to be above 0.01
  • Max limit: AUD 100,000
transferType Indicates the direction of the money movement.      Must put Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC.   8 Field is expected to have an 8 digit BIC value: CHASAU2X.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     This value will be "BIC".
creditor.account.alternateAccountIdentifiers.identifier Alternate account identifier.   256 Required for Pay to Proxy.
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account.   4 Required for Pay to Proxy. Values include:
  • "EMAL" — Email Address
  • "TELI" — Telephone Number
  • "AUBN" — Australia Business number
  • "ORGN" — Organization Id
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account. Mandatory if account.alternateAccountIdentifiers.[x].idType =PROPRIETARY   4

Required for Pay to Proxy. Values include:

  • "EMAL" — Email Address
  • "TELI" — Telephone Number
  • "AUBN" — Australia Business number
  • "ORGN" — Organization Id
creditorAgent.financialInstitutionIds[].id Financial Institution Identifier. i.e Bank Branch State Identifier (BSB code)   11 The Bank Branch State Identifier (BSB Code)
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   18

"CLEARING_SYSTEM_ID"

Australia (NPP) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.organizationIds[].organizationId Formally Issued Organization Identifier  

35

  • Either individualID or organizationID, not both
  • For AU Superannuation payment (category payment), populate with USI number for the Superannuation fund
additionalParties.ultimateCreditor.organizationIds[].schemeName.proprietary Specifies the type of scheme with a proprietary code.   3 "USI"
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
paymentPurpose.purpose.code Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.   4  
paymentPurpose.purpose.type Purpose type   4

"CODE" 

paymentPurpose.categoryPurpose.code Purpose code   4  
paymentPurpose.categoryPurpose.proprietary Specifies the type of scheme with a proprietary code.   4  
remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.

Hong Kong (FPS)

Hong Kong (FPS) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment, based on ISO 4217 Alpha-3 Currency Code.
  • Field is expected to match HKD or CNY expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: HKD / CNY 999,999
transferType Indicates the direction of the money movement.      Must put Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   8 Field is expected to have 8 digit BIC value: "CHASHKHH"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     This value will be "BIC".
creditor.account.accountNumber This field captures a regular account number   35 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.account.accountType The type of account.   

4

  • A required field when using Pay to Account.
  • "BBAN"
creditor.name Party name   140 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].id Financial institution identifier, i.e., 3 digit bank codes.   3 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   18
  • Mandatory for Pay to Account
  • "CLEARING_SYSTEM_ID"
paymentPurpose.categoryPurpose.proprietary Specifies the type of scheme with a proprietary code.   4 Values include:
  • "CXSALA" - Salary and benefits payment
  • "CXBSNS" - General business payment

Refer to Payments Developer Portal for list of purpose/category codes.

Hong Kong (FPS) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment, based on ISO 4217 Alpha-3 Currency Code.
  • Field is expected to match HKD or CNY expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: HKD / CNY 999,999
transferType Indicates the direction of the money movement.      Must put Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   8 Field is expected to have an 8 digit BIC value: "CHASHKHH"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     This value will be "BIC".
creditor.account.alternateAccountIdentifiers.identifier Alternate account identifiers.   34 Required for Pay to Proxy
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account   4

Required for Pay to Proxy

Values include:

  • "EMAL" — Email Address
  • "MOBN" — Mobile Number (or fixed-line number)
  • "SVID" — FPS Identifier
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account. Mandatory if account.alternateAccountIdentifiers.[x].idType =PROPRIETARY   4

Required for Pay to Proxy

Values include:

  • "EMAL" — Email Address
  • "MOBN" — Mobile Number (or fixed-line number)
  • "SVID" — FPS Identifier
paymentPurpose.categoryPurpose.proprietary Specifies the type of scheme with a proprietary code.   4

Values include:

  • "CXSALA" - Salary and benefits payment
  • "CXBSNS" - General business payment
  • "CXMRCH" - FPS merchant payment
  • "CXTOPU" - Account top-up payment

Refer to Payments Developer Portal for list of purpose/category codes.

Hong Kong (FPS) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.

Indonesia (BI-FAST)

Indonesia (BI-FAST) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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.  

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment; based on ISO 4217 Alpha-3 Currency Code.
  • Field is expected to match IDR expression.
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
  • Must be non decimal (ID doesn’t support decimal)
  • Max Limit: IDR 250,000,000
transferType Indicates the direction of the money movement.      Must put Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC.   11

Field is expected to have one of these 8 or 11 BIC values per below:

  • "CHASIDJX"
  • "CHASIDJXXXX"
  • "CHASIDJT"
  • "CHASIDJTJAH"
  • "CHASIDJTXXX"
  • "CHASIDJX"
  • "CHASIDJXXXX"
  • "CHASSIDJTJA"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     This value will be "BIC".
creditor.account.accountNumber This field captures a regular account number   35 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.name Party name   140 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].id Financial institution identifier.   11 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier  

3

  • Mandatory for Pay to Account
  • "BIC"
Indonesia (BI-FAST) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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.  

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Currency of the payment; based on ISO 4217 Alpha-3 Currency Code.
  • Field is expected to match IDR expression.
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
  • Must be non decimal (ID doesn’t support decimal)
  • Max Limit: IDR 250,000,000
transferType Indicates the direction of the money movement.      Must put Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id   The financial institution identifier, i.e., BIC.   11

Field is expected to have one of these 8 or 11 BIC values per below:

  • "CHASIDJX"
  • "CHASIDJXXXX"
  • "CHASIDJT"
  • "CHASIDJTJAH"
  • "CHASIDJTXXX"
  • "CHASIDJX"
  • "CHASIDJXXXX"
  • "CHASSIDJTJA"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     This value will be "BIC".
creditor.account.alternateAccountIdentifiers.identifier Alternate account identifier. 1 2048
  • Required for Pay to Proxy
  • Supports alphanumeric with max 2048 characters
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account.   4

Required for Pay to Proxy

Value options include:

  • "MOBN" — Mobile number
  • "EMAL" — Email Address
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account. Mandatory if account.alternateAccountIdentifiers.[x].idType =PROPRIETARY   4

Required for Pay to Proxy

Value options include:

  • "MOBN" — Mobile number
  • "EMAL" — Email Address
Indonesia (BI-FAST) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
paymentPurpose.categoryPurpose.proprietary Specifies the type of scheme with a proprietary code.   35 Values include:
  • "WEALTH_TRANSFER" - Indicates a wealth transfer
  • "INVESTMENT" - Indicates an investment payment
  • "PURCHASE" - Indicates a purchase
  • "CXSALA" - Indicates a salary and benefits payment
  • "OTHER" - Use when the payment cannot be categorized by another available Purpose code

Refer to Payments Developer Portal for list of purpose/category codes.

remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.
chargesInformation.chargeBearer Charge bearer   8
  • "CREDITOR" - Borne by Creditor
  • "DEBTOR" - Borne by Debtor

Malaysia (RPP)

Malaysia (RPP) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "MYR" expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: MYR 10,000,000
transferType Indicates the direction of the money movement. The transaction is either a credit push transfer or a direct debit pull transfer.     Must put "Credit" for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtor.device.ipAddress Device details of a party partaking in the money movement.  

35

  • If transferType = "CREDIT"
  • Mandatory for IP address only
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier. i.e BIC,   8

Field is expected to have an 8 digit BIC value: "CHASMYKX"

debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.accountNumber This field captures a regular account number   34 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.account.accountType The type of account.   4
  • "LOAN"
  • "DFLT"
  • "SVGS"
  • "CACC"
creditor.name Party name   140 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].id Financial institution identifier.   11 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   3
  • Mandatory for Pay to Account
  • "BIC"
paymentPurpose.purpose.code This field is mandatory for Malaysia Real-Time Payments Platform (RPP). Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.   5
  • Required if either the debtor or creditor country of residency is not Malaysia
  • Refer to Payments Developer Portal for list of purpose/category codes
  • Should be a string value.
remittanceInformation.structuredInformation[].creditReference.reference Unique reference to unambiguously refer to the payment transaction.   140  
Malaysia (RPP) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "MYR" expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: MYR 10,000,000
transferType Indicates the direction of the money movement. The transaction is either a credit push transfer or a direct debit pull transfer.     Must put "Credit" for routing rules.
paymentType

Type of payment being initiated. 

  3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtor.device.ipAddress Device details of a party partaking in the money movement.  

35

  • If transferType = "CREDIT"
  • Mandatory for IP address only
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier. i.e BIC,   8

Field is expected to have one of these 8 digit BIC values: "CHASMYKX"

debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.accountType The type of account.   4
  • "LOAN"
  • "DFLT"
  • "SVGS"
  • "CACC"
creditor.account.alternateAccountIdentifiers.identifier Alternate account identifier  

If transferType = "CREDIT",

Max - 256

If transferType = "DEBIT",

Not Supported

Required for Pay to Proxy
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account   4

Required for Pay to Proxy

Value options include:

  • "MBNO" — Mobile number
  • "NRIC" — IC number
  • "PSPT" — Passport number
  • "ARMN" — Army or Police Number
  • "BREG" — Business registration number
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account. Mandatory if account.alternateAccountIdentifiers.[x].idType =PROPRIETARY   4

Required for Pay to Proxy

Value options include:

  • "MBNO" — Mobile number
  • "NRIC" — IC number
  • "PSPT" — Passport number
  • "ARMN" — Army or Police Number
  • "BREG" — Business registration number
paymentPurpose.purpose.code This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.   5
  • Required if either the debtor or creditor country of residency is not Malaysia
  • Refer to Payments Developer Portal for list of purpose/category codes
remittanceInformation.structuredInformation[].creditReference.reference Unique reference to unambiguously refer to the payment transaction.   140  
Malaysia (RPP) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   Max - 35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
paymentPurpose.purpose.type Purpose type   11

"PROPRIETARY"

Required if either the debtor or creditor country of residency is not Malaysia

remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.
remittanceInformation.structuredInformation[].additionalRemittanceInformation Additional remittance information   140
 

Singapore (FAST)

Singapore (FAST) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "SGD" expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: SGD 200,000
transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules
paymentType

Type of payment being initiated. 

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id   The financial institution identifier, i.e., BIC   11

Field is expected to have an 11 digit BIC value: "CHASSGSGXXX"

debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.accountNumber This field captures a regular account number   35 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.name Party name   140
Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].id Financial institution identifier   11 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3
  • Mandatory for Pay to Account
  • "BIC"
paymentPurpose.purpose.code This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.   4 This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.
paymentPurpose.purpose.type Purpose type   4

"CODE"

Refer to Payments Developer Portal for list of purpose/category codes.

Singapore (FAST) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "SGD" expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: SGD 200,000
transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules
paymentType

Type of payment being initiated. 

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id   The financial institution identifier, i.e., BIC   11

Field is expected to have an 11 digit BIC value: "CHASSGSGXXX"

debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.alternateAccountIdentifiers.identifier Alternate account identifiers   256 Required for Pay to Proxy
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account   4

Required for Pay to Proxy

Value options include:

  • "MSIDN" — Mobile number
  • "UEN" — Unique Entity Number
  • "VPA" — Virtual Payment Address
  • "NRIC" — IC number RTP
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account. Mandatory if account.alternateAccountIdentifiers.[x].idType =PROPRIETARY   4

Required for Pay to Proxy

Value options include:

  • "MSIDN" — Mobile number
  • "UEN" — Unique Entity Number
  • "VPA" — Virtual Payment Address
  • "NRIC" — IC number RTP
paymentPurpose.purpose.code This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.   4 This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or a commercial agreement between the creditor and the debtor.
paymentPurpose.purpose.type Purpose type   4

"CODE"

Refer to Payments Developer Portal for list of purpose/category codes.

Singapore (FAST) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.

Europe, Middle East, and Africa (EMEA)

Single Euro Payments Area (SEPA Instant)

SEPA Instant RTP required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "EUR" expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: EUR 100,000
transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   34  
debtorAgent.financialInstitutionIds[].id The financial instituion identifier, i.e. , BIC   11
  • The field is expected to include one of the following branches and its corresponding 8- or 11-character BIC values:
    • Frankfurt "CHASDEFX" "CHASDEFXXXX"
    • Luxembourg: "CHASLULX" "CHASLULXXXX"
    • Dublin: "CHASIE4L" "CHASIE4LXXX"
    • Amsterdam: “CHASNL2X” “CHASNL2XXXX”
    • Paris: “CHASFRPP” “CHASFRPPXXX”
    • Milan: “CHASITMX” “CHASITMXXXX”
    • Madrid: “CHASESM3” “CHASESM3XXX”
    • Brussels: “CHASBEBX” “CHASBEBXXXX”
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier.     This value will be "BIC".
creditor.account.accountNumber This field captures a regular account number.   34  
creditor.name Party name   70  
creditorAgent.financialInstitutionIds[].id The financial institution identifier.   11 Clients are encouraged not to populate in payload. CreditorAgent BIC will be derived from the Creditor IBAN.
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   3 Mandatory if the above is populated: "BIC"
additionalParties.ultimateDebtor.organizationIds[].organizationId Formally Issued Organization Identifier   35
Mandatory for TP3 flows (Either Organization Id or Individual Id). The Ultimate Debtor's physical or virtual IBAN/account number is recommended. Otherwise, in the account is not available, a unique identifier should be specified; to be determined by the payment service provider that could allow traceability back to the Ultimate Debtor.
additionalParties.ultimateDebtor.organizationIds[].schemeName.proprietary Specifies the type of scheme with a proprietary code.   3

If the transaction includes an Ultimate Debtor, populate one of the following fields:

"BIC", "LEI", or "ID"

additionalParties.ultimateDebtor.individualIds[].individualId Individual identifier details   35
Mandatory for TP3 flows (Either Organization Id or Individual Id). The Ultimate Debtor's physical or virtual IBAN/account number is recommended. Otherwise, in the account is not available, a unique identifier should be specified; to be determined by the payment service provider that could allow traceability back to the Ultimate Debtor.
additionalParties.ultimateDebtor.individualIds[].schemeName.proprietary Specifies the type of scheme with a proprietary code.   3

If the transaction includes an Ultimate Debtor, populate one of the following fields:

"BIC", "LEI", or "ID"

SEPA Instant RTP optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   4

Currently only support IBAN accounts.

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

Currently only supports "EUR".

creditor.postalAddress.type Type of postal address   4

Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)
creditor.postalAddress.buildingNumber Building number   16  
creditor.postalAddress.streetName

Street name

  70  
creditor.postalAddress.city City   35  
creditor.postaladdress.postalCode Postal Code   16  
creditor.postalAddress.countrySubDivision Country Subdivision code   35  
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.organizationIds[].organizationId  Organization identifier details   35 Either individualID or organizationID, not both
additionalParties.ultimateCreditor.individualIds[].individualId Individual identifier details   35 Either individualID or organizationID, not both
remittanceInformation.unstructuredInformation.text Unstructured information   140 (1 line) This is to provide other payment details.

United Kingdom (UK FPS)

United Kingdom (UK FPS) required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

31

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "GBP" expression.
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. 0.01 18
  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: GBP 1,000,000
transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   8 Account numbers with less than 8 digits must be padded with leading zeros
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   11

Field is expected to have one of these 8 or 11 BIC values below:

  • "CHASGB2L"
  • "CHASGB2LXXX"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
debtorAgent.additionalInstitutions[].id Identifier   11 This field becomes mandatory for any TP3 Payment Originating Overseas (POO). It needs to be populated with the BIC code of the first Overseas Payment Service Provider
creditor.account.accountNumber This field captures a regular account number   8 Account numbers with less than 8 digits must be padded with leading zeros
creditor.name Party name   40  
creditorAgent.financialInstitutionIds[].id Financial institution identifier.   6 This is a 6-digit field that represents the sort code. Sort codes containing less than six digits must be padded with leading zeros. For example, if the number is 1234, you will need to enter leading zeros. so that the number will be represented as 001234.
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier   9 "SORT_CODE"
United Kingdom (UK FPS) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

Currently only supports "GBP"

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)
creditor.postalAddress.buildingNumber Building number   16  
creditor.postalAddress.streetName

Street name

  70  
creditor.postalAddress.city City   35  
creditor.postaladdress.postalCode Postal Code   16  
creditor.postalAddress.countrySubDivision Country Subdivision code   35  
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.organizationIds[].organizationId  Organization identifier details   35 Either individualID or organizationID, not both
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.

Latin America (LATAM)

Brazil (PIX)

Brazil (PIX) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "BRL" expression.
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. 0.01 18

Must be >=0.01

Max 2 decimal places.

transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType Type of payment being initiated.  3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber     34  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   11

Field is expected to have one of these 8 or 11 BIC values per below:

  • "CHASBRSP"
  • "CHASBRSPXXX"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.accountNumber This field captures a regular account number   34 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.account.accountType The Alternate Account Identifier value.   4

A required field when using Pay to Account. Value options include:

"CACC" — Checking account

"SLRY" -

"TRAN" — Payment account

"SVGS" — Savings account

creditor.name One or more values that can be used as alternative identifiers for an account.   140  
creditorAgent.financialInstitutionIds[].id The financial institution identifier.   8
  • Mandatory for Pay to Account
  • ISPB Beneficiary Bank Code
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier   18
  • Mandatory for Pay to Account
  • "CLEARING_SYSTEM_ID"
creditorAgent.financialInstitutionIds[].branchNumber Branch of the bank or financial institution. NA for Japan    
  • Mandatory for Pay to Account
  • Beneficiary Branch number
taxInformation.creditorTaxInformation.taxId Tax identifier   35  
taxInformation.creditorTaxInformation.taxPayerCategory Tax payer category. If category = INDIVIDUAL map here    
  • "INDIVIDUAL" — When the beneficiary is an individual.
  • "CORPORATE " — When the beneficiary is a corporation.
Brazil (PIX) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "BRL" expression.
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. 0.01 18

1. Field is mandatory.

2. Field is expected to have maximum of 18 characters.

3. Field is expected to have no more than two decimal places.

4. Field is expected to be above 0.01

5. Must meet min/max amount for clearing per PBRM.

6. Must meet client and user limit entitlements.

transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType Type of payment being initiated.  3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber The debtor's account number.   34  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   11

Field is expected to have one of these 8 or 11 BIC values per below:

  • "CHASBRSP"
  • "CHASBRSPXXX"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.alternateAccountIdentifiers.identifier The alternate account identifier.  

Based on type:

  • "EMAL" – 72 characters
  • "MOBN" – 13 characters
  • "CPF" – 11 characters
  • "CNPJ" - 14 characters
  • "EVP" - 32 characters
  • "QRCD" - 500 characters
Required for Pay to Proxy
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account.   4

Required for Pay to Proxy

Value options include:

  • "EMAL" — Email Proxy
  • "MOBN" — Mobile Number Proxy
  • "CPF" — Individual Tax ID
  • "CNPJ" — Corporate Tax ID
  • ""EVP" — Random proxy
  • "QRCD" — QR Code
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account.   4

Required for Pay to Proxy

Value options include:

  • "EMAL" — Email Proxy
  • "MOBN" — Mobile Number Proxy
  • "CPF" — Individual Tax ID
  • "CNPJ" — Corporate Tax ID
  • ""EVP" — Random proxy
  • "QRCD" — QR Code
creditor.name One or more values that can be used as alternative identifiers for an account.   140  
taxInformation.creditorTaxInformation.taxId Tax identifier   35  
taxInformation.creditorTaxInformation.taxPayerCategory Tax payer category. If category = INDIVIDUAL map here    
  • "INDIVIDUAL" — When the beneficiary is an individual.
  • "CORPORATE " — When the beneficiary is a corporation.
Brazil (PIX) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
paymentPurpose.purpose.type Purpose type   11

"PROPRIETARY"

Required if either the debtor or creditor country of residency is not Malaysia

remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.

Mexico (SPEI)

Mexico (SPEI) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

16

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "MXN" expression.
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. 0.01 18

Must be >=0.01

Max 2 decimal places

Max Limit:

Monday to Friday:

  • 6 AM - 6 PM: No limit
  • 6 PM - 6 AM: MXN 11,400

Saturday & Sunday: MXN 11,400

transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType

Type of payment being initiated.

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   16  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   11

Field is expected to have one of these 8 or 11 BIC values per below:

  • "CHASMXMX"
  • "CHASMXMXXXX"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.accountNumber This field captures a regular account number.   16 This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled.
creditor.account.accountType The type of account.    

A required field when using Pay to Account. Value options include:

  • "CLABE"
  • "VOSTRO"
  • "DDA"
creditor.name Party name   40  
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier   18

Mandatory if the above is populated:

  • "BIC" or
  • "CLEARING_SYSTEM_ID"
Mexico (SPEI) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

16

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "MXN" expression.
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. 0.01 18

Must be >=0.01

Max 2 decimal places

Max Limit:

Monday to Friday:

  • 6 AM - 6 PM: No limit
  • 6 PM - 6 AM: MXN 11,400

Saturday & Sunday: MXN 11,400

transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType

Type of payment being initiated.

3 3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   16  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, i.e., BIC   11

Field is expected to have one of these 8 or 11 BIC values per below:

  • "CHASMXMX"
  • "CHASMXMXXXX"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier   3 Mandatory for Debits: "BIC"
creditor.account.alternateAccountIdentifiers.identifier The alternate account identifier.   Based on type:
  • "MOBN" - 10
  • "BANK" - 18
  • "CARD" - 16
Required for Pay to Proxy
creditor.account.alternateAccountIdentifiers.idType One or more values that can be used as alternative identifiers for an account   4

Required for Pay to Proxy

Value options include:

  • "MOBN" - Mobile number
  • "BANK" - Bank identifier
  • "CARD" - Debit card number
creditor.account.alternateAccountIdentifiers.proprietarySchemeName Specifies the type of Proxy account.   4

Required for Pay to Proxy

Value options include:

  • "MOBN" - Mobile number
  • "BANK" - Bank identifier
  • "CARD" - Debit card number
creditor.name Party name   40  
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier   18

Mandatory if the above is populated:

  • "BIC" or
  • "CLEARING_SYSTEM_ID"
Mexico (SPEI) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

debtorAgent.additionalInstitutions[].name The additional institution ID.   35  
creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.postalAddress.streetName

Street name

  70 Recommended for TP3 flows
creditor.postalAddress.city City   35 Recommended for TP3 flows
creditor.postaladdress.postalCode Postal Code   16 Recommended for TP3 flows
creditor.postalAddress.countrySubDivision Country Subdivision code   35 Recommended for TP3 flows
creditor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
creditorAgent.financialInstitutionIds[].id The financial institution ID.   11  
additionalParties.ultimateDebtor.Name Ultimate debtor name   140 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 Flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country Country   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country  

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.
taxInformation.taxAmount.amount Tax amount      
taxInformation.creditorTaxInformation.taxId Tax identifier   12
  • Mandatory if receiveracct.id is not provided. Value providded should be "BANK"
  • If receiveracct.id or receiverAcct.alternatAccountIdentifier is present and receiveracct.type !=VOSTRO, Client can provide Tax ID (Optional)
  • If provided, length should be 12 characters

North America (NA)

United States (TCH / FedNow)

United States (TCH/FedNow) required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date of the payment instruction, e.g., value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future 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. 1

35

  • Must be unique for each transaction within the file. No special characters allowed.
  • This value is used for duplicate checking and the right most positions are assumed to be low order (and therefore unique).
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. Field is expected to match "USD" expression.
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. 0.01 18

Must be >=0.01

Max 2 decimal places

Max Limit:

  • USD 1,000,000 (TCH)
  • USD 500,000 (FedNow)
transferType Indicates the direction of the money movement.      Must put "Credit" for routing rules.
paymentType

Type of payment being initiated. 

  3 Must put "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   34  
debtor.name Party name   140  
debtorAgent.financialInstitutionIds[].id Financial Institution Identifier. i.e USABA   9

ABA/routing number: 021000021

debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   5 "USABA"
creditor.account.accountNumber This field captures a regular account number   34  
creditor.name Party name    140     
creditorAgent.financialInstitutionIds[].id The financial institution ID.   9 ABA/routing number
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier   5 "USABA"
United States (TCH/FedNow) conditional fields

Field

Description

Minimum

Maximum

Notes

debtor.postalAddress.streetName

Street name

 70

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

debtor.postalAddress.city

 City

 35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

debtor.postalAddress.postalCode

Postal code

 16

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

debtor.postalAddress.countrySubDivision

Country subdivision

 35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

debtor.postalAddress.country

 Country

 2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory if postal address is provided

debtor.dateAndPlaceOfBirth.city

City of Birth

 35

  • Recommended for TP3 flows
  • Mandatory if dateAndPlaceOfBirth is provided

debtor.dateAndPlaceOfBirth.country

Country of Birth

 2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory if dateAndPlaceOfBirth is provided

debtor.dateAndPlaceOfBirth.birthDate

Birth date

 10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
  • Mandatory if dateAndPlaceOfBirth is provided

creditor.postalAddress.streetName

Street name

1

70

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

creditor.postalAddress.city

City

1

35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

creditor.postalAddress.postalCode

Postal Code

1

16

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

creditor.postalAddress.country

Country

2

  • Recommended for TP3 flows
  • 2-character ISO country code

creditor.postalAddress.countrySubDivision

Subdivision

1

35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

creditor.dateAndPlaceOfBirth.city

City of birth

1

35

  • Recommended for TP3 flows
  • Mandatory for dateAndPlaceOfBirth

creditor.dateAndPlaceOfBirth.country

Country

2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory for dateAndPlaceOfBirth

creditor.dateAndPlaceOfBirth.birthDate

Birth date

10

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateDebtor.Name

Ultimate debtor name

1

140

  • Recommended for TP3 Flows. 
  • Mandatory if other details for ultimate debtor are provided.

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city

City of birth

1

35

  • Recommended for TP3 Flows
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country

Country

2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate

Birth date

10

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateDebtor.postalAddress.streetName

Street name

1

70

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateDebtor.postalAddress.city

City

1

35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateDebtor.postaladdress.postalCode

Postal code

1

16

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

Country sub-division

1

35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateDebtor.postalAddress.country

Country.

2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory if postal address is provided

additionalParties.ultimateCreditor.Name

Party name

1

140

Becomes mandatory if other details for ultimate creditor are provided.

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city

City of birth

1

35

  • Recommended for TP3 flows
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country

Country of birth

2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate

Date of birth

10

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD
  • Mandatory if dateAndPlaceOfBirth is provided

additionalParties.ultimateCreditor.postalAddress.streetName

Street name

1

70

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateCreditor.postalAddress.city

City

1

35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateCreditor.postaladdress.postalCode

Postal code

1

16

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

additionalParties.ultimateCreditor.postalAddress.country

Country

2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
  • Mandatory if postal address is provided

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

Country sub division

1

35

  • Recommended for TP3 flows
  • Mandatory if postal address is provided

remittanceInformation.structuredInformation[].additionalRemittanceInformation

Additional remittance information

Mandatory if structuredInformation object is used

United States (TCH/FedNow) optional fields
Field Description Minimum Maximum Notes
debtor.account.accountType This field captures the debtor's account type   3

Currently only support DDA or VAM account

debtor.account.accountCurrency ISO 4217 Alpha-3 Currency Code.  

3

debtor.postalAddress.addressLines

Unstructured address

70

Recommended for TP3 flows

debtor.postalAddress.buildingNumber

Building number

 16

Recommended for TP3 flows

creditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
creditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)

Recommended for TP3 flows

creditor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
creditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16 Recommended for TP3 flows
additionalParties.ultimateCreditor.countryOfResidence Country of residence   2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address   4

Recommended for TP3 Flows Values include:

  • "ADDR" - Postal Address is the complete postal address.
  • "BIZZ" - Business Address is the business address.
  • "DLVY" - DeliveryTo Address is the address to which delivery is to take place.
  • "HOME" - Residential Address is the home address.
  • "MLTO" - MailTo Address is the address to which mail is sent.
  • "PBOX" - PO Box Address is a postal office (PO) box.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines) Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35 Recommended for TP3 flows
additionalParties.ultimateCreditor.individualIds[].individualId Individual id details   35 Either individualID or organizationID, not both
remittanceInformation.unstructuredInformation.text Unstructured information   140 (2 lines) This is to provide other payment details.

To view example RTP payment requests for different markets, see the API specification.

Next steps

Learn more about available resources.