| Available | Yes |
targetCurrency | Indian Rupee (INR) |
countryCode | IN |
| API field name | Required? | Field length | Description |
|---|---|---|---|
instructions.party.payoutInstrument.accountNumber | ✅ | 6-20 | Account number of the beneficiary. Important If the beneficiary details are of the HDFC Bank, then the max length of the account number should be exactly 14 digits. |
instructions.party.payoutInstrument.bankCode | ✅ | 11 | Indian Financial System Code must be 11 digits in length IFSC code consists of 11 digits. First 4 represent bank code, fifth character is 0 and the remaining 6 characters identify the branch e.g. HDFC0000XXX. |
instructions.party.payoutInstrument.bankName | ✅ | Max 35 | Name of the beneficiary bank. |
instructions.party.type | ✅ | N/A | Type of the party. Must be:
|
instructions.party.payoutInstrument.accountType | ✅ | N/A | Type of the account. Available values:
|
instructions.party.payoutInstrument.accountHolderName | Conditional | Min 2 and Max 70 | Beneficiary full name. Full name should be provided (no initials). Condition Mandatory if instructions.party.personalDetails.type is person and instructions.party.personalDetails.firstName and/or instructions.party.personalDetails.lastName are not provided. Or if instructions.party.personalDetails.type is company and the instructions.party.personalDetails.companyName is not provided. |
instructions.party.personalDetails.type | ✅ | N/A | Entity description code for the party. Available values:
|
instructions.party.personalDetails.title | Conditional | N/A | Title code for the Individual. Available values:
Condition Mandatory if instructions.party.personalDetails.type is:
|
instructions.party.personalDetails.firstName | Conditional | Max 35 | Beneficiary first name. Full name should be provided (no initials). Condition Mandatory if instructions.party.personalDetails.type is:
|
instructions.party.personalDetails.middleName | ❌ | Max 35 | Beneficiary middle name. |
instructions.party.personalDetails.lastName | Conditional | Max 35 | Beneficiary last name. Condition Full Name (First + Middle + Last name) must be between 2 and 70 characters, including spaces and any other characters. Mandatory if instructions.party.personalDetails.type is:
|
instructions.party.personalDetails.companyName | Conditional | Max 70 | Full name of the organization. Condition Mandatory if instructions.party.personalDetails.type is:
|
instructions.party.personalDetails.dateOfBirth | ❌ | 10 | Beneficiary's date of birth in YYYY-MM-DD format. |
instructions.party.personalDetails.dateOfIncorporation | ❌ | 10 | A company`s date of incorporation in YYYY-MM-DD format. |
instructions.party.identityDocuments.type | Conditional | N/A | Type code specific for invoice documentation Must be:
Condition You must give all of the conditional identity fields, if you provide at least one of the properties. |
instructions.party.identityDocuments.number | Conditional | 9 | Invoice number. Condition Mandatory for trade transactions. |
instructions.party.identityDocuments.issuingCountry | Conditional | 2 | Country code of the invoice Enter the 2 character ISO 3166-1 standard country code in your API request. Condition Mandatory for trade transactions. |
instructions.party.identityDocuments.validFrom | Conditional | 10 | Issue date of the Invoice in YYYY-MM-DD format. Condition Mandatory for trade transactions. |
instructions.party.address.address1 | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) house number/name and street e.g. 1 Main Street. |
instructions.party.address.address2 | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) address e.g. apartment no., unit, studio. |
instructions.party.address.city | ❌ | Max 35 | Beneficiary's city or town of their residential (if payee is an individual) or registered (if payee is a company) address. |
instructions.party.address.postalCode | ❌ | Max 10 | Beneficiary's postal code or zip code of their residential (if payee is an individual) or registered (if payee is a company) address. |
instructions.party.address.countryCode | ✅ | 2 | Beneficiary's country code of their residential (if payee is an individual) or registered (if payee is a company) address. Enter the 2 character ISO 3166-1 standard country code in your API request. |
instructions.party.address.residentialStatus | ✅ | N/A | Beneficiary's residential status. Available values:
|