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.
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)
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
The requested execution date. | 10 |
10 |
|
|
The payment's unique end-to-end ID that's assigned by the originator. |
1 |
35 |
|
|
The currency of |
3 |
3 |
Fixed value: "AUD" |
|
The value’s amount. |
1 |
18 |
|
|
The transfer type. |
6 |
6 |
Must be CREDIT. |
|
The payment type. |
3 |
3 |
Must be RTP. |
|
The debtor’s account number. |
1 |
35 |
|
|
The debtor agent’s financial institution ID. |
8 |
8 |
Field is expected to have this BIC value: CHASAU2X |
|
The debtor agent’s financial institution ID type. |
3 |
3 |
"BIC" |
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 |
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 | Fixed value: |
value.amount |
A string representation of a (potentially) whole number or decimal positive number. Amount should be more than 0.01 with maximum of two decimal places allowed in most markets. | 0.01 | 18 |
|
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 |
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 |
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 | Fixed value: |
value.amount |
A string representation of a (potentially) whole number or decimal positive number. Amount should be more than 0.01 with maximum of two decimal places allowed in most markets. | 0.01 | 18 |
|
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:
|
|
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
| 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:
|
|
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:
|
|
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 |
|
|
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:
|
|
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
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 | Field must match |
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 |
|
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 |
|
|
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 |
|
|
paymentPurpose.categoryPurpose.proprietary |
Specifies the type of scheme with a proprietary code. | 4 | Values include:
Refer to Payments Developer Portal for list of purpose/category codes. |
Hong Kong (FPS) Pay to Proxy required fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 | Field is expected to match |
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 |
|
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:
|
|
paymentPurpose.categoryPurpose.proprietary |
Specifies the type of scheme with a proprietary code. | 4 | Values include:
Refer to Payments Developer Portal for list of purpose/category codes. |
Hong Kong (FPS) optional fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 3 | 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:
|
|
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 |
|
|
creditor.countryOfResidence |
Country of residence | 2 |
|
|
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 |
|
|
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate |
Birth date | 10 |
|
|
additionalParties.ultimateDebtor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateDebtor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows. Values include:
|
|
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 |
|
|
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 |
|
|
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate |
Date of birth | 10 |
|
|
additionalParties.ultimateCreditor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateCreditor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows. Values include:
|
|
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 |
|
|
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
Field |
Description |
Minimum | Maximum | Notes |
|---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
|
|
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 |
|
|
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. |
3 |
3 |
Fixed value: INR |
|
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 |
|
The transfer type. |
6 |
6 |
Must be |
|
The payment type. |
3 |
3 |
Must be |
|
The financial institution identifier of the debtor. |
8 |
8 |
Field must have a 8 BIC value: |
|
The debtor agent’s financial institution ID type. |
3 |
3 |
Must be |
|
The creditor’s account number. |
1 |
34 |
This field is used to provide the regular account ID for Pay by Account instructions only. |
|
The creditor's account type. |
4 |
4 |
Allowed Values:
|
|
The creditor’s name. |
1 |
140 |
|
|
The creditor agent’s financial institution ID. |
11 |
11 |
11 character IFSC Code is mandatory for Pay to Account Example: BKID0002743:
|
|
The creditor agent's financial institution ID type. |
18 |
18 |
Use |
India (IMPS) optional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Type of account associated with the debtor. |
1 |
3 |
Currently support only DDA account. |
|
The debtor's account currency. |
3 |
3 |
|
|
Creditor's country subdivision code. |
2 |
2 |
|
|
Creditor's country of residence. |
2 |
2 |
|
|
Creditor's formally issued organization identifier. |
1 |
35 |
Either |
|
Creditor's party name. |
1 |
120 |
|
|
Creditor's city of birth. |
1 |
35 |
Recommended for TP3 flows |
|
Creditor's country of birth. |
2 |
2 |
|
|
Creditor's date of birth. |
10 |
10 |
|
|
Creditor's postal address type. |
4 |
4 |
Recommended for TP3 flows. Values are:
|
|
Creditor's unstructured addresses. |
1 |
70 |
|
|
Creditor's building number. |
1 |
35 |
Recommended for TP3 flows. |
|
Creditor's street name. |
1 |
70 |
Recommended for TP3 flows. |
|
Creditor's city. |
1 |
35 |
Recommended for TP3 flows. |
|
Creditor's postal code. |
1 |
16 |
Recommended for TP3 flows. |
|
Creditor's country sub division. |
1 |
35 |
Recommended for TP3 flows. |
|
Creditor's country. |
2 |
2 |
|
|
Individual identifier details. |
1 |
35 |
Either |
|
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. |
|
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
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
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 |
|
|
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 |
|
|
ISO 4217 Alpha-3 Currency Code |
3 |
3 |
"INR" |
|
A string representation of a (potentially) whole number or decimal positive number. |
1 |
18 |
|
|
Indicates the direction of the money movement. |
6 |
6 |
Must be CREDIT. |
|
The type of payment being initiated |
3 |
3 |
Must be RTP. |
|
This field captures a regular account number. |
1 |
34 |
NREH's account with JPM India |
|
Financial Institution Identifier |
8 |
8 |
Field is expected to have this BIC value: CHASINBX |
|
3 |
3 |
"BIC" |
|
|
This field captures a regular account number. |
1 |
34 |
|
|
4 |
4 |
Allowed Values: "CACC" - CURRENT
|
|
|
Party name |
1 |
140 |
Mandatory for Pay to Account. Currently supports Pay by Account only. |
|
1 |
70 |
||
|
1 |
16 |
||
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
2-character ISO country code. |
|
SWIFT IC. |
11 |
11 |
|
|
18 |
18 |
Use "CLEARING_SYSTEM_ID" |
|
|
Formally Issued Organization Identifier |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value |
1 |
35 |
|
|
Unique and unambiguous identification of an individual |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value. |
1 |
35 |
|
|
Name. |
1 |
140 |
|
|
Ultimate debtor address lines. |
1 |
70 |
Maximum of 7 lines |
|
City. |
1 |
35 |
|
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
2 character ISO code |
India (RDA)
Optional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Account type. |
1 |
3 |
Currently only support "DDA" |
|
ISO 4217 Alpha-3 Currency Code |
3 |
3 |
"INR" |
|
Postal address. |
4 |
4 |
Values are:
|
|
Building number. |
1 |
16 |
|
|
Street Name |
1 |
70 |
|
|
City. |
1 |
35 |
|
|
ISO 3166-2 Alphanumeric Country Subdivision Code |
1 |
35 |
|
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
|
|
City or town name |
1 |
35 |
|
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
2-character ISO country code |
|
Birth date in YYYY-MM-DD format eg. 1984-05-19. |
10 |
10 |
Format is YYYY-MM-DD |
|
Formally Issued Organization Identifier |
1 |
35 |
1st instance to be Tax ID / GST number of the bene if its an entity |
|
Entity that assigns the identification |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value |
1 |
35 |
1st instance populate with "GST" |
|
Unique and unambiguous identification of an individual |
1 |
35 |
Tax ID / GST number of the individual if available, else Blank |
|
Entity that assigns the identification |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value. |
1 |
35 |
Populate with "GST" in case GST number available, else blank |
|
Entity that assigns the identification |
1 |
35 |
|
|
Entity that assigns the identification |
1 |
35 |
|
|
City or town name |
1 |
35 |
|
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
2-character ISO country code |
|
Birth date in YYYY-MM-DD format eg. 1984-05-19. |
10 |
10 |
Format is YYYY-MM-DD |
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
2-character ISO country code |
|
Postal address type. | 4 |
Recommended for TP3 flows
|
|
|
Building number. | 16 |
||
|
Street name. |
1 |
70 |
|
|
1 |
16 |
||
|
ISO 3166-2 Alphanumeric Country Subdivision Code |
1 |
35 |
|
|
1 |
120 |
||
|
Type of postal address. |
4 |
4 |
Recommended for TP3 flows
|
|
Ultimate creditor address lines. |
1 |
70 |
Maximum of 7 lines |
|
Building number. |
1 |
35 |
|
|
Street name. |
1 |
70 |
|
|
City. |
1 |
35 |
|
|
Postal code. |
1 |
16 |
|
|
ISO 3166-2 Alphanumeric Country Subdivision Code |
1 |
35 |
|
|
ISO 3166-1 Alpha-2 Country Code |
2 |
2 |
|
|
Maximum number of lines and characters supported per market/instrument |
1 |
50 |
|
Malaysia (RPP)
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 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
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 |
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
remittanceInformation.structuredInformation[].creditReference.reference |
Unique reference to unambiguously refer to the payment transaction. | 140 |
Malaysia (RPP) Pay to Proxy required fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
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 |
|
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 |
|
|
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 |
|
|
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:
|
|
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 |
|
|
remittanceInformation.structuredInformation[].creditReference.reference |
Unique reference to unambiguously refer to the payment transaction. | 140 |
Malaysia (RPP) optional fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 3 | Currently 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:
|
|
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 |
|
|
creditor.countryOfResidence |
Country of residence | 2 |
|
|
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 |
|
|
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate |
Birth date | 10 |
|
|
additionalParties.ultimateDebtor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateDebtor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
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 |
|
|
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate |
Date of birth | 10 |
|
|
additionalParties.ultimateCreditor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateCreditor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
additionalParties.ultimateCreditor.individualIds[].individualId |
Individual id details | 35 | Either individualID or organizationID, not both | |
paymentPurpose.purpose.type |
Purpose type | 11 | "PROPRIETARY" Required if either the debtor or creditor country of residency is not Malaysia |
|
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (2 lines) | This is to provide other payment details. | |
remittanceInformation.structuredInformation[].additionalRemittanceInformation |
Additional remittance information | 140 |
|
Singapore (FAST)
Singapore (FAST) Pay to Account required fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
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 |
|
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 |
|
|
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
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
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 |
|
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:
|
|
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
| 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:
|
|
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 |
|
|
creditor.countryOfResidence |
Country of residence | 2 |
|
|
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 |
|
|
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate |
Birth date | 10 |
|
|
additionalParties.ultimateDebtor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateDebtor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows. Values include:
|
|
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 |
|
|
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 |
|
|
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate |
Date of birth | 10 |
|
|
additionalParties.ultimateCreditor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateCreditor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
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
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Enter the requested execution date in YYYY-MM-DD format. Use today’s date or a future date. |
1 |
10 |
|
|
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 |
|
|
Currency of the payment (ISO 4217 alpha-3). |
3 |
3 |
Fixed value: THB. |
|
Positive whole number or decimal. Amount must be greater than 0.01; up to two decimal places. |
1 |
18 |
|
|
Indicates the direction of money movement. |
1 |
Must be CREDIT for routing rules. |
|
|
Type of payment being initiated. |
3 |
3 |
Must be RTP for routing rules. |
|
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 number. |
1 |
35 |
|
|
Financial institution identifier (e.g., BIC). |
1 |
8 |
Must be 8-character BIC: CHASTHBX. |
|
Type of financial institution identifier. |
3 |
3 |
Must be “BIC”. |
|
Regular account number. |
1 |
35 |
Provide for Pay to Account. Do not populate for Pay to Proxy. |
|
Party name. |
1 |
140 |
Mandatory for Pay to Account. |
|
Financial institution identifier (e.g., bank code). |
3 |
3 |
Mandatory for Pay to Account. 3‑digit bank code. |
|
Type of financial institution identifier. |
18 |
Must be “CLEARING_SYSTEM_ID”. |
|
|
Purpose of payment (proprietary code). |
6 |
Mandatory if using non‑resident accounts for domestic payments (PPDCT) for regulatory reporting (6‑digit purpose code). |
|
|
Category purpose (proprietary code). |
4 |
Optional for domestic payments. Use “SALA” for salary to mask creditor details in statements/reports. |
|
|
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
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
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. |
|
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. |
|
Currency of the payment (ISO 4217 alpha-3). |
3 |
3 |
Fixed value: THB. |
|
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. |
|
Indicates the direction of money movement. |
1 |
Must be CREDIT for routing rules. |
|
|
Type of payment being initiated. |
3 |
3 |
Must be RTP for routing rules. |
|
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 number. |
1 |
35 |
|
|
Financial institution identifier (e.g., BIC). |
1 |
8 |
Must be 8-character BIC: CHASTHBX. |
|
Type of financial institution identifier. |
3 |
3 |
Must be “BIC”. |
|
Alternate account identifier. |
15 |
Based on type: NIDN: 13 digits; MBNO: +66 + 9 digits; EWALLETID: 15 digits (e.g., 123XXXXXXXXXXXX). |
|
|
Alternate identifier type for an account. |
11 |
11 |
Required for Pay to Proxy. Use “PROPRIETARY”. When idType is PROPRIETARY, proprietarySchemeName must be provided. |
|
Type of proxy account. |
5 |
9 |
Required for Pay to Proxy (domestic). Allowed values: NIDN, MBNO, EWALLETID. |
|
Purpose of payment (proprietary code). |
6 |
6 |
Mandatory if using non‑resident accounts for domestic payments (PPDCT) for regulatory reporting (6‑digit purpose code). |
|
Category purpose (proprietary code). |
4 |
Optional for domestic payments. Use “SALA” for salary to mask creditor details in statements/reports. |
|
|
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)
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Email address. |
70 |
Optional (remittance advice to beneficiary). Separate multiple emails with “;”. |
|
|
Tax information type. |
1 |
1 |
Indicates the beneficiary specific information. Code "1", "2", or "3" is being used:
|
|
Creditor’s tax ID. |
13 |
13 |
Payee tax ID |
|
Debtor’s tax ID. |
13 |
13 |
Payer tax ID |
|
Invoice amount before VAT |
1 |
18 |
|
|
Type of income code (3‑digit numeric). |
3 |
3 |
Up to 3 entries allowed. |
|
VAT amount |
1 |
18 |
|
|
ISO 4217 Alpha-3 currency code |
3 |
3 |
|
|
Withholding tax amount deducted. |
1 |
18 |
|
|
Sender VAT branch code |
5 |
5 |
Optional for e-WHT payments |
|
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
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Requested execution date of the payment instruction (e.g., value date). |
10 |
10 |
|
|
Customer assigned unique identifier to unambiguously identify the payment transaction. |
1 |
35 |
|
|
ISO 4217 Alpha-3 Currency Code. |
3 |
3 |
"EUR" |
|
A string representation of a (potentially) whole number or decimal positive number. |
1 |
18 |
|
|
Indicates the direction of the money movement. |
6 |
6 |
Must be CREDIT. |
|
The type of payment being initiated. |
3 |
3 |
Must be RTP. |
|
This field captures a regular account number. |
1 |
34 |
Debtor Account IBAN. |
|
Financial Institution Identifier. |
8 |
11 |
Field is expected to have one of these 8 or 11 BIC values below:
|
|
The debtor agent’s financial institution ID type. | 3 |
3 |
"BIC" |
|
This field captures a regular account number. |
1 |
34 |
Must contain a valid IBAN. |
|
Party name. |
1 |
70 |
SEPA Instant optional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Debtor account type. | 1 |
4 |
Currently only support IBAN accounts. |
|
ISO 4217 Alpha-3 Currency Code. |
3 |
3 |
Currently only supports "EUR". |
|
The creditor's account type. | 4 |
4 |
"IBAN" |
|
Type creditor's postal address. | 4 |
4 |
Values include:
|
|
Creditor address lines | 1 |
70 |
|
|
Building number. | 16 |
If postal address is present, then city and country are mandatory. |
|
|
Street name. | 1 |
70 |
If postal address is present, then city and country are mandatory. |
|
Postal code. | 1 |
16 |
If postal address is present, then city and country are mandatory. |
|
ISO 3166-2 Alphanumeric Country Subdivision Code. |
1 |
35 |
If postal address is present, then city and country are mandatory. |
|
City or town name. |
1 |
35 |
|
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
2-character ISO country code. |
|
Birth date in YYYY-MM-DD format eg. 1984-05-19. |
10 |
10 |
|
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
2-character ISO country code. |
|
Formally Issued Organization Identifier. |
1 |
35 |
Either individualID or organizationID, not both. |
|
Entity that assigns the identification. |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value. |
1 |
3 |
|
|
Unique and unambiguous identification of an individual. |
1 |
35 |
Either |
|
Entity that assigns the identification. |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value. |
1 |
3 |
|
|
Financial institution ID. | 8 |
11 |
Clients are encouraged not to populate in payload, |
|
Entity that assigns the identification. |
1 |
35 |
|
|
City or town name. |
1 |
35 |
Applicable to TP3 Flows. |
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
Applicable to TP3 Flows. |
|
Birth date in YYYY-MM-DD format eg. 1984-05-19. |
10 |
10 |
Applicable to TP3 Flows. |
|
Type of postal address. | 4 |
4 |
Recommended for TP3 flows. Values are:
|
|
Building number. | 1 |
16 |
Recommended for TP3 flows. |
|
ISO 3166-2 Alphanumeric Country Subdivision Code. |
1 |
35 |
Recommended for TP3 flows. |
|
Formally Issued Organization Identifier. |
1 |
35 |
Either individualID or organizationID, not both. |
|
Entity that assigns the identification. |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value. |
1 |
3 |
|
|
Unique and unambiguous identification of an individual. |
1 |
35 |
Either |
|
Entity that assigns the identification. |
1 |
35 |
|
|
Specifies the type of scheme with a proprietary value. |
1 |
3 |
|
|
1 |
70 |
||
|
Type of postal address. | 4 |
Values are:
|
|
|
Ultimate creditor address lines. |
70 |
Maximum of 2 lines. |
|
|
Building number. | 1 |
35 |
If postal address is present, then city and country is mandatory. |
|
Street name. | 1 |
70 |
If postal address is present, then city and country is mandatory. |
|
Postal code. | 1 |
16 |
If postal address is present, then city and country is mandatory. |
|
ISO 3166-2 Alphanumeric Country Subdivision Code. |
1 |
35 |
If postal address is present, then city and country is mandatory. |
|
Purpose of the payment in coded form. |
4 |
4 |
|
|
Maximum number of lines and characters supported per market/instrument. |
1 |
140 |
This is to provide other payment details. |
SEPA Instant conditional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
1 |
35 |
Mandatory if postal address is provided. |
|
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
Mandatory if postal address is provided. |
|
3 |
3 |
Required if previous field is populated. Use "BIC" |
|
|
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. |
|
Specifies the type of scheme with a proprietary value. |
1 |
3 |
"BIC", "LEI", or "ID" |
|
Unique and unambiguous identification of an individual. |
1 |
35 |
Recommended for TP3 flows.
|
|
Specifies the type of scheme with a proprietary value. |
1 |
3 |
"BIC", "LEI", or "ID" |
|
1 |
140 |
Mandatory for TP3 flows to comply with FTR regulation. |
|
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
Mandatory for TP3 flows to be compliant with FTR regulations. 2-character ISO country code |
|
Ultimate debtor address lines | 1 |
70 |
Recommended for TP3 flows. |
|
Street name. | 1 |
70 |
Recommended for TP3 flows. |
|
City. | 1 |
35 |
Mandatory for TP3 flows to comply with FTR regulation. |
|
Postal code. | 1 |
16 |
Recommended for TP3 flows. |
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
Mandatory for TP3 flows to comply with FTR regulation. |
|
City. | 1 |
35 |
"If postal address is present, then city and country are mandatory." |
|
ISO 3166-1 Alpha-2 Country Code. |
2 |
2 |
If postal address is present, then city and country are mandatory. |
United Kingdom (UK FPS)
UK FPS required fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Requested execution date. |
10 |
10 |
Field is expected to match ISO date format (YYYY-MM-DD). |
|
End-to-end transaction identifier. |
1 |
31 |
Must be unique for each transaction within the file. No special characters allowed. |
|
Payment currency. |
3 |
3 |
GBP |
|
Payment amount. |
1 |
18 |
|
|
Transfer type. |
6 |
6 |
Must be CREDIT. |
|
Payment type. |
3 |
3 |
Must be RTP. |
|
Debtor account number. |
8 |
8 |
Account numbers with less than 8 digits must be padded with leading zeros. |
|
Debtor agent identifier. |
8 |
11 |
Field is expected to have one of these 8 or 11 BIC values:
|
|
Debtor agent identifier type. |
3 |
3 |
BIC |
|
Creditor account number. |
8 |
8 |
Account numbers with less than 8 digits must be padded with leading zeros. |
|
Creditor name. |
1 |
40 |
|
|
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). |
|
Creditor agent identifier type. |
9 |
18 |
|
UK FPS optional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Debtor account type |
1 |
3 |
Currently only support DDA or VAM account |
|
Debtor account currency |
3 |
3 |
Currently only supports “GBP” |
|
Creditor address type |
4 |
4 |
|
|
Creditor address lines |
1 |
70 |
Maximum of 7 lines |
|
Creditor building number |
1 |
16 |
|
|
Creditor street name |
1 |
70 |
|
|
Creditor city. |
1 |
35 |
|
|
Creditor postal code |
1 |
16 |
|
|
Creditor country subdivision. |
1 |
35 |
|
|
Creditor country |
2 |
2 |
2-character ISO country code |
|
Creditor city of birth |
1 |
35 |
|
|
Creditor birth country subdivision |
1 |
35 |
|
|
Creditor country of birth |
2 |
2 |
2-character ISO country code |
|
Creditor birth date |
10 |
10 |
|
|
Creditor country of residence |
2 |
2 |
2-character ISO country code |
|
Creditor organization identifier |
1 |
35 |
Either |
|
Creditor organization ID issuer |
1 |
35 |
|
|
Creditor organization ID scheme |
1 |
3 |
|
|
Creditor individual identifier |
1 |
35 |
Either |
|
Creditor individual ID issuer |
1 |
35 |
|
|
Creditor individual ID scheme |
1 |
3 |
|
|
Ultimate debtor organization ID issuer |
1 |
35 |
|
|
Ultimate debtor organization ID scheme |
1 |
3 |
|
|
Ultimate debtor individual ID issuer |
1 |
35 |
|
|
Ultimate debtor individual ID scheme |
3 |
3 |
|
|
Ultimate debtor city of birth |
1 |
35 |
Applicable to TP3 Flows. |
|
Ultimate debtor country of birth |
2 |
2 |
|
|
Ultimate debtor birth date |
10 |
10 |
|
|
Ultimate debtor address type |
4 |
4 |
Recommended for TP3 flows. Values are:
|
|
Ultimate debtor building number |
1 |
16 |
Recommended for TP3 flows |
|
Ultimate debtor country subdivision |
1 |
35 |
Recommended for TP3 flows |
|
Ultimate creditor organization identifier |
1 |
35 |
Either |
|
Ultimate creditor org ID issuer |
1 |
35 |
|
|
Ultimate creditor org ID scheme |
1 |
3 |
|
|
Ultimate creditor individual identifier |
1 |
35 |
Either |
|
Ultimate creditor individual ID issuer |
1 |
35 |
|
|
Ultimate creditor individual ID scheme |
1 |
3 |
|
|
Ultimate creditor name |
1 |
40 |
|
|
Ultimate creditor address type |
4 |
4 |
Values are:
|
|
Ultimate creditor address lines |
1 |
70 |
|
|
Ultimate creditor building number |
1 |
35 |
|
|
Ultimate creditor street name |
1 |
70 |
|
|
Ultimate creditor city |
1 |
35 |
|
|
Ultimate creditor postal code |
1 |
16 |
|
|
Ultimate creditor country subdivision |
1 |
35 |
|
|
Ultimate creditor country |
2 |
2 |
2-character ISO country code |
|
Payment purpose code |
4 |
4 |
|
|
Remittance text |
1 |
140 |
|
UK FPS conditional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
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 |
|
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. |
|
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. |
|
Ultimate debtor name |
1 |
140 |
Mandatory for TP3 flows to be compliant with FTR regulations. |
|
Ultimate debtor country of residence |
2 |
2 |
Mandatory for TP3 flows to be compliant with FTR regulations. |
|
Ultimate debtor address lines |
1 |
70 |
Recommended for TP3 flows. |
|
Ultimate debtor street name |
1 |
70 |
Mandatory for TP3 flows to comply with FTR regulation |
|
Ultimate debtor city |
1 |
35 |
Mandatory for TP3 flows to be compliant with FTR regulations. |
|
Ultimate debtor postal code |
1 |
16 |
Mandatory for TP3 flows to be compliant with FTR regulations. |
|
Ultimate debtor country |
2 |
2 |
|
UK FPS Agency Services
Required fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Requested execution date |
10 |
10 |
|
|
End-to-end transaction identifier |
1 |
31 |
Must be unique for each transaction within the file. No special characters allowed. |
|
Payment currency |
3 |
3 |
GBP |
|
Payment amount |
1 |
18 |
|
|
Transfer type |
6 |
6 |
Must be CREDIT. |
|
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. |
|
Debtor agent identifier |
6 |
6 |
|
|
Debtor agent identifier type |
9 |
9 |
Mandatory - |
|
Creditor account number |
8 |
8 |
Account numbers with less than 8 digits must be padded with leading zeros |
|
Creditor name |
1 |
40 |
|
|
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). |
|
Creditor agent identifier type |
9 |
18 |
Required if previous field is populated. |
UK FPS Agency Services optional fields
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Debtor account type |
1 |
3 |
Currently only support DDA or VAM account |
|
Debtor account currency |
3 |
3 |
Currently only supports “GBP” |
|
Creditor address type |
4 |
4 |
Values include:
|
|
Creditor address lines |
1 |
70 |
Maximum of 7 lines |
|
Creditor building number |
1 |
16 |
|
|
Creditor street name |
1 |
70 |
|
|
Creditor city |
1 |
35 |
|
|
Creditor postal code |
1 |
16 |
|
|
Creditor country subdivision |
1 |
35 |
|
|
Creditor country |
2 |
2 |
2-character ISO country code |
|
Creditor city of birth |
1 |
35 |
|
|
Creditor birth country subdivision |
1 |
35 |
|
|
Creditor country of birth |
2 |
2 |
2-character ISO country code |
|
Creditor birth date |
10 |
10 |
Format is YYYY-MM-DD. |
|
Creditor country of residence |
2 |
2 |
2-character ISO country code |
|
Creditor organization identifier |
1 |
35 |
Either |
|
Creditor organization ID issuer |
1 |
35 |
|
|
Creditor organization ID scheme |
1 |
3 |
|
|
Creditor individual identifier |
1 |
35 |
Either |
|
Creditor individual ID issuer |
1 |
35 |
|
|
Creditor individual ID scheme |
1 |
3 |
|
|
Ultimate creditor organization identifier |
1 |
35 |
Either |
|
Ultimate creditor org ID issuer |
1 |
35 |
|
|
Ultimate creditor org ID scheme |
1 |
3 |
|
|
Ultimate creditor individual identifier |
1 |
35 |
Either |
|
Ultimate creditor individual ID issuer |
1 |
35 |
|
|
Ultimate creditor individual ID scheme |
1 |
3 |
|
|
Ultimate creditor name |
1 |
40 |
|
|
Ultimate creditor address type |
4 |
4 |
Values are:
|
|
Ultimate creditor address lines |
1 |
70 |
|
|
Ultimate creditor building number |
1 |
35 |
|
|
Ultimate creditor street name |
1 |
70 |
|
|
Ultimate creditor city |
1 |
35 |
|
|
Ultimate creditor postal code |
1 |
16 |
|
|
Ultimate creditor country subdivision |
1 |
35 |
|
|
Ultimate creditor country |
2 |
2 |
2-character ISO country code |
|
Payment purpose code |
4 |
4 |
|
|
Remittance text |
1 |
140 |
This is to provide other payment details. |
Latin America (LATAM)
Brazil (PIX)
Brazil (PIX) Pay to Account required fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
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 |
|
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:
|
|
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:
|
|
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 |
|
|
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 18 |
|
|
creditorAgent.financialInstitutionIds[].branchNumber |
Branch of the bank or financial institution. NA for Japan |
|
||
taxInformation.creditorTaxInformation.taxId |
Tax identifier | 35 | ||
taxInformation.creditorTaxInformation.taxPayerCategory |
Tax payer category. If category = INDIVIDUAL map here |
|
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 |
|
|
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 |
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
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 |
|
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:
|
|
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:
|
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:
|
|
creditor.name |
One or more values that can be used as alternative identifiers for an account. | 140 |
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:
|
|
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 |
|
|
creditor.countryOfResidence |
Country of residence | 2 |
|
|
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 |
|
Chile (TEF)
Chile (TEF) required fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date | 10 | 10 |
|
paymentIdentifiers.endToEndId |
Customer-assigned unique identifier for the payment initiation request | 1 | 30 |
|
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 |
|
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:
|
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 |
|
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 |
|
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
| 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:
|
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 |
|
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate |
Birth date | 10 | 10 |
|
additionalParties.ultimateDebtor.countryOfResidence |
Country of residence | 2 | 2 |
|
additionalParties.ultimateDebtor.postalAddress.type |
Type of postal address | 4 | 4 | Recommended for TP3 flows. Allowed values:
|
additionalParties.ultimateDebtor.postalAddress.addresslines |
Unstructured addresses | 1 | 70 |
|
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 |
|
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 |
|
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate |
Date of birth | 10 | 10 |
|
additionalParties.ultimateCreditor.countryOfResidence |
Country of residence | 2 | 2 |
|
additionalParties.ultimateCreditor.postalAddress.type |
Type of postal address | 4 | 4 | Recommended for TP3 flows. Allowed values:
|
additionalParties.ultimateCreditor.postalAddress.addressLines |
Unstructured addresses | 1 | 70 |
|
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 |
|
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
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
requestedExecutionDate |
Requested execution date for the payment instruction, such as the value date. | 10 |
|
|
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 |
|
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 |
|
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:
|
|
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:
|
||
creditor.name |
Party name | 40 | ||
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 18 | Mandatory if the above is populated:
|
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 |
|
|
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 |
|
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 |
|
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:
|
|
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:
|
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:
|
|
creditor.name |
Party name | 40 | ||
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 18 | Mandatory if the above is populated:
|
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:
|
|
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 |
|
|
creditor.countryOfResidence |
Country of residence | 2 |
|
|
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 |
|
|
additionalParties.ultimateDebtor.dateAndPlaceOfBirth.birthDate |
Birth date | 10 |
|
|
additionalParties.ultimateDebtor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateDebtor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
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 |
|
|
additionalParties.ultimateCreditor.dateAndPlaceOfBirth.birthDate |
Date of birth | 10 |
|
|
additionalParties.ultimateCreditor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateCreditor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
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 |
|
North America (NA)
Canada
Interac e-Transfer
The following table contains the required payment parameters to initiate an Interac e-Transfer payment:
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
|
|
The payment’s unique end-to-end ID that's assigned by the sender. |
1 |
35 |
|
|
The value's currency. |
3 |
3 |
Must be CAD. |
|
The value's amount. |
1 |
8 |
|
|
The transfer type. |
6 |
6 |
Must be CREDIT. |
|
The payment type. |
3 |
3 |
Must be RTP. |
|
The debtor's account number. |
1 |
19 |
|
|
The debtor's name. |
1 |
30 |
|
|
The debtor agent's financial institution ID. |
8 |
8 |
Must be CHASCATT. |
|
The debtor agent's financial institution ID type. |
3 |
3 |
Must be BIC. |
|
The creditor's name. |
1 |
30 |
|
|
The creditor's country. |
2 |
2 |
Must be CA. |
|
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:
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
The creditor's account number. |
10 |
35 |
|
|
The creditor's alternate account ID. |
10 |
256 |
RegEx |
|
The type of proxy account. |
4 |
35 |
|
|
The creditor's country of residence. |
2 |
2 |
Must be CA. |
|
The ultimate debtor's name. |
1 |
140 |
|
|
The ultimate debtor's postal address type. |
4 |
4 |
Must be one of the following:
|
|
The ultimate debtor's building number. |
1 |
16 |
|
|
The ultimate debtor's street name. |
1 |
70 |
|
|
The ultimate debtor's country subdivision. |
0 |
35 |
Can't contain special characters. |
|
The ultimate debtor's country. |
2 |
2 |
|
|
The secure verification key. |
1 |
40 |
|
|
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=" |
|
The payment's expiration date. |
24 |
24 |
|
Interac e-Transfer optional fields
The following table contains an optional payment parameter to initiate an Interac e-Transfer payment:
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
The creditor's postal address type. |
4 |
4 |
Must be one of the following:
|
|
The creditor's building number. |
1 |
16 |
|
|
The creditor's street name. |
1 |
70 |
|
|
The creditor's postal code. |
1 |
16 |
|
|
The creditor's country subdivision. |
1 |
35 |
|
|
Unstructured information |
1 |
140 |
United States (TCH/FedNow)
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 |
|
|
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 |
|
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 |
|
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
Field |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Street name |
70 |
|
|
|
City |
35 |
|
|
|
Postal code |
16 |
|
|
|
Country subdivision |
35 |
|
|
|
Country |
2 |
|
|
|
City of Birth |
35 |
|
|
|
Country of Birth |
2 |
|
|
|
Birth date |
10 |
|
|
|
Street name |
1 |
70 |
|
|
City |
1 |
35 |
|
|
Postal Code |
1 |
16 |
|
|
Country |
2 |
|
|
|
Subdivision |
1 |
35 |
|
|
City of birth |
1 |
35 |
|
|
Country |
2 |
2 |
|
|
Birth date |
10 |
10 |
|
|
Ultimate debtor name |
1 |
140 |
|
|
City of birth |
1 |
35 |
|
|
Country |
2 |
2 |
|
|
Birth date |
10 |
10 |
|
|
Street name |
1 |
70 |
|
|
City |
1 |
35 |
|
|
Postal code |
1 |
16 |
|
|
Country sub-division |
1 |
35 |
|
|
Country. |
2 |
2 |
|
|
Party name |
1 |
140 |
Becomes mandatory if other details for ultimate creditor are provided. |
|
City of birth |
1 |
35 |
|
|
Country of birth |
2 |
2 |
|
|
Date of birth |
10 |
10 |
|
|
Street name |
1 |
70 |
|
|
City |
1 |
35 |
|
|
Postal code |
1 |
16 |
|
|
Country |
2 |
2 |
|
|
Country subdivision |
1 |
35 |
|
|
Additional remittance information |
Mandatory if structuredInformation object is used |
United States (TCH/FedNow) optional fields
| Field | Description | Minimum | Maximum | Notes |
|---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 3 | Currently only support DDA or VAM account |
|
debtor.account.accountCurrency |
ISO 4217 Alpha-3 Currency Code. | 3 |
||
|
Unstructured address |
70 | Recommended for TP3 flows |
|
|
Building number |
16 |
Recommended for TP3 flows |
|
creditor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
additionalParties.ultimateDebtor.countryOfResidence |
Country of residence | 2 |
|
|
additionalParties.ultimateDebtor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
|
|
additionalParties.ultimateCreditor.postalAddress.type |
Type of postal address | 4 | Recommended for TP3 Flows Values include:
|
|
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 |
Description |
Minimum |
Maximum |
Notes |
|---|---|---|---|---|
|
Type of payment being initiated. |
3 |
3 |
Must be RTP. |
|
Bank reference number of the original incoming payment. |
1 |
12 |
|
|
Clearing system reference number assigned to the original incoming payment. |
1 |
50 |
|
|
|
1 |
128 |
Either of the parameters from originalPaymentIdentifiers must be populated. |
|
|
1 |
35 |
Either of the original payment reference numbers must be populated. This field is not supported for India UPI. |
|
Currency of the original incoming payment, based on ISO 4217 Alpha-3 currency code. |
3 |
3 |
This is mandatory if originalPaymentIdentifiers.endToEndId is provided. |
|
Amount of the original incoming payment. |
0.01 |
18 |
This is mandatory if originalPaymentIdentifiers.endToEndId is provided. |
|
Value date of the original incoming payment |
1 |
10 |
|
|
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 |
|
|
ISO country code |
2 |
2 |
Specify the market from which the request originates. |
|
Party bearing the transaction fees. |
|
||
|
Indicates whether the return is a full or partial return. PARTIAL: Returns only a portion of the original payment amount. |
|
||
|
Amount of the return payment. This should be Partial or Full amount but cannot be more than the original amount. |
0.01 |
18 |
|
|
Currency of the return payment, based on ISO 4217 Alpha-3 currency code. |
3 |
3 |
|
Reason for the return in coded format. |
4 |
4 |
Captures the reason for the return in coded format. | |
|
Reason for the return in proprietary format. |
1 |
35 |
Captures the reason for the return in proprietary format. |
|
Additional information about the return. |
1 |
105 |
Related
To view example RTP payment requests for different markets, see the API specification.
Next steps
Learn more about available resources.