Payment and returns parameters
This page outlines the required fields fneeded to sucessfully 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.
Required fields for all Real-Time Payments
Real-Time Payments requests have different required fields based on their use case, but some fields are always required, regardless of region or payment method. The following table describes these fields in more detail.
Required fields for all Real-Time Payments
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 1 | 10 |
|
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 . |
||
paymentType |
Type of payment being initiated. |
3 | 3 | Must be RTP . |
debtor.account.accountNumber |
This field captures the debtor's account number. | 8 | 35 | |
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier of the debtor. | 11 | Must be a valid 8- or 11-character BIC or USABA value. |
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier of the debtor. | Allowed values are |
Requirements by country
Information in this section provides details for these region specific requirements. Review the information for the region to understand the requirements prior to coding.
Asia Pacific
Australia (NPP)
Australia (NPP) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction (e.g. value date) in yyyy-mm-dd format, must be either the current or future date. | 1 | 10 |
|
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 |
This field captures the debtor's account number. | 35 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., 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. i.e Bank Branch State Identifier (BSB code) | 11 | Filed must be populated with the BSB Code. | |
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier. | 18 | Must be "CLEARING_SYSTEM_ID". |
Australia (NPP) Pay to Proxy required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction (e.g. value date) in yyyy-mm-dd format, must be either the current or future date. | 1 | 10 |
|
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 |
This field captures the debtor's account number. | 35 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC. | 8 | Field is expected to have an 8 digit BIC value: CHASAU2X . |
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 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. | 4 | Required for Pay to Proxy. Values include:
|
|
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. i.e 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) | 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.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 | 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 | |
paymentPurpose.purpose.code |
Underlying reason for the payment transaction, e.g., a charity payment, or a commercial agreement between the creditor and the debtor. | 4 | ||
paymentPurpose.purpose.type |
Purpose type | 4 | "CODE" |
|
paymentPurpose.categoryPurpose.code |
Purpose code | 4 | ||
paymentPurpose.categoryPurpose.proprietary |
Specifies the type of scheme with a proprietary code. | 4 | ||
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (2 lines) | This is to provide other payment details. |
Hong Kong (FPS)
Hong Kong (FPS) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
paymentIdentifiers.endToEndId |
Customer-assigned unique identifier to unambiguously identify the Payment Initiation request. This ID 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 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, i.e., 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, i.e., 3-digit bank codes. | 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 of the payment instruction, e.g., 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 put Credit for routing rules. |
||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put RTP for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 35 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC | 8 | Field is expected to have an 8 digit BIC value: "CHASHKHH" | |
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 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 | 4 | Required for Pay to Proxy. Values include:
|
|
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. |
Indonesia (BI-FAST)
Indonesia (BI-FAST) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
paymentIdentifiers.endToEndId |
Customer-assigned unique identifier to unambiguously identify the Payment Initiation request. This identification is passed on, unchanged, throughout the entire end-to-end chain. | 35 |
|
|
value.currency |
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. | 3 | 3 |
|
value.amount |
A String representation of a whole or decimal positive number. Amount should be greater than 0.01, with a minimum of two decimal places allowed in most market. | 1 | 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, i.e., 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 | Must be "BIC". | ||
creditor.account.accountNumber |
This field captures a regular account number | 35 | Required when Pay by Account is sued. Not required for Pay by Proxy. | |
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 |
|
Indonesia (BI-FAST) Pay to Proxy required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
paymentIdentifiers.endToEndId |
Customer-assigned unique identifier to unambiguously identify the Payment Initiation request. This identification is passed on, unchanged, throughout the entire end-to-end chain. | 35 |
|
|
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. | 1 | 18 |
|
transferType |
Indicates the direction of the money movement. | Must put Credit for routing rules. |
||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put RTP for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 35 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC. | 11 | Field is expected to have one of these 8 or 11 BIC values per below:
|
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | Must be "BIC". | ||
creditor.account.alternateAccountIdentifiers.identifier |
Alternate account identifier. | 1 | 2048 |
|
creditor.account.alternateAccountIdentifiers.idType |
One or more values that can be used as alternative identifiers for an account. | 4 | Required for Pay to Proxy. Value options include:
|
|
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:
|
India (IMPS)
India required fields
Field |
Description |
Minimum | Maximum | Notes |
---|---|---|---|---|
|
The requested execution date. |
10 |
10 |
|
|
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 |
|
|
Currency of the payment, based on ISO 4217 Alpha-3 Currency Code. |
3 |
3 |
|
|
A String representation of a whole number or decimal positive number. The amount must be greater than 1 and can have upto two decimal places in most markets. | 1 |
18 |
|
|
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 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. |
Indonesia (BI-FAST) optional fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 3 | Currently, only 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 | |
paymentPurpose.categoryPurpose.proprietary |
Specifies the type of scheme with a proprietary code. | 35 | Values include:
Refer to Payments Developer Portal for list of purpose/category codes. |
|
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (2 lines) | This is to provide other payment details. | |
chargesInformation.chargeBearer |
Charge bearer | 8 |
|
Malaysia (RPP)
Malaysia (RPP) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
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. 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 |
Financial Institution Identifier. i.e 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 mandatory for Malaysia Real-Time Payments Platform (RPP). Underlying reason for the payment transaction, e.g., a charity payment, or a 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 of the payment instruction, e.g., 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. 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 |
Financial Institution Identifier. i.e BIC, | 8 | Field is expected to have one of these 8 digit BIC values: "CHASMYKX" |
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 3 | Mandatory for Debits: "BIC" | |
creditor.account.accountType |
The type of account. | 4 |
|
|
creditor.account.alternateAccountIdentifiers.identifier |
Alternate account identifier | If transferType = "CREDIT", Max - 256 If transferType = "DEBIT", Not Supported |
Required for Pay to Proxy | |
creditor.account.alternateAccountIdentifiers.idType |
One or more values that can be used as alternative identifiers for an account | 4 | Required for Pay to Proxy. Value options include:
|
|
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 mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, e.g., a charity payment, or a 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.typ e |
Purpose type | 11 | "PROPRIETARY" Required if either the debtor or creditor country of residency is not Malaysia |
|
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (2 lines) | This is to provide other payment details. | |
remittanceInformation.structuredInformation[].additionalRemittanceInformation |
Additional remittance information | 140 |
|
Singapore (FAST)
Singapore (FAST) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
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 put "Credit" for routing rules | ||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put "RTP" for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 35 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC | 11 | Field is expected to have an 11 digit BIC value: "CHASSGSGXXX" |
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 3 | Mandatory for Debits: "BIC" | |
creditor.account.accountNumber |
This field captures a regular account number | 35 | This field is to provide the regular account id when it is a pay by Account instruction. If pay by proxy, this does not need to be filled. | |
creditor.name |
Party name | 140 |
Mandatory for Pay to Account
|
|
creditorAgent.financialInstitutionIds[].id |
Financial institution identifier | 11 | Mandatory for Pay to Account | |
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 3 |
|
|
paymentPurpose.purpose.code |
This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, e.g., a charity payment, or a commercial agreement between the creditor and the debtor. | 4 | This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, e.g., a charity payment, or a commercial agreement between the creditor and the debtor. | |
paymentPurpose.purpose.type |
Purpose type | 4 | "CODE" Refer to Payments Developer Portal for list of purpose/category codes. |
Singapore (FAST) Pay to Proxy required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
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 put "Credit" for routing rules | ||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put "RTP" for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 35 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC | 11 | Field is expected to have an 11 digit BIC value: "CHASSGSGXXX" |
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 3 | Mandatory for Debits: "BIC" | |
creditor.account.alternateAccountIdentifiers.identifier |
Alternate account identifiers | 256 | Required for Pay to Proxy | |
creditor.account.alternateAccountIdentifiers.idType |
One or more values that can be used as alternative identifiers for an account | 4 | Required for Pay to Proxy. Value options include:
|
|
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 mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, e.g., a charity payment, or a commercial agreement between the creditor and the debtor. | 4 | This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, e.g., a charity payment, or a commercial agreement between the creditor and the debtor. | |
paymentPurpose.purpose.type |
Purpose type | 4 | "CODE" Refer to Payments Developer Portal for list of purpose/category codes. |
Singapore (FAST) optional fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 3 | Currently 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. |
Europe, Middle East, and Africa (EMEA)
Single Euro Payments Area (SEPA Instant)
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., 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 put "Credit" for routing rules. | ||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put "RTP" for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 34 | ||
debtorAgent.financialInstitutionIds[].id |
The financial instituion identifier, i.e. , BIC | 11 | The field is expected to include one of the following branches and its corresponding 8- or 11-character BIC values:
|
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier. | Must be "BIC". | ||
creditor.account.accountNumber |
This field captures a regular account number. | 34 | ||
creditor.name |
Party name | 70 | ||
creditorAgent.financialInstitutionIds[].id |
The financial institution identifier. | 11 | Clients are encouraged not to populate in payload. CreditorAgent BIC will be derived from the Creditor IBAN. | |
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier. | 3 | Mandatory if the above is populated: "BIC" | |
additionalParties.ultimateDebtor.organizationIds[].organizationId |
Formally Issued Organization Identifier | 35 |
Mandatory for TP3 flows (Either Organization Id or Individual Id). The Ultimate Debtor's physical or virtual IBAN/account number is recommended. Otherwise, in the account is not available, a unique identifier should be specified; to be determined by the payment service provider that could allow traceability back to the Ultimate Debtor.
|
|
additionalParties.ultimateDebtor.organizationIds[].schemeName.proprietary |
Specifies the type of scheme with a proprietary code. | 3 | If the transaction includes an Ultimate Debtor, populate one of the following fields: "BIC", "LEI", or "ID" |
|
additionalParties.ultimateDebtor.individualIds[].individualId |
Individual identifier details | 35 |
Mandatory for TP3 flows (Either Organization Id or Individual Id). The Ultimate Debtor's physical or virtual IBAN/account number is recommended. Otherwise, in the account is not available, a unique identifier should be specified; to be determined by the payment service provider that could allow traceability back to the Ultimate Debtor.
|
|
additionalParties.ultimateDebtor.individualIds[].schemeName.proprietary |
Specifies the type of scheme with a proprietary code. | 3 | If the transaction includes an Ultimate Debtor, populate one of the following fields: "BIC", "LEI", or "ID" |
SEPA Instant RTP optional fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 4 | Currently only support IBAN accounts. |
|
debtor.account.accountCurrency |
ISO 4217 Alpha-3 Currency Code. | 3 |
Currently only supports "EUR". |
|
creditor.postalAddress.type |
Type of postal address | 4 | Values include:
|
|
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 |
|
|
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.organizationIds[].organizationId |
Organization identifier details | 35 | Either individualID or organizationID, not both | |
additionalParties.ultimateCreditor.individualIds[].individualId |
Individual identifier details | 35 | Either individualID or organizationID, not both | |
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (1 line) | This is to provide other payment details. |
United Kingdom (UK FPS)
United Kingdom (UK FPS) required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
paymentIdentifiers.endToEndId |
Customer-assigned unique identifier to unambiguously identify the Payment Initiation request. This identification is passed on, unchanged, throughout the entire end-to-end chain. | 1 | 31 |
|
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 put "Credit" for routing rules. | ||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put "RTP" for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 8 | Account numbers with less than 8 digits must be padded with leading zeros | |
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC | 11 | Field is expected to have one of these 8 or 11 BIC values below:
|
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 3 | Mandatory for Debits: "BIC" | |
debtorAgent.additionalInstitutions[].id |
Identifier | 11 | This field becomes mandatory for any TP3 Payment Originating Overseas (POO). It needs to be populated with the BIC code of the first Overseas Payment Service Provider | |
creditor.account.accountNumber |
This field captures a regular account number | 8 | Account numbers with less than 8 digits must be padded with leading zeros | |
creditor.name |
Party name | 40 | ||
creditorAgent.financialInstitutionIds[].id |
Financial institution identifier. | 6 | This is a 6-digit field that represents the sort code. Sort codes containing less than six digits must be padded with leading zeros. For example, if the number is 1234, you will need to enter leading zeros. so that the number will be represented as 001234. | |
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 9 | "SORT_CODE" |
United Kingdom (UK FPS) optional fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
debtor.account.accountType |
This field captures the debtor's account type | 3 | Currently supports DDA or VAM account. |
|
debtor.account.accountCurrency |
ISO 4217 Alpha-3 Currency Code. | 3 |
Currently supports "GBP". |
|
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 |
|
|
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.organizationIds[].organizationId |
Organization identifier details | 35 | Either individualID or organizationID, not both | |
additionalParties.ultimateCreditor.individualIds[].individualId |
Individual id details | 35 | Either individualID or organizationID, not both | |
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (2 lines) | This is to provide other payment details. |
Latin America (LATAM)
Brazil (PIX)
Brazil (PIX) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
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, i.e., 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 | 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 of the payment instruction, e.g., 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, i.e., 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. | 4 | Required for Pay to Proxy Value options include:
|
|
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 | ||
taxInformation.creditorTaxInformation.taxId |
Tax identifier | 35 | ||
taxInformation.creditorTaxInformation.taxPayerCategory |
Tax payer category. If category = INDIVIDUAL map here |
|
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.typ e |
Purpose type | 11 | "PROPRIETARY" Required if either the debtor or creditor country of residency is not Malaysia |
|
remittanceInformation.unstructuredInformation.text |
Unstructured information | 140 (2 lines) | This is to provide other payment details. |
Mexico (SPEI)
Mexico (SPEI) Pay to Account required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
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 put "Credit" for routing rules. | ||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put "RTP" for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 16 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC | 11 | Field is expected to have one of these 8 or 11 BIC values per below:
|
|
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 of the payment instruction, e.g., 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 put "Credit" for routing rules. | ||
paymentType |
Type of payment being initiated. |
3 | 3 | Must put "RTP" for routing rules. |
debtor.account.accountNumber |
This field captures the debtor's account number. | 16 | ||
debtorAgent.financialInstitutionIds[].id |
The financial institution identifier, i.e., BIC | 11 | Field is expected to have one of these 8 or 11 BIC values per below:
|
|
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 | 4 | Required for Pay to Proxy Value options include:
|
|
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)
United States (TCH / FedNow)
United States (TCH/FedNow) required fields
Field | Description | Minimum | Maximum | Notes |
---|---|---|---|---|
requestedExecutionDate |
Requested execution date of the payment instruction, e.g., value date. | 10 |
|
|
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 "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 put "Credit" for routing rules. | ||
paymentType |
Type of payment being initiated. |
3 | Must put "RTP" for routing rules. | |
debtor.account.accountNumber |
This field captures the debtor's account number. | 34 | ||
debtor.name |
Party name | 140 | ||
debtorAgent.financialInstitutionIds[].id |
Financial Institution Identifier. i.e USABA | 9 | ABA/routing number: 021000021 |
|
debtorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier. | 5 | "USABA" | |
creditor.account.accountNumber |
This field captures a regular account number | 34 | ||
creditor.name |
Party name | 140 | ||
creditorAgent.financialInstitutionIds[].id |
The financial institution ID. | 9 | ABA/routing number | |
creditorAgent.financialInstitutionIds[].idType |
The type of financial institution identifier | 5 | "USABA" |
United States (TCH/FedNow) conditional fields
Field |
Description |
Minimum |
Maximum |
Notes |
---|---|---|---|---|
|
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 stat 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 |
---|---|---|---|---|
paymentType |
Type of payment being initiated. |
3 |
3 |
Must be RTP. |
originalPaymentIdentifiers.bankReferenceNumber |
A unique identifier generated by JPMC for each payment. |
1 |
12 |
|
originalPaymentIdentifiers.clearingSystemReference |
Clearing system reference number assigned to the original incoming payment. |
1 |
50 |
Either of the parameters from originalPaymentIdentifiers must be populated. |
originalPaymentIdentifiers.paymentId |
endToEndId of the original incoming payment. |
1 |
128 |
Either of the parameters from originalPaymentIdentifiers must be populated. |
originalPaymentIdentifiers.endToEndId |
Customer-assigned unique identifier to unambiguously identify the payment request. This identification is passed on, unchanged, throughout the entire end-to-end chain. |
1 |
35 |
Either of the original payment reference numbers must be populated. |
originalPaymentIdentifiers.originalValue.currency |
Currency of the return payment, based on ISO 4217 Alpha-3 currency code. |
3 |
3 |
This is mandatory if originalPaymentIdentifiers.endToEndId is provided. |
originalPaymentIdentifiers.originalValue.amount |
Amount of the original incoming payment. This should be more than 0.01 with a maximum of two decimal places allowed in most markets. |
0.01 |
18 |
This is mandatory if originalPaymentIdentifiers.endToEndId is provided. |
originalPaymentIdentifiers.valueDate |
Requested execution date of the original incoming payment. |
1 |
10 |
|
paymentIdentifiers.endToEndId |
Customer-assigned unique identifier to unambiguously identify the payment return request. This identification is passed on, unchanged, throughout the entire end-to-end chain. |
1 |
35 |
|
country |
ISO country code |
2 |
2 |
Specify the market from which the request originates. |
chargeBearer |
Party bearing the transaction fees. |
|
||
returnType |
Indicates whether the return is a full or partial return. PARTIAL: Returns only a portion of the original payment amount. |
|
||
value.amount |
A string representation of a (potentially) whole number or decimal positive number. Amount should be more than 0.01 with a maximum of two decimal places allowed in most markets. |
0.01 |
18 |
|
value.currency |
Currency of the return payment, based on ISO 4217 Alpha-3 currency code. |
3 |
3 |
|
reason.code |
Reason for the return in coded format. |
4 |
4 |
Captures the reason for the return in coded format. Valid value is "MD06" for Brazil. |
reason.proprietary |
Reason for the return in proprietary format. |
1 |
35 |
Captures the reason for the return in proprietary format. |
additionalInformation |
Additional information about the return. |
1 |
105 |
Related
To view example RTP payment requests for different markets, see the API specification.
Next steps
Learn more about available resources.