Skip to main content
Note

CBPR+ fields are available in mock responses for select endpoints. Preview supported scenarios in the API specification for Global Payments 2. Learn more in our blog.

Payment and returns parameters

This page outlines the required fields needed to successfully submit a Real-Time Payment request. All required fields must be included to ensure your request is processed. Optional fields offer additional functionality and are not required for 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.

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)

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

The requested execution date.

10

10

  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.

paymentIdentifiers.endToEndId

The payment's unique end-to-end ID that's assigned by the originator.

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 defined in the ANZ PEPPOL framework for e-Invoicing)
  • For the rest, populate Customer Ref

value.currency

The currency of value.amount.

3

3

Fixed value: "AUD"

value.amount

The value’s amount.

1

18

  • Must be >=0.01
  • Max 2 decimal places
  • Max Limit: AUD 10,000,000

transferType

The transfer type.

6

6

Must be CREDIT.

paymentType

The payment type.

3

3

Must be RTP.

debtor.account.accountNumber

The debtor’s account number.

1

35

debtorAgent.financialInstitutionIds[].id

The debtor agent’s financial institution ID.

8

8

Field is expected to have this BIC value: CHASAU2X

debtorAgent.financialInstitutionIds[].idType

The debtor agent’s financial institution ID type.

3

3

"BIC"

Australia (NPP) Pay to Account required fields

Australia (NPP) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Enter the requested execution date for the payment instruction in yyyy-mm-dd format. Use today’s date or a future date. 1 10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 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 defined 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

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
  • Must have no more than two decimal places.
  • Must be greater than 0.01.
  • Max limit: AUD $10,000,000
transferType Indicates the direction of the money movement.      Must be Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must be RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "BIC".   8 Field must have an 8 digit BIC value: CHASAU2X.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must 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, such as Bank Branch State Identifier (BSB code)   11 Field must be populated with the BSB Code.
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   18

Must be CLEARING_SYSTEM_ID.

Australia (NPP) Pay to Proxy required fields

Australia (NPP) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, in yyyy-mm-dd format. Use today’s date or a future date only. 1 10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 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 defined 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

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
  • Must be no more than two decimal places.
  • Must be greater than 0.01
  • Max limit: AUD $10,000,000
transferType Indicates the direction of the money movement.      Must be Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must be RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "BIC".   8 Field is expected to have an 8 digit BIC value: CHASAU2X.
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must 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. 11 11 Must be PROPRIETARY.
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, such as Bank Branch State Identifier (BSB code)   11 Field must be populated with the BSB Code.
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   18

Must be "CLEARING_SYSTEM_ID".

Australia (NPP) optional fields

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

Currently supports 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)
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

 2-character ISO country code

creditor.countryOfResidence Country of residence   2

 2-character ISO country code

additionalParties.ultimateDebtor.Name Ultimate debtor name   140  
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth   35  
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country   2

 2-character ISO country code

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date  

10

 Format is YYYY-MM-DD

additionalParties.ultimateDebtor.countryOfResidence Country of residence   2

 2-character ISO country code

additionalParties.ultimateDebtor.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.
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses   70  
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number   16  
additionalParties.ultimateDebtor.postalAddress.streetName Street name   70  
additionalParties.ultimateDebtor.postalAddress.city City   35  
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code   16  
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country sub division   35  
additionalParties.ultimateDebtor.postalAddress.country Country   2 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 Must be "USI".
additionalParties.ultimateCreditor.Name Party name   140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth   35  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth   2

2-character ISO country code

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth   10
 

Format is YYYY-MM-DD

additionalParties.ultimateCreditor.countryOfResidence Country of residence   2 2-character ISO country code
additionalParties.ultimateCreditor.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.
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses   70 (4 lines)  
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number   35  
additionalParties.ultimateCreditor.postalAddress.streetName Street name   70  
additionalParties.ultimateCreditor.postalAddress.city City   35  
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code   16  
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country sub division   35  
additionalParties.ultimateCreditor.postalAddress.country Country  

2

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, such as a charity payment or a commercial agreement between creditor and debtor.   4 REFU (O) - client to be provided an option in case of refund of a superannuation payment.
paymentPurpose.purpose.type Purpose type   4

"CODE" 

paymentPurpose.categoryPurpose.code Purpose code   4 SALA TAX PENS(O) - PDP - if client need to initiate CPC payment then SALA, TAX and PENS will be used. 
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

Hong Kong (FPS) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format: YYYY-MM-DD.
  • Must be either the current or a future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. 
  • No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3

Field must match HKD or CNY expression.

value.amount A string representation of a whole number or decimal positive number. Amount must be greater than 0.01, with a maximum of two decimal places allowed in most markets. 0.01 18
  • Must be >=0.01.
  • Maximum 2 decimal places.
  • Maximum Limit: HKD or CNY 999,999.
transferType Indicates the direction of the money movement.      Must be set to Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must be set to RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "BIC".   8 Must be the 8 digit BIC value: "CHASHKHH".
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must 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.

Required only for Pay by Account. Not applicable for Pay by Proxy.

creditor.account.accountType The type of account.   

4

  • Required for Pay to Account.
  • Value: BBAN
creditor.name Party name   140 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].id Financial institution identifier, such as a three digit bank code.   3 Mandatory for Pay to Account
creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier.   18
  • Mandatory for Pay to Account
  • Value: "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

Hong Kong (FPS) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format: YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. 
  • No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3

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 be Credit for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must be RTP for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "BIC".   8 Field is expected to have an 8 digit BIC value: "CHASHKHH"
debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier     Must 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 11 11 Must be PROPRIETARY.
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

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

Supports DDA or VAM account only.

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.

India (IMPS)

India (IMPS) required fields

India (IMPS) required fields

Field

Description

Minimum Maximum

Notes

requestedExecutionDate

The requested execution date.

10

10

  • .Must match ISO date format (YYYY-MM-DD). 
  • Must be either the current or a future date.
  • The date entered represents the clearing’s time zone, not your local time zone.

paymentIdentifiers.endToEndId

Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated.

1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction in the file. Special characters are not allowed.
  • The characters on the right are treated as low order and must be unique.
  • The first 16 characters are populated in the account statements and reports as customer reference.

value.currency

Currency of the payment, based on ISO 4217 Alpha-3 Currency Code.

3

3

Fixed value: INR

value.amount

A string representation of a whole number or decimal positive number. The amount must be greater than 1 and can have up to two decimal places in most markets.

1

18

Max limit: INR 500,000

transferType

The transfer type.

6

6

Must be CREDIT.

paymentType

The payment type.

3

3

Must be RTP.

debtorAgent.financialInstitutionIds[].id

The financial institution identifier of the debtor.

8

8

Field must have a 8 BIC value: CHASINBX

debtorAgent.financialInstitutionIds[].idType

The debtor agent’s financial institution ID type.

3

3

Must be BIC.

creditor.account.accountNumber

The creditor’s account number.

1

34

This field is used to provide the regular account ID for Pay by Account instructions only.

creditor.account.accountType

The creditor's account type.

4

4

Allowed Values:

  • "CACC": CURRENT
  • "LOAN": LOAN
  • "NREX": NRE
  • "ODFT": OVERDRAFT
  • "SVGS": SAVINGS
  • "CACR": CASHCREDIT
  • "NROR": NRO
  • "SNRR": SNRR

creditor.name

The creditor’s name.

1

140


Mandatory for Pay to Account. Currently supports just Pay by Account.

creditorAgent.financialInstitutionIds[].id

The creditor agent’s financial institution ID.

11

11

11 character IFSC Code is mandatory for Pay to Account Example: BKID0002743:
  • 1st 4 characters = Bank Name
  • 5th character = 0
  • last 6 characters = Bank branch identifier

creditorAgent.financialInstitutionIds[].idType

The creditor agent's financial institution ID type.

18

18

Use CLEARING_SYSTEM_ID.

India (IMPS) optional fields

India (IMPS) optional fields

Field

Description

Minimum

Maximum

Notes

debtor.account.accountType

Type of account associated with the debtor.

1

3

Currently support only DDA account.

debtor.account.accountCurrency

The debtor's account currency.

3

3

 

creditor.dateAndPlaceOfBirth.countrySubDivision

Creditor's country subdivision code.

2

2

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

creditor.countryOfResidence

Creditor's country of residence.

2

2

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

additionalParties.ultimateCreditor.organizationIds[].organizationId

Creditor's formally issued organization identifier.

1

35

Either individualID or organizationID, not both

additionalParties.ultimateCreditor.Name

Creditor's party name.

1

120

 

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city

Creditor's city of birth.

1

35

Recommended for TP3 flows

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country

Creditor's country of birth.

2

2

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

additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate

Creditor's date of birth.

10

10

  • Recommended for TP3 flows
  • Must be in YYYY-MM-DD format.

additionalParties.ultimateCreditor.postalAddress.type

Creditor's postal address type.

4

4

Recommended for TP3 flows. Values are:

  • "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

Creditor's unstructured addresses.

1

70

  • Recommended for TP3 flows
  • Maximum of 7 lines

additionalParties.ultimateCreditor.postalAddress.buildingNumber

Creditor's building number.

1

35

Recommended for TP3 flows.

additionalParties.ultimateCreditor.postalAddress.streetName

Creditor's street name.

1

70

Recommended for TP3 flows.

additionalParties.ultimateCreditor.postalAddress.city

Creditor's city.

1

35

Recommended for TP3 flows.

additionalParties.ultimateCreditor.postaladdress.postalCode

Creditor's postal code.

1

16

Recommended for TP3 flows.

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

Creditor's country sub division.

1

35

Recommended for TP3 flows.

additionalParties.ultimateCreditor.postalAddress.country

Creditor's country.

2

2

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

additionalParties.ultimateCreditor.individualIds[].individualId

Individual identifier details.

1

35

Either individualID or organizationID, not both

remittanceInformation.unstructuredInformation.text

The payment's remittance information.

1

50

This is to provide additional payment details, which J.P. Morgan may or may not send to clearing.

paymentPurpose.categoryPurpose.code

A code representing the high-level purpose of a payment, based on a set of predefined categories.

1

4

If it is a Payroll payment, populate with 'SALA - Payroll payment'; otherwise, leave it blank.

India (RDA)

Required fields

India RDA required fields

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

Requested execution date of the payment instruction (e.g. value date) in ISO 8601 yyyy-mm-dd format, must be either the current or future date.

10

10

 

paymentIdentifiers.endToEndId

Customer assigned Unique identifier to unambiguously identify the Payment transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

1

35

  • Must be > 1.00
  • Max 2 decimal places
  • Max Limit through IMPS: INR 500,000
  • Refer Purpose Code list for Transaction limits

value.currency

ISO 4217 Alpha-3 Currency Code

3

3

"INR"

value.amount

A string representation of a (potentially) whole number or decimal positive number.

1

18

  • Must be > 1.00
  • Max 2 decimal places
  • Max Limit through IMPS: INR 500,000
  • Refer Purpose Code list for Transaction limits

transferType

Indicates the direction of the money movement.

6

6

Must be CREDIT.

paymentType

The type of payment being initiated

3

3

Must be RTP.

debtor.account.accountNumber

This field captures a regular account number.

1

34

NREH's account with JPM India

debtorAgent.financialInstitutionIds[].id

Financial Institution Identifier

8

8

Field is expected to have this BIC value: CHASINBX

debtorAgent.financialInstitutionIds[].idType

3

3

"BIC"

creditor.account.accountNumber

This field captures a regular account number.

1

34

  • This field is to provide the regular account id when it is a Pay by Account instruction.
  • Currently supports Pay by Account only.

creditor.account.accountType

4

4

Allowed Values: "CACC" - CURRENT

  • "LOAN" - LOAN
  • "NREX" - NRE
  • "ODFT" - OVERDRAFT
  • "SVGS" - SAVINGS
  • "CACR" - CASHCREDIT
  • "NROR" - NRO
  • "SNRR" - SNRR

creditor.name

Party name

1

140

Mandatory for Pay to Account. Currently supports Pay by Account only.

creditor.postalAddress.addressLines[]

1

70

creditor.postalAddress.postalCode

1

16

creditor.countryOfResidence

ISO 3166-1 Alpha-2 Country Code

2

2

2-character ISO country code.

creditorAgent.financialInstitutionIds[].id

SWIFT IC.

11

11

  • Mandatory for Pay to Account.
  • 11 character IFSC Code. Example: BKID0002743.
  • 1st 4 characters = Bank Name, 5th character = 0, last 6 characters = Bank branch identifier

creditorAgent.financialInstitutionIds[].idType

18

18

Use "CLEARING_SYSTEM_ID"

additionalParties.ultimateDebtor.partyId.organizationIds[].organizationId

Formally Issued Organization Identifier

1

35

  • 1st instance - Populate with Ultimate Debtor's Bank Account No./Unique Reference No./Identification Number, if Ultimate Debtor is an Entity / Corporation.
  • 2nd Instance - Populate with Nationality, if the ultimate debtor is entity / Corporation.
  • 3rd Instance - Populate with LEI code when the payment amount is >INR 500MM and if the ultimate debtor is entity / Corporation.

additionalParties.ultimateDebtor.partyId.organizationIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value

1

35

  • When ultimate debtor is entity, 1st instance should be "ACCOUNT"
  • When ultimate debtor is entity, 2nd instance should be "NATIONALITY"
  • When ultimate debtor is entity, 3rd instance should be "LEI" when the payment amount is >INR500MM

additionalParties.ultimateDebtor.partyId.individualIds[].individualId

Unique and unambiguous identification of an individual

1

35

  • 1st instance - Populate with Ultimate Debtor's Bank Account No./Unique Reference No./Identification Number, if Ultimate Debtor is an individual / Person
  • 2nd Instance - Populate with Nationality, if the ultimate debtor is individual / Person

additionalParties.ultimateDebtor.partyId.individualIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

35

  • When ultimate debtor is Individual / person, 1st instance should be "ACCOUNT"
  • When ultimate debtor is Individual / Person, 2nd instance should be "NATIONALITY"

additionalParties.ultimateDebtor.name

Name.

1

140

additionalParties.ultimateDebtor.postalAddress.addressLines[]

Ultimate debtor address lines.

1

70

Maximum of 7 lines

additionalParties.ultimateDebtor.postalAddress.city

City.

1

35

additionalParties.ultimateDebtor.postalAddress.country

ISO 3166-1 Alpha-2 Country Code

2

2

2 character ISO code

India (RDA)

Optional fields

India RDA optional fields

Field

Description

Minimum

Maximum

Notes

debtor.account.accountType

Account type.

1

3

Currently only support "DDA"

debtor.account.accountCurrency

ISO 4217 Alpha-3 Currency Code

3

3

"INR"

creditor.postalAddress.type

Postal address.

4

4

Values are:

  • "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.buildingNumber

Building number.

1

16

creditor.postalAddress.streetName

Street Name

1

70

creditor.postalAddress.city

City.

1

35

creditor.postalAddress.countrySubDivision

ISO 3166-2 Alphanumeric Country Subdivision Code

1

35

creditor.postalAddress.country

ISO 3166-1 Alpha-2 Country Code

2

2

creditor.dateAndPlaceOfBirth.city

City or town name

1

35

creditor.dateAndPlaceOfBirth.country

ISO 3166-1 Alpha-2 Country Code

2

2

2-character ISO country code

creditor.dateAndPlaceOfBirth.birthDate

Birth date in YYYY-MM-DD format eg. 1984-05-19.

10

10

Format is YYYY-MM-DD

creditor.partyId.organizationIds[].organizationId

Formally Issued Organization Identifier

1

35

1st instance to be Tax ID / GST number of the bene if its an entity

When creditor is entity, 2nd instance to be LEI code if the bene is entity and amount of txn is >=INR500MM

creditor.partyId.organizationIds[].issuer

Entity that assigns the identification

1

35

creditor.partyId.organizationIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value

1

35

1st instance populate with "GST"

When creditor is entity, 2nd instance populate with "LEI"

creditor.partyId.individualIds[].individualId

Unique and unambiguous identification of an individual

1

35

Tax ID / GST number of the individual if available, else Blank

creditor.partyId.individualIds[].issuer

Entity that assigns the identification

1

35

creditor.partyId.individualIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

35

Populate with "GST" in case GST number available, else blank

additionalParties.ultimateDebtor.partyId.organizationIds[].issuer

Entity that assigns the identification

1

35

additionalParties.ultimateDebtor.partyId.individualIds[].issuer

Entity that assigns the identification

1

35

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city

City or town name

1

35

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country

ISO 3166-1 Alpha-2 Country Code

2

2

2-character ISO country code

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate

Birth date in YYYY-MM-DD format eg. 1984-05-19.

10

10

Format is YYYY-MM-DD

additionalParties.ultimateDebtor.countryOfResidence

ISO 3166-1 Alpha-2 Country Code

2

2

2-character ISO country code

additionalParties.ultimateDebtor.postalAddress.type

Postal address type.  

4

Recommended for TP3 flows
Values are:

  • "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.buildingNumber

Building number.  

16

additionalParties.ultimateDebtor.postalAddress.streetName

Street name.

1

70

additionalParties.ultimateDebtor.postalAddress.postalCode

1

16

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

ISO 3166-2 Alphanumeric Country Subdivision Code

1

35

additionalParties.ultimateCreditor.name

1

120

additionalParties.ultimateCreditor.postalAddress.type

Type of postal address.

4

4

Recommended for TP3 flows
Values are:

  • "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[]

Ultimate creditor address lines.

1

70

Maximum of 7 lines

additionalParties.ultimateCreditor.postalAddress.buildingNumber

Building number.

1

35

additionalParties.ultimateCreditor.postalAddress.streetName

Street name.

1

70

additionalParties.ultimateCreditor.postalAddress.city

City.

1

35

additionalParties.ultimateCreditor.postalAddress.postalCode

Postal code.

1

16

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

ISO 3166-2 Alphanumeric Country Subdivision Code

1

35

additionalParties.ultimateCreditor.postalAddress.country

ISO 3166-1 Alpha-2 Country Code

2

2

remittanceInformation.unstructuredInformation[].text

Maximum number of lines and characters supported per market/instrument

1

50

  • This is to provide other payment details.
  • Maximum of 6 linesF

Malaysia (RPP)

Malaysia (RPP) Pay to Account required fields

Malaysia (RPP) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format: YYYY-MM-DD.
  • Must be either the current or a future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • Field must match the "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 be "Credit" for routing rules.
paymentType

Type of payment being initiated. 

3 3 Must be "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

The financial institution identifier, for example "BIC".

  8

Must 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 required for Malaysia Real-Time Payments Platform. Enter the reason for the payment, such as charity or 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

Malaysia (RPP) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or a future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • 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 be "Credit" for routing rules.
paymentType

Type of payment being initiated. 

  3 Must be "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 The financial institution identifier, for example "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 11 11 Must be PROPRIETARY.
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 required for Singapore Faster Payments. Specify the reason for the payment, such as charity or 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

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

Currently supports 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

Singapore (FAST) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • 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 be "Credit" for routing rules
paymentType

Type of payment being initiated. 

3 3 Must be "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "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 required for Singapore Faster Payments. Specify the reason for the payment, such as charity or commercial agreement between the creditor and the debtor.   4 This field is required for Singapore Faster Payments. Enter the reason for the payment, such as charity or commercial agreement between creditor and 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

Singapore (FAST) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where only the first 16 characters will be populated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • 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 be "Credit" for routing rules
paymentType

Type of payment being initiated. 

3 3 Must be "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   35  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "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 11 11 Must be PROPRIETARY.
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 required for Singapore Faster Payments. Specify the reason for the payment, such as charity or commercial agreement between the creditor and the debtor.   4  
paymentPurpose.purpose.type Purpose type   4

"CODE"

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

Singapore (FAST) optional fields

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

Currently supports 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.

Thailand (PromptPay)

Thailand (PromptPay) Pay to Account (Domestic) required fields

Required

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

Enter the requested execution date in YYYY-MM-DD format. Use today’s date or a future date.

1

10

  • Must be ISO date YYYY-MM-DD.
  • Must be current or future date.
  • Date is in clearing time zone.

paymentIdentifiers.endToEndId

Customer-assigned unique identifier for the payment initiation request. Passed unchanged end-to-end; account statements and reports show only the first 16 characters.

1

35

  • Must be unique per transaction; no special characters.
  • Used for duplicate checking; rightmost positions assumed low order.
  • First 16 characters appear as Customer Reference. We may or may not pass to clearing.

value.currency

Currency of the payment (ISO 4217 alpha-3).

3

3

Fixed value: THB.

value.amount

Positive whole number or decimal. Amount must be greater than 0.01; up to two decimal places.

1

18

  • ≤ 2 decimal places. > 0.01.
  • Max limit: THB 2,000,000.00.

transferType

Indicates the direction of money movement.

1

Must be CREDIT for routing rules.

paymentType

Type of payment being initiated.

3

3

Must be RTP for routing rules.

paymentTypeInformation.localInstrumentCode.proprietary

Proprietary code specifying the local instrument.

5

5

AA = scheme (e.g., PP), B = type (D domestic, C cross-border), CC = transaction (e.g., CT, BP). Always “PPDCT” for domestic transfers.

debtor.account.accountNumber

Debtor account number.

1

35

debtorAgent.financialInstitutionIds[].id

Financial institution identifier (e.g., BIC).

1

8

Must be 8-character BIC: CHASTHBX.

debtorAgent.financialInstitutionIds[].idType

Type of financial institution identifier.

3

3

Must be “BIC”.

creditor.account.accountNumber

Regular account number.

1

35

Provide for Pay to Account. Do not populate for Pay to Proxy.

creditor.name

Party name.

1

140

Mandatory for Pay to Account.

creditorAgent.financialInstitutionIds[].id

Financial institution identifier (e.g., bank code).

3

3

Mandatory for Pay to Account. 3‑digit bank code.

creditorAgent.financialInstitutionIds[].idType

Type of financial institution identifier.

18

Must be “CLEARING_SYSTEM_ID”.

paymentPurpose.purpose.proprietary

Purpose of payment (proprietary code).

6

Mandatory if using non‑resident accounts for domestic payments (PPDCT) for regulatory reporting (6‑digit purpose code).

paymentPurpose.categoryPurpose.proprietary

Category purpose (proprietary code).

4

Optional for domestic payments. Use “SALA” for salary to mask creditor details in statements/reports.

remittanceInformation.unstructuredInformation.text

Unstructured remittance information.

140 (2 lines)

Optional. Only first 40 characters sent to clearing. Thai characters allowed.

Thailand (PromptPay) Pay to Proxy (Domestic) required fields

Thailand (PromptPay) Pay to Proxy (Domestic) required fields

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

Enter the requested execution date in YYYY-MM-DD format. Use today’s date or a future date.

1

10

Must be ISO date YYYY-MM-DD. Must be current or future date. Date is in clearing time zone.

paymentIdentifiers.endToEndId

Customer-assigned unique identifier for the payment initiation request. Passed unchanged end-to-end; account statements and reports show only the first 16 characters.

1

35

Must be unique per transaction; no special characters. Used for duplicate checking; rightmost positions assumed low order. First 16 characters appear as Customer Reference. JPM may or may not pass to clearing.

value.currency

Currency of the payment (ISO 4217 alpha-3).

3

3

Fixed value: THB.

value.amount

Positive whole number or decimal. Amount must be greater than 0.01; up to two decimal places.

1

18

≤ 2 decimal places. > 0.01. Max limit: THB 2,000,000.00.

transferType

Indicates the direction of money movement.

1

Must be CREDIT for routing rules.

paymentType

Type of payment being initiated.

3

3

Must be RTP for routing rules.

paymentTypeInformation.localInstrumentCode.proprietary

Proprietary code specifying the local instrument.

5

5

AA = scheme (e.g., PP), B = type (D domestic, C cross-border), CC = transaction (e.g., CT, BP). Always “PPDCT” for domestic transfers.

debtor.account.accountNumber

Debtor account number.

1

35

debtorAgent.financialInstitutionIds[].id

Financial institution identifier (e.g., BIC).

1

8

Must be 8-character BIC: CHASTHBX.

debtorAgent.financialInstitutionIds[].idType

Type of financial institution identifier.

3

3

Must be “BIC”.

creditor.account.alternateAccountIdentifiers.identifier

Alternate account identifier.

15

Based on type: NIDN: 13 digits; MBNO: +66 + 9 digits; EWALLETID: 15 digits (e.g., 123XXXXXXXXXXXX).

creditor.account.alternateAccountIdentifiers.idType

Alternate identifier type for an account.

11

11

Required for Pay to Proxy. Use “PROPRIETARY”. When idType is PROPRIETARY, proprietarySchemeName must be provided.

creditor.account.alternateAccountIdentifiers.proprietarySchemeName

Type of proxy account.

5

9

Required for Pay to Proxy (domestic). Allowed values: NIDN, MBNO, EWALLETID.

paymentPurpose.purpose.proprietary

Purpose of payment (proprietary code).

6

6

Mandatory if using non‑resident accounts for domestic payments (PPDCT) for regulatory reporting (6‑digit purpose code).

paymentPurpose.categoryPurpose.proprietary

Category purpose (proprietary code).

4

Optional for domestic payments. Use “SALA” for salary to mask creditor details in statements/reports.

remittanceInformation.unstructuredInformation.text

Unstructured remittance information.

140 (2 lines)

Optional. Only first 40 characters sent to clearing. Thai characters allowed.

Thailand (PromptPay) additional required fields for electronic withholding tax payments (e-WHT)

Thailand (PromptPay) additional required fields for electronic withholding tax payments (e-WHT)

Field

Description

Minimum

Maximum

Notes

creditor.contactDetails.emailAddress

Email address.

70

Optional (remittance advice to beneficiary). Separate multiple emails with “;”.

taxInformation.type

Tax information type.

1

1

Indicates the beneficiary specific information. Code "1", "2", or "3" is being used: 

  • "1": Tax deduction at source
  • "2": Payroll transaction.
  • "3": One-time payment only 

taxInformation.creditorTaxInformation.taxId

Creditor’s tax ID.

13

13

Payee tax ID

taxInformation.debtorTaxInformation.taxId

Debtor’s tax ID.

13

13

Payer tax ID

taxInformation.taxEntries[].invoicePriorTax

Invoice amount before VAT

1

18

  • Must be >=0.01
  • Max 2 decimal places
  • Array - Can be repeated up to 3 times

taxInformation.taxEntries[].incomeCode

Type of income code (3‑digit numeric).

3

3

Up to 3 entries allowed.

taxInformation.taxEntries[].VATamount

VAT amount

1

18

  • Must be => 0.01
  • Max 2 decimal places
  • Array - Can be repeated up to 3 times

taxInformation.taxEntries[].taxAmount.currency

ISO 4217 Alpha-3 currency code

3

3

  • Fixed value: THB
  • Up to 3 entries allowed.

taxInformation.taxEntries[].taxAmount.amount

Withholding tax amount deducted.

1

18

  • Must be => 0.01
  • Max 2 decimal places

taxInformation.debtorTaxInformation.VATBranchCode

Sender VAT branch code

5

5

Optional for e-WHT payments

taxInformation.creditorTaxInformation.VATBranchCode

Receiver VAT branch code

5

5

Optional for e-WHT payments

Europe, Middle East, and Africa (EMEA)

Single Euro Payments Area (SEPA Instant)


SEPA Instant required fields

SEPA Instant required fields

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

Requested execution date of the payment instruction (e.g., value date).

10

10

  • Field is expected to match ISO date format (YYYY-MM-DD).
    Must be either the current or future date.

paymentIdentifiers.endToEndId

Customer assigned unique identifier to unambiguously identify the payment transaction.

1

35

  • Must be unique for each transaction within the file.
  • No special characters allowed.
  • This value is used for duplicate checking and the rightmost positions are assumed to be low order (and therefore unique).

value.currency

ISO 4217 Alpha-3 Currency Code.

3

3

"EUR"

value.amount

A string representation of a (potentially) whole number or decimal positive number.

1

18

  • Must be >=0.01.
  • Max 2 decimal places.
  • Max Limit: EUR 200,000,000.

transferType

Indicates the direction of the money movement.

6

6

Must be CREDIT.

paymentType

The type of payment being initiated.

3

3

Must be RTP.

debtor.account.accountNumber

This field captures a regular account number.

1

34

Debtor Account IBAN.

debtorAgent.financialInstitutionIds[].id

Financial Institution Identifier.

8

11

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

  • 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 debtor agent’s financial institution ID type.

3

3

"BIC"

creditor.account.accountNumber

This field captures a regular account number.

1

34

Must contain a valid IBAN.

creditor.name

Party name.

1

70

SEPA Instant optional fields

SEPA Instant optional fields

Field

Description

Minimum

Maximum

Notes

debtor.account.accountType

Debtor account type.

1

4

Currently only support IBAN accounts.

debtor.account.accountCurrency

ISO 4217 Alpha-3 Currency Code.

3

3

Currently only supports "EUR".

creditor.account.accountType

The creditor's account type.

4

4

"IBAN"

creditor.postalAddress.type

Type creditor's postal address.

4

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[]

Creditor address lines

1

70

  • Maximum of 2 lines.
  • If postal address is present, then city and country are mandatory.

creditor.postalAddress.buildingNumber

Building number.  

16

If postal address is present, then city and country are mandatory.

creditor.postalAddress.streetName

Street name.

1

70

If postal address is present, then city and country are mandatory.

creditor.postalAddress.postalCode

Postal code.

1

16

If postal address is present, then city and country are mandatory.

creditor.postalAddress.countrySubDivision

ISO 3166-2 Alphanumeric Country Subdivision Code.

1

35

If postal address is present, then city and country are mandatory.

creditor.dateAndPlaceOfBirth.city

City or town name.

1

35

 

creditor.dateAndPlaceOfBirth.country

ISO 3166-1 Alpha-2 Country Code.

2

2

2-character ISO country code.

creditor.dateAndPlaceOfBirth.birthDate

Birth date in YYYY-MM-DD format eg. 1984-05-19.

10

10

  • Format is YYYY-MM-DD.
  • If used then birthDate, cityOfBirth and countryOfBirth must be populated.

creditor.countryOfResidence

ISO 3166-1 Alpha-2 Country Code.

2

2

2-character ISO country code.

creditor.partyId.organizationIds[].organizationId

Formally Issued Organization Identifier.

1

35

Either individualID or organizationID, not both.

creditor.partyId.organizationIds[].issuer

Entity that assigns the identification.

1

35

 

creditor.partyId.organizationIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

3

 

creditor.partyId.individualIds[].individualId

Unique and unambiguous identification of an individual.

1

35

Either individualID or organizationID, not both.

creditor.partyId.individualIds[].issuer

Entity that assigns the identification.

1

35

 

creditor.partyId.individualIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

3

 

creditorAgent.financialInstitutionIds[].id

Financial institution ID.

8

11

Clients are encouraged not to populate in payload, CreditorAgent BIC will be derived from the Creditor IBAN.

additionalParties.ultimateDebtor.partyId.organizationIds[].issuer

Entity that assigns the identification.

1

35

 

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city

City or town name.

1

35

Applicable to TP3 Flows.

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country

ISO 3166-1 Alpha-2 Country Code.

2

2

Applicable to TP3 Flows.
2-character ISO country code.

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate

Birth date in YYYY-MM-DD format eg. 1984-05-19.

10

10

Applicable to TP3 Flows.
Format is YYYY-MM-DD.
If used then birthDate, cityOfBirth and countryOfBirth must be populated.

additionalParties.ultimateDebtor.postalAddress.type

Type of postal address.

4

4

Recommended for TP3 flows.

Values are:

  • "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.buildingNumber

Building number.

1

16

Recommended for TP3 flows.
If postal address is present, then city and country are mandatory.

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

ISO 3166-2 Alphanumeric Country Subdivision Code.

1

35

Recommended for TP3 flows.
If postal address is present, then city and country are mandatory.

additionalParties.ultimateCreditor.partyId.organizationIds[].organizationId

Formally Issued Organization Identifier.

1

35

Either individualID or organizationID, not both.

additionalParties.ultimateCreditor.partyId.organizationIds[].issuer

Entity that assigns the identification.

1

35

 

additionalParties.ultimateCreditor.partyId.organizationIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

3

 

additionalParties.ultimateCreditor.partyId.individualIds[].individualId

Unique and unambiguous identification of an individual.

1

35

Either individualID or organizationID, not both.

additionalParties.ultimateCreditor.partyId.individualIds[].issuer

Entity that assigns the identification.

1

35

 

additionalParties.ultimateCreditor.partyId.individualIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

3

 

additionalParties.ultimateCreditor.name

 

1

70

 

additionalParties.ultimateCreditor.postalAddress.type

Type of postal address.  

4

Values are:

  • "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[]

Ultimate creditor address lines.

 

70

Maximum of 2 lines.
If postal address is present, then city and country is mandatory.

additionalParties.ultimateCreditor.postalAddress.buildingNumber

Building number.

1

35

If postal address is present, then city and country is mandatory.

additionalParties.ultimateCreditor.postalAddress.streetName

Street name.

1

70

If postal address is present, then city and country is mandatory.

additionalParties.ultimateCreditor.postalAddress.postalCode

Postal code.

1

16

If postal address is present, then city and country is mandatory.

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

ISO 3166-2 Alphanumeric Country Subdivision Code.

1

35

If postal address is present, then city and country is mandatory.

paymentPurpose.purpose.code

Purpose of the payment in coded form.

4

4

 

remittanceInformation.unstructuredInformation[].text

Maximum number of lines and characters supported per market/instrument.

1

140

This is to provide other payment details.
Maximum of 1 line.

SEPA Instant conditional fields

SEPA Instant conditional fields

Field

Description

Minimum

Maximum

Notes

creditor.postalAddress.city

 

1

35

Mandatory if postal address is provided.

creditor.postalAddress.country

ISO 3166-1 Alpha-2 Country Code.

2

2

Mandatory if postal address is provided.

creditorAgent.financialInstitutionIds[].idType

 

3

3

Required if previous field is populated. Use "BIC"

additionalParties.ultimateDebtor.partyId.organizationIds[].organizationId

Formally Issued Organization Identifier.

1

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.partyId.organizationIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

3

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

additionalParties.ultimateDebtor.partyId.individualIds[].individualId

Unique and unambiguous identification of an individual.

1

35

Recommended for TP3 flows.
Values are:

  • "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.partyId.individualIds[].schemeName.proprietary

Specifies the type of scheme with a proprietary value.

1

3

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

additionalParties.ultimateDebtor.name

 

1

140

Mandatory for TP3 flows to comply with FTR regulation.

additionalParties.ultimateDebtor.countryOfResidence

ISO 3166-1 Alpha-2 Country Code.

2

2

Mandatory for TP3 flows to be compliant with FTR regulations. 2-character ISO country code

additionalParties.ultimateDebtor.postalAddress.addressLines[]

Ultimate debtor address lines

1

70

Recommended for TP3 flows.
Maximum of 2 lines.
If postal address is present, then city and country are mandatory.

additionalParties.ultimateDebtor.postalAddress.streetName

Street name.

1

70

Recommended for TP3 flows.
If postal address is present, then city and country are mandatory.

additionalParties.ultimateDebtor.postalAddress.city

City.

1

35

Mandatory for TP3 flows to comply with FTR regulation.
Mandatory if postal address is provided.

additionalParties.ultimateDebtor.postalAddress.postalCode

Postal code.

1

16

Recommended for TP3 flows.
If postal address is present, then city and country are mandatory.

additionalParties.ultimateDebtor.postalAddress.country

ISO 3166-1 Alpha-2 Country Code.

2

2

Mandatory for TP3 flows to comply with FTR regulation.
Mandatory if postal address is provided.
2-character ISO country code.

additionalParties.ultimateCreditor.postalAddress.city

City.

1

35

"If postal address is present, then city and country are mandatory."

additionalParties.ultimateCreditor.postalAddress.country

ISO 3166-1 Alpha-2 Country Code.

2

2

If postal address is present, then city and country are mandatory.
2-character ISO country code.

United Kingdom (UK FPS)

UK FPS required fields

UK - FPS

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

Requested execution date.

10

10

Field is expected to match ISO date format (YYYY-MM-DD).
Must be either the current or future date.

paymentIdentifiers.endToEndId

End-to-end transaction identifier.

1

31

Must be unique for each transaction within the file. No special characters allowed.
This value is used for duplicate checking and the rightmost positions are assumed to be low order (and therefore unique).

value.currency

Payment currency.

3

3

GBP

value.amount

Payment amount.

1

18

  • Must be >= 0.01.
  • Max 2 decimal places.
  • Max Limit: GBP 1,000,000

transferType

Transfer type.

6

6

Must be CREDIT.

paymentType

Payment type.

3

3

Must be RTP.

debtor.account.accountNumber

Debtor account number.

8

8

Account numbers with less than 8 digits must be padded with leading zeros.

debtorAgent.financialInstitutionIds[].id

Debtor agent identifier.

8

11

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

  • “CHASGB2L”
  • “CHASGB2LXXX”

debtorAgent.financialInstitutionIds[].idType

Debtor agent identifier type.

3

3

BIC

creditor.account.accountNumber

Creditor account number.

8

8

Account numbers with less than 8 digits must be padded with leading zeros.

creditor.name

Creditor name.

1

40

 

creditorAgent.financialInstitutionIds[].id

Creditor agent identifier.

6

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 (e.g., 1234 → 001234).

creditorAgent.financialInstitutionIds[].idType

Creditor agent identifier type.

9

18

  • Required if previous field is populated
  • “CLEARING_SYSTEM_ID” or “SORT_CODE” are supported.

UK FPS optional fields

UK – RTP Optional

Field

Description

Minimum

Maximum

Notes

debtor.account.accountType

Debtor account type

1

3

Currently only support DDA or VAM account

debtor.account.accountCurrency

Debtor account currency

3

3

Currently only supports “GBP”

creditor.postalAddress.type

Creditor address type

4

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[]

Creditor address lines

1

70

Maximum of 7 lines

creditor.postalAddress.buildingNumber

Creditor building number

1

16

 

creditor.postalAddress.streetName

Creditor street name

1

70

 

creditor.postalAddress.city

Creditor city.

1

35

 

creditor.postalAddress.postalCode

Creditor postal code

1

16

 

creditor.postalAddress.countrySubDivision

Creditor country subdivision.

1

35

 

creditor.postalAddress.country

Creditor country

2

2

2-character ISO country code

creditor.dateAndPlaceOfBirth.city

Creditor city of birth

1

35

 

creditor.dateAndPlaceOfBirth.countrySubDivision

Creditor birth country subdivision

1

35

 

creditor.dateAndPlaceOfBirth.country

Creditor country of birth

2

2

2-character ISO country code

creditor.dateAndPlaceOfBirth.birthDate

Creditor birth date

10

10

  • Format is YYYY-MM-DD.
  • If used then birthDate, cityOfBirth and countryOfBirth must be populated

creditor.countryOfResidence

Creditor country of residence

2

2

2-character ISO country code

creditor.partyId.organizationIds[].organizationId

Creditor organization identifier

1

35

Either individualID or organizationID, not both

creditor.partyId.organizationIds[].issuer

Creditor organization ID issuer

1

35

 

creditor.partyId.organizationIds[].schemeName.proprietary

Creditor organization ID scheme

1

3

 

creditor.partyId.individualIds[].individualId

Creditor individual identifier

1

35

Either individualID or organizationID, not both.

creditor.partyId.individualIds[].issuer

Creditor individual ID issuer

1

35

 

creditor.partyId.individualIds[].schemeName.proprietary

Creditor individual ID scheme

1

3

 

additionalParties.ultimateDebtor.partyId.organizationIds[].issuer

Ultimate debtor organization ID issuer

1

35

 

additionalParties.ultimateDebtor.partyId.organizationIds[].schemeName.proprietary

Ultimate debtor organization ID scheme

1

3

 

additionalParties.ultimateDebtor.partyId.individualIds[].issuer

Ultimate debtor individual ID issuer

1

35

 

additionalParties.ultimateDebtor.partyId.individualIds[].schemeName.proprietary

Ultimate debtor individual ID scheme

3

3

 

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city

Ultimate debtor city of birth

1

35

Applicable to TP3 Flows.

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country

Ultimate debtor country of birth

2

2

  • Applicable to TP3 Flows.
  • 2-character ISO country code.

additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate

Ultimate debtor birth date

10

10

  • Applicable to TP3 Flows.
  • Format is YYYY-MM-DD.
  • If used then birthDate, cityOfBirth and countryOfBirth must be populated.

additionalParties.ultimateDebtor.postalAddress.type

Ultimate debtor address type

4

4

Recommended for TP3 flows.

Values are:

  • “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.buildingNumber

Ultimate debtor building number

1

16

Recommended for TP3 flows

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

Ultimate debtor country subdivision

1

35

Recommended for TP3 flows

additionalParties.ultimateCreditor.partyId.organizationIds[].organizationId

Ultimate creditor organization identifier

1

35

Either individualID or organizationID, not both

additionalParties.ultimateCreditor.partyId.organizationIds[].issuer

Ultimate creditor org ID issuer

1

35

 

additionalParties.ultimateCreditor.partyId.organizationIds[].schemeName.proprietary

Ultimate creditor org ID scheme

1

3

 

additionalParties.ultimateCreditor.partyId.individualIds[].individualId

Ultimate creditor individual identifier

1

35

Either individualID or organizationID, not both

additionalParties.ultimateCreditor.partyId.individualIds[].issuer

Ultimate creditor individual ID issuer

1

35

 

additionalParties.ultimateCreditor.partyId.individualIds[].schemeName.proprietary

Ultimate creditor individual ID scheme

1

3

 

additionalParties.ultimateCreditor.name

Ultimate creditor name

1

40

 

additionalParties.ultimateCreditor.postalAddress.type

Ultimate creditor address type

4

4

Values are:

  • “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[]

Ultimate creditor address lines

1

70

 

additionalParties.ultimateCreditor.postalAddress.buildingNumber

Ultimate creditor building number

1

35

 

additionalParties.ultimateCreditor.postalAddress.streetName

Ultimate creditor street name

1

70

 

additionalParties.ultimateCreditor.postalAddress.city

Ultimate creditor city

1

35

 

additionalParties.ultimateCreditor.postalAddress.postalCode

Ultimate creditor postal code

1

16

 

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

Ultimate creditor country subdivision

1

35

 

additionalParties.ultimateCreditor.postalAddress.country

Ultimate creditor country

2

2

2-character ISO country code

paymentPurpose.purpose.code

Payment purpose code

4

4

 

remittanceInformation.unstructuredInformation[].text

Remittance text

1

140

  • This is to provide other payment details.
  • Maximum of 1 line.
  • The first 18 characters of this field will be passed to the beneficiary bank as the Reference (should be displayed on the beneficiary statement).
    The full length is also passed as Additional Information, but very limited banks display this.
    Combined length of Ultimate Debtor ID, Name and Address fields in combination with content of remittanceInformation cannot exceed 232 characters.

UK FPS conditional fields

UK – RTP conditional fields

Field

Description

Minimum

Maximum

Notes

debtorAgent.additionalInstitutions[].id

Additional institution identifier (debtor agent)

8

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

additionalParties.ultimateDebtor.partyId.organizationIds[].organizationId

Ultimate debtor organization identifier

1

35

Mandatory for TP3 flows (Either Organization Id or Individual Id). The Ultimate Debtor's physical or virtual account number is recommended. Otherwise, if 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.partyId.individualIds[].individualId

Ultimate debtor individual identifier

1

35

Mandatory for TP3 flows (either organization Id or individual Id). The ultimate debtor's physical or virtual account number is recommended. Otherwise, if 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.name

Ultimate debtor name

1

140

Mandatory for TP3 flows to be compliant with FTR regulations.
Combined length of ultimate debtor ID, Name and address fields in combination with content of remittanceInformation cannot exceed 232 characters.

additionalParties.ultimateDebtor.countryOfResidence

Ultimate debtor country of residence

2

2

Mandatory for TP3 flows to be compliant with FTR regulations.
2-character ISO country code

additionalParties.ultimateDebtor.postalAddress.addressLines[]

Ultimate debtor address lines

1

70

Recommended for TP3 flows.
Maximum of 4 lines.
Structured address fields is recommended, but unstructured addressLine fields could be supported

additionalParties.ultimateDebtor.postalAddress.streetName

Ultimate debtor street name

1

70

Mandatory for TP3 flows to comply with FTR regulation

additionalParties.ultimateDebtor.postalAddress.city

Ultimate debtor city

1

35

Mandatory for TP3 flows to be compliant with FTR regulations.

additionalParties.ultimateDebtor.postalAddress.postalCode

Ultimate debtor postal code

1

16

Mandatory for TP3 flows to be compliant with FTR regulations.

additionalParties.ultimateDebtor.postalAddress.country

Ultimate debtor country

2

2

  • Mandatory for TP3 flows to comply with FTR regulation.
  • 2-character ISO country code.

UK FPS Agency Services

Required fields

UK FPS Agency Services Required

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

Requested execution date

10

10

  • Field is expected to match ISO date format (YYYY-MM-DD).
  • Must be either the current or future date.

paymentIdentifiers.endToEndId

End-to-end transaction identifier

1

31

Must be unique for each transaction within the file. No special characters allowed.
This value is used for duplicate checking and the rightmost positions are assumed to be low order (and therefore unique).

value.currency

Payment currency

3

3

GBP

value.amount

Payment amount

1

18

  • Must be >= 0.01.
  • Max 2 decimal places.
  • Max Limit: GBP 1,000,000.

transferType

Transfer type

6

6

Must be CREDIT.

paymentType

Payment type

3

3

Must be RTP.

debtor.name Debtor name. 1 140 This field must contain the ultimate payer's name (C2).
debtorAgent.postalAddress.country Debtor's country. 2 2 Use "GB" for agency services.

debtorAgent.financialInstitutionIds[].id

Debtor agent identifier

6

6

  • Field is expected to have the 6 digits sort code.
  • BIC must not be included.

debtorAgent.financialInstitutionIds[].idType

Debtor agent identifier type

9

9

Mandatory - id and idtype come as a pair. This value will be “SORT_CODE”.

creditor.account.accountNumber

Creditor account number

8

8

Account numbers with less than 8 digits must be padded with leading zeros

creditor.name

Creditor name

1

40

 

creditorAgent.financialInstitutionIds[].id

Creditor agent identifier

6

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 (e.g., 1234 → 001234).

creditorAgent.financialInstitutionIds[].idType

Creditor agent identifier type

9

18

Required if previous field is populated.
“CLEARING_SYSTEM_ID” or “SORT_CODE” are supported

UK FPS Agency Services optional fields

UK Agency Services Optional

Field

Description

Minimum

Maximum

Notes

debtor.account.accountType

Debtor account type

1

3

Currently only support DDA or VAM account

debtor.account.accountCurrency

Debtor account currency

3

3

Currently only supports “GBP”

creditor.postalAddress.type

Creditor address type

4

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[]

Creditor address lines

1

70

Maximum of 7 lines

creditor.postalAddress.buildingNumber

Creditor building number

1

16

 

creditor.postalAddress.streetName

Creditor street name

1

70

 

creditor.postalAddress.city

Creditor city

1

35

 

creditor.postalAddress.postalCode

Creditor postal code

1

16

 

creditor.postalAddress.countrySubDivision

Creditor country subdivision

1

35

 

creditor.postalAddress.country

Creditor country

2

2

2-character ISO country code

creditor.dateAndPlaceOfBirth.city

Creditor city of birth

1

35

 

creditor.dateAndPlaceOfBirth.countrySubDivision

Creditor birth country subdivision

1

35

 

creditor.dateAndPlaceOfBirth.country

Creditor country of birth

2

2

2-character ISO country code

creditor.dateAndPlaceOfBirth.birthDate

Creditor birth date

10

10

Format is YYYY-MM-DD.
If used then birthDate, cityOfBirth and countryOfBirth must be populated

creditor.countryOfResidence

Creditor country of residence

2

2

2-character ISO country code

creditor.partyId.organizationIds[].organizationId

Creditor organization identifier

1

35

Either individualID or organizationID, not both

creditor.partyId.organizationIds[].issuer

Creditor organization ID issuer

1

35

 

creditor.partyId.organizationIds[].schemeName.proprietary

Creditor organization ID scheme

1

3

 

creditor.partyId.individualIds[].individualId

Creditor individual identifier

1

35

Either individualID or organizationID, not both

creditor.partyId.individualIds[].issuer

Creditor individual ID issuer

1

35

 

creditor.partyId.individualIds[].schemeName.proprietary

Creditor individual ID scheme

1

3

 

additionalParties.ultimateCreditor.partyId.organizationIds[].organizationId

Ultimate creditor organization identifier

1

35

Either individualID or organizationID, not both

additionalParties.ultimateCreditor.partyId.organizationIds[].issuer

Ultimate creditor org ID issuer

1

35

 

additionalParties.ultimateCreditor.partyId.organizationIds[].schemeName.proprietary

Ultimate creditor org ID scheme

1

3

 

additionalParties.ultimateCreditor.partyId.individualIds[].individualId

Ultimate creditor individual identifier

1

35

Either individualID or organizationID, not both

additionalParties.ultimateCreditor.partyId.individualIds[].issuer

Ultimate creditor individual ID issuer

1

35

 

additionalParties.ultimateCreditor.partyId.individualIds[].schemeName.proprietary

Ultimate creditor individual ID scheme

1

3

 

additionalParties.ultimateCreditor.name

Ultimate creditor name

1

40

 

additionalParties.ultimateCreditor.postalAddress.type

Ultimate creditor address type

4

4

Values are:

  • “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[]

Ultimate creditor address lines

1

70

 

additionalParties.ultimateCreditor.postalAddress.buildingNumber

Ultimate creditor building number

1

35

 

additionalParties.ultimateCreditor.postalAddress.streetName

Ultimate creditor street name

1

70

 

additionalParties.ultimateCreditor.postalAddress.city

Ultimate creditor city

1

35

 

additionalParties.ultimateCreditor.postalAddress.postalCode

Ultimate creditor postal code

1

16

 

additionalParties.ultimateCreditor.postalAddress.countrySubDivision

Ultimate creditor country subdivision

1

35

 

additionalParties.ultimateCreditor.postalAddress.country

Ultimate creditor country

2

2

2-character ISO country code

paymentPurpose.purpose.code

Payment purpose code

4

4

 

remittanceInformation.unstructuredInformation[].text

Remittance text

1

140

This is to provide other payment details.
Maximum of 1 line.
The first 18 characters of this field will be passed to the beneficiary bank as the Reference (should be displayed on the beneficiary statement).
The full length is also passed as Additional Information, but very limited banks (just a few) display this to their beneficiaries.

Latin America (LATAM)

Brazil (PIX)

Brazil (PIX) Pay to Account required fields

Brazil (PIX) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
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

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • 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 be "Credit" for routing rules.
paymentType Type of payment being initiated.  3 3 Must be "RTP" for routing rules.
debtor.account.accountNumber     34  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "BIC".   11

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

  • "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

Brazil (PIX) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
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

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3
  • 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 be "Credit" for routing rules.
paymentType Type of payment being initiated.  3 3 Must be "RTP" for routing rules.
debtor.account.accountNumber The debtor's account number.   34  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "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. 11 11

Must be PROPRIETARY.

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  

Brazil (PIX) optional fields

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

Currently supports 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.
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.

Chile (TEF)

Chile (TEF) required fields

Chile (TEF) required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date 10 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 for the payment initiation request 1

30

  • Used for duplicate checking
  • Must be unique for each transaction within the file
  • No special characters allowed
  • The characters on the right are treated as low order and must be unique
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code 3 3

Value must be "CLP"

value.amount Enter a positive number as a string, such as '100.00' or '2500' 1 12
  • Must be >= 1
  • Decimals are not supported for CLP currency
  • Max Limit: Approximately 19,500,000 CLP (~500 UF indicator)
transferType The direction of the money movement 6 6 Must be "Credit" for routing rules
paymentType Type of payment being initiated 3 3 Must be "RTP" for routing rules
debtor.account.accountNumber Debtor's account number 1 10  
debtorAgent.financialInstitutionIds[].id The debtor agent's financial institution ID 8 8

Requires 8-digit BIC value: "CHASCLRM"

debtorAgent.financialInstitutionIds[].idType The type of financial institution identifier 3 3 Must be "BIC"
creditor.account.accountNumber Creditor's account number that will be credited 1 20  
creditor.account.accountType Creditor's account type 4 4

Allowed values:

  • "CACC": Current account (locally known as Cuenta Corriente)
  • "TRAN": Demand savings (locally known as Cuenta Vista)
  • "SVGS": Savings account (locally known as Cuenta Ahorro)
creditor.name Alternative identifiers for an account 1 100  
creditorAgent.financialInstitutionIds[].id Local clearing code or Beneficiary bank code 1 11

Must be a 4-digit code starting with "0"

creditorAgent.financialInstitutionIds[].idType The type of financial institution identifier 3 18

Must be "CLEARING_SYSTEM_ID"

creditor.partyId.organizationIds[].organizationId Formally issued organization identifier  1 12
  • Provide creditor tax ID if individual
  • Either "individualId" or "organizationId"
creditor.partyId.organizationIds[].schemeName.code Schema code 4 4

Must be "TXID" to indicate the organization tax ID

creditor.partyId.individualIds[].individualId Individual ID details 1

12

  • Provide creditor tax ID if individual
  • Either "individualId" or "organizationId"
creditor.partyId.individualIds[].schemeName.code Schema name in standardized coded form 4 4 Must be "TXID" to indicate the individual tax ID

Chile (TEF) optional fields

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

Currently supports DDA account

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

3

Currently only supports "CLP"

creditor.postalAddress.type Type of postal address 1 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 1 70 (4 lines)
creditor.postalAddress.buildingNumber Building number 1 16  
creditor.postalAddress.streetName

Street name

1 70  
creditor.postalAddress.city City 1 35  
creditor.postaladdress.postalCode Postal code 1 16  
creditor.postalAddress.countrySubDivision Country subdivision code 1 35  
creditor.postalAddress.country Country 2 2
creditor.countryOfResidence Country of residence 2 2  
creditor.dateAndPlaceOfBirth.city City of birth 1 35  
creditor.dateAndPlaceOfBirth.countrySubDivision Country subdivision code 1 35  
creditor.dateAndPlaceOfBirth.country Country of birth 2 2  
creditor.dateAndPlaceOfBirth.birthDate Date of Birth 2 2  
additionalParties.ultimateDebtor.organizationIds[].organizationId Formally issued organization identifier  1 35  
additionalParties.ultimateDebtor.organizationIds[].issuer Issuer of the identifier 1 35  
additionalParties.ultimateDebtor.individualIds[].individualId Individual ID details 1 35  
additionalParties.ultimateDebtor.individualIds[].issuer Issuer of the identifier 1 35  
additionalParties.ultimateDebtor.Name The ultimate debtor's name 1 140 Recommended for TP3 flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.city City of birth 1 35 Recommended for TP3 flows
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.countrySubDivision Country subdivision 1 35  
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.country Country 2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate Birth date 10

10

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

Recommended for TP3 flows. Allowed values:

  • ADDR
  • BIZZ
  • DLVY
  • HOME
  • MLTO
  • PBOX
additionalParties.ultimateDebtor.postalAddress.addresslines Unstructured addresses 1 70
  • Recommended for TP3 flows
  • Maximum of 7 lines
additionalParties.ultimateDebtor.postalAddress.buildingNumber Building number 1 16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.streetName Street name 1 70 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.city City 1 35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postaladdress.postalCode Postal code 1 16 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.countrySubDivision Country subdivision 1 35 Recommended for TP3 flows
additionalParties.ultimateDebtor.postalAddress.country The ultimate debtor’s country 2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.Name Party name 1 140  
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.city City of birth 1 35 Recommended for TP3 flows
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.country Country of birth 2 2
  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate Date of birth 10

10

  • Recommended for TP3 flows
  • Format is YYYY-MM-DD 
additionalParties.ultimateCreditor.countryOfResidence Country of residence 2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.postalAddress.type Type of postal address 4 4

Recommended for TP3 flows. Allowed values:

  • ADDR
  • BIZZ
  • DLVY
  • HOME
  • MLTO
  • PBOX
additionalParties.ultimateCreditor.postalAddress.addressLines Unstructured addresses 1

70

  • Recommended for TP3 flows
  • Maximum of 7 lines
additionalParties.ultimateCreditor.postalAddress.buildingNumber Building number 1 35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.streetName Street name 1 70 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.city City 1 35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postaladdress.postalCode Postal code 1 16 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.countrySubDivision Country subdivision 1 35 Recommended for TP3 flows
additionalParties.ultimateCreditor.postalAddress.country Country 2

2

  • Recommended for TP3 flows
  • 2-character ISO country code
additionalParties.ultimateCreditor.individualIds[].individualId Individual ID details 1 35

Either "individualId" or "organizationId"

remittanceInformation.unstructuredInformation.text The payment's unstructured remittance information 1 70 Provide additional payment details, such as an invoice number

Mexico (SPEI)

Mexico (SPEI) Pay to Account required fields

Mexico (SPEI) Pay to Account required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
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

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 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 13,000
  • Non-banking days (Saturday and Sunday): MXN 13,000
transferType Indicates the direction of the money movement.      Must be "Credit" for routing rules.
paymentType

Type of payment being initiated.

3 3 Must be "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   16  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "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

Mexico (SPEI) Pay to Proxy required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
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

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 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 13,000
  • Non-banking days (Saturday and Sunday): MXN 13,000
transferType Indicates the direction of the money movement.      Must be "Credit" for routing rules.
paymentType

Type of payment being initiated.

3 3 Must be "RTP" for routing rules.
debtor.account.accountNumber This field captures the debtor's account number.   16  
debtorAgent.financialInstitutionIds[].id The financial institution identifier, for example "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 11 11

Must be PROPRIETARY.

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

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 subdivision   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 subdivision   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 provided 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)

Canada

Interac e-Transfer

The following table contains the required payment parameters to initiate an Interac e-Transfer payment:

Required payment parameters to initiate an Interac e-Transfer payment

Field

Description

Minimum

Maximum

Notes

requestedExecutionDate

The requested execution date.

10

10

  • Must be formatted as YYYY-MM-DD. 
  • The date entered represents the clearing’s time zone, not your local time zone.
  • Can be dated from one day in the past to five days in the future based on the current day and Eastern Time zone.

paymentIdentifiers.endToEndId

The payment’s unique end-to-end ID that's assigned by the sender.

1

35 

value.currency

The value's currency.

3

3

Must be CAD.

value.amount

The value's amount.

1

8

  • Numeric characters only.
  • Maximum of two decimal points.
  • Must be a value from 0.01 to 25000.00.

transferType

The transfer type.

6

6

Must be CREDIT.

paymentType

The payment type.

3

3

Must be RTP.

debtor.account.accountNumber

The debtor's account number.

1

19

 

debtor.name

The debtor's name.

1

30

 

debtorAgent.financialInstitutionIds[].id

The debtor agent's financial institution ID.

8

8

Must be CHASCATT.

debtorAgent.financialInstitutionIds[].idType

The debtor agent's financial institution ID type.

3

3

Must be BIC.

creditor.name

The creditor's name.

1

30

 

creditor.postalAddress.country

The creditor's country.

2

2

Must be CA.

paymentPurpose.purpose.code

The payment's purpose code.

4

4

For supported values, see Purpose codes.

Interac e-Transfer conditional fields 

The following table contains the conditional payment parameters to initiate an Interac e-Transfer payment:

Conditional payment parameters to initiate an Interac e-Transfer payment

Field

Description

Minimum

Maximum

Notes

creditor.account.accountNumber

The creditor's account number.

10

35

  • Must be formatted as aaa-bbbbb-cccccccccccccccccccccccc where aaa is the three-digit bank ID, bbbbb is the five-digit transit number, and cccccccccccccccccccccccc is the account number up to 24 digits.
  • If the account number contains leading zeros, they must be removed.

creditor.account.alternateAccountIdentifiers.identifier

The creditor's alternate account ID.

10

256

RegEx

creditor.account.alternateAccountIdentifiers.proprietarySchemeName

The type of proxy account. 

4

35

  • If account.alternateAccountIdentifiers.[].idType is set to PROPRIETARY, this field is required.
  • Must be EMAL or TELI.

creditor.countryOfResidence

The creditor's country of residence.

2

2

Must be CA.

additionalParties.ultimateDebtor.name

The ultimate debtor's name.

1

140

additionalParties.ultimateDebtor.postalAddress.type

The ultimate debtor's postal address type.

4

4

Must be one of the following:

  • ADDR for a complete postal address
  • BIZZ for a business address
  • DLVY for a DeliveryTo address 
  • HOME for a residential address
  • MLTO for a MailTo address
  • PBOX for a PO box address

additionalParties.ultimateDebtor.postalAddress.buildingNumber

The ultimate debtor's building number.

1

16

additionalParties.ultimateDebtor.postalAddress.streetName

The ultimate debtor's street name.

1

70

additionalParties.ultimateDebtor.postalAddress.countrySubDivision

The ultimate debtor's country subdivision.

0

35

Can't contain special characters.

additionalParties.ultimateDebtor.postalAddress.country

The ultimate debtor's country.

2

2

secureVerification.key

The secure verification key.

1

40

  • The sender can identify the challenge question and response for the beneficiary to authenticate and claim payments.
  • The security question can be sent as clear text, but the response needs to follow a pseudocode.

secureVerification.secret

The secure verification key answer.

1

64

If a security question is provided, the appropriate hashed response must be provided. For example: "key": "what is your policy number?"; "secret": "UrWh9hQ3Ng68IY="

paymentExpiresAt

The payment's expiration date.

24

24

  • If provided, must be from the next calendar day to 30 calendar days from the current date.
  • If not provided, defaults to 30 calendar days from the current date.
  • Must be formatted as YYYY-MM-DDThh:mm:ss+/-time offset to UTC.

Interac e-Transfer optional fields

The following table contains an optional payment parameter to initiate an Interac e-Transfer payment:

Optional payment parameter to initiate an Interac e-Transfer payment

Field

Description

Minimum

Maximum

Notes

creditor.postalAddress.type

The creditor's postal address type.

4

4

Must be one of the following:

  • ADDR for a complete postal address
  • BIZZ for a business address
  • DLVY for a DeliveryTo address 
  • HOME for a residential address
  • MLTO for a MailTo address
  • PBOX for a PO box address

creditor.postalAddress.buildingNumber

The creditor's building number.

1

16

creditor.postalAddress.streetName

The creditor's street name.

1

70

creditor.postaladdress.postalCode

The creditor's postal code.

1

16

creditor.postalAddress.countrySubDivision

The creditor's country subdivision.

1

35

remittanceInformation.unstructuredInformation.text

Unstructured information

1

140

United States (TCH/FedNow)

United States (TCH/FedNow) required fields

United States (TCH/FedNow) required fields
Field Description Minimum Maximum Notes
requestedExecutionDate Requested execution date for the payment instruction, such as the value date.   10
  • Must be in ISO Date format of YYYY-MM-DD.
  • Must be either the current or future date.
  • The date entered represents the clearing’s time zone, not your local time zone.
paymentIdentifiers.endToEndId Customer-assigned unique identifier used to unambiguously identify the payment initiation request. This identifier is passed on, unchanged, throughout the entire end-to-end chain, with the exception of account statements and reports, where characters may be truncated. 1

35

  • Used for duplicate checking. 
  • Must be unique for each transaction within the file. No special characters allowed.
  • The characters on the right are treated as low order and must be unique.
value.currency Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. 3 3 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 be "Credit" for routing rules.
paymentType

Type of payment being initiated. 

  3 Must be "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, such as "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

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 subdivision

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

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.

Field details for client-initiated returns

This page provides the necessary fields for starting a client-initiated returns request. To start a return, all required fields must be included. While conditional and optional fields offer additional functionality, they are not essential for a basic return request.

Field details for client initiated returns

Field

Description

Minimum

Maximum

Notes

paymentType

Type of payment being initiated.

3

3

Must be RTP.

originalPaymentIdentifiers.bankReferenceNumber

Bank reference number of the original incoming payment.

1

12

  • A unique identifier generated by JPMC for each payment.
  • Either of the parameters from originalPaymentIdentifiers must be populated.

originalPaymentIdentifiers.clearingSystemReference

Clearing system reference number assigned to the original incoming payment.

1

50

  • Either of the parameters from originalPaymentIdentifiers must be populated.
  • This field is not supported for Brazil RTP and India UPI.

originalPaymentIdentifiers.paymentId

paymentId of the original incoming payment. 

1

128

Either of the parameters from originalPaymentIdentifiers must be populated.

originalPaymentIdentifiers.endToEndId

endToEndId of the original incoming payment.

1

35

Either of the original payment reference numbers must be populated. This field is not supported for India UPI.

originalPaymentIdentifiers.originalValue.currency

Currency of the original incoming payment, based on ISO 4217 Alpha-3 currency code.

3

3

This is mandatory if originalPaymentIdentifiers.endToEndId is provided.

originalPaymentIdentifiers.originalValue.amount

Amount of the original incoming payment.

0.01

18

This is mandatory if originalPaymentIdentifiers.endToEndId is provided.

originalPaymentIdentifiers.valueDate

Value date of the original incoming payment

1

10

  • This is mandatory if originalPaymentIdentifiers.endToEndId is provided.
  • Must be in ISO date format of YYYY-MM-DD.

paymentIdentifiers.endToEndId

Customer-assigned unique identifier to unambiguously identify the payment return 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. 

country

ISO country code

2

2

Specify the market from which the request originates.

chargeBearer

 Party bearing the transaction fees.

   



Allowed values are CREDITOR, DEBTOR, and SHARED.

returnType

Indicates whether the return is a full or partial return.
FULL: Returns the entire original amount.

PARTIAL: Returns only a portion of the original payment amount.

   
  • If the returnType is not specified, this will automatically be processed as a FULL return.
  • Allowed values are FULL and PARTIAL.

value.amount

Amount of the return payment. This should be Partial or Full amount but cannot be more than the original amount.

0.01

18

  • Field is expected to have no more than two decimal places.
  • Field is expected to be above 0.01.
  • Specify the return amount to be paid back to the originator. This is mandatory in case of partial return.

value.currency

Currency of the return payment, based on ISO 4217 Alpha-3 currency code.

3

3

  • If this is not provided, the original incoming payment currency will be taken.
  • Currency of the payment, based on ISO 4217 Alpha-3 currency code. 

reason.code

Reason for the return in coded format.

4

4

Captures the reason for the return in coded format.

reason.proprietary

Reason for the return in proprietary format.

1

35

Captures the reason for the return in proprietary format.

additionalInformation

Additional information about the return.

1

105

 

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

Next steps

Learn more about available resources.