Endpoint: https://api.validate.bankersalmanac.com/bank/local-language
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bankLocalLanguage
Overview
We carry local language information for certain countries:
| ISO Country code | Country |
| AZ | Azerbaijan |
| CN | China |
| GE | Georgia |
| JP | Japan |
| KR | Korea, Republic of |
| KZ | Kazakhstan |
| RU | Russian Federation |
| TH | Thailand |
| TJ | Tajikistan |
| TW | Taiwan |
| UA | Ukraine |
| VN | Vietnam |
Once you validate bank information and a local language is present this will be indicated in the field “availLang”.
In the call https://api.validate.bankersalmanac.com/payer if you want this information in the local language, then you will just need to enter the Free Token and Bank Token that you get in a response into this call and you will receive the local language information.
Endpoint input
The request will be allow you to validate the data entered by the user.
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| countryCode | ISO 2 digit Country Code | Alpha | Mandatory | |
| nationalId | Banks name to search for | Alpha | Mandatory | |
| accountNumber | Bank address | Alpha | Optional | |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | Optional | |
| ref | Your reference | Alphanumeric | Optional | |
| group | Group | Alphanumeric & Extended Characters | Optional | |
| bic8 | BIC 8 | Y or N | Optional | |
| noBranch | Option to show branch or not, Y- no branch shown, N – show all branches. | Y or N | ||
| isoAddr | ISO Address flag, Y-truncate to 70 char (accepted ISO address format) : Bank Name, Branch, Street, City, Post Zip, Region, Country. | Y or N | ||
| payBranchType | Payment Branch Type | I IBAN, B Branch,H Head Office,R Routing, P Payment | ||
| page | This requests the page number you are after, the default for this is 1 | Numeric | Optional | 1 |
| pageSize | This defines the number of branches on a page, the default is 10 | Numeric | Optional | 10 |
| token | Security Token | Alphanumeric & Extended Characters | Mandatory | |
| errorComment | If the field is set to E then you will be able to edit the error text in the self service hub | E | Optional |
Response modification
This is the same as for bank validation but the address details are in local language.
| Field Name | Description | Format |
| noBranch | Option to show branch or not, Y- no branch shown, N – show all branches. | Y or N |
| isoAddr | ISO Address flag, Y-truncate to 70 char (accepted ISO address format) : Bank Name, Branch, Street, City, Post Zip, Region, Country. | Y or N |
| bic8 | BIC 8 | Y or N |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N |
| branch details | ||
| ctStatus | Is the bank SEPA credit transfer compliant | Y or N |
| ddStatus | Is the bank SEPA direct debit compliant | Y or N |
| bbStatus | Is the bank SEPA B2B direct debit compliant | Y or N |
| ctStatus | Is the bank SEPA instant Credit compliant | Y or N |
| ssiAvailable | Do we have correspondent details available | Y or N |
| payServiceAvailable | Do we have domestic clearing information available | Y or N |
| contactsAvailable | Do we have contact details available | Y or N |
| messageAvailable | Do we have payment message details available | Y or N |
| holidayAvailable | Do we have holiday details available. | Y or N |
| ctStatus | Is the Creditor branch SEPA credit transfer compliant | Y or N |
| ddStatus | Is the Creditor branch SEPA direct debit compliant | Y or N |
| bbStatus | Is the Creditor branch B2B compliant | Y or N |
| ictStatus | Is the Creditor branch SEPA instant credit compliant | Y or N |
| ssiAvailable | Do we have correspondent details available | Y or N |
| payServiceAvailable | Do we have domestic clearing information available. | Y or N |
| contactsAvailable | Do we have contact details available. | Y or N |
| messageAvailable | Do we have payment message details available. | Y or N |
| holidayAvailable | Do we have holiday details available. | Y or N |
| head office details | ||
| ssiAvailable | Do we have correspondent details available | Y or N |
| payServiceAvailable | Do we have domestic clearing information available | Y or N |
| contactsAvailable | Do we have contact details available. | Y or N |
| messageAvailable | Do we have payment message details available. | Y or N |
| holidayAvailable | Do we have holiday details available. | Y or N |
| euSanctions | Sanctions by EU | Y or N |
| hmtSanctions | Sanctions by HM | Y or N |
| ofacSanctions | Sanctions by OFAC | Y or N |
| unSanctions | Sanctions by UN | Y or N |
| paymentBicDetails | ||
| euSanctions | Sanctions by EU | Y or N |
| hmtSanctions | Sanctions by HM | Y or N |
| ofacSanctions | Sanctions by OFAC | Y or N |
| unSanctions | Sanctions by UN | Y or N |
| ssiAvailable | Do we have correspondent details available | Y or N |
| payServiceAvailable | Do we have domestic clearing information available | Y or N |
| contactsAvailable | Do we have contact details available. | Y or N |
| messageAvailable | Do we have payment message details available. | Y or N |
| holidayAvailable | Do we have holiday details available. | Y or N |
Response outcomes
To understand the responses, please refer to Swagger – https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bankLocalLanguage
| Field Name | Description | Format | ||
| countryCode | Country Code | Alpha | ||
| nationalId | Bank code entered in the search | Alphanumeric | ||
| accountNumber | Account number entered in the search | Alphanumeric | ||
| recommendedNatId | Our recommended national id | Alphanumeric | ||
| recommendedAcct | Our recommended account number | Alphanumeric | ||
| recommendedBIC | Our recommended BIC | Alphanumeric | ||
| status | Status of the response PASS, CAUTION or FAIL | Alpha | ||
| comment | Description of the status | Alpha | ||
| ref | Reference | Alpha numeric | ||
| group | The group name that this data should be saved in. | Alphanumeric & Extended Characters | ||
| noBranch | Option to show branch or not, Y- no branch shown, N – show all branches. | Y or N | ||
| isoAddr | ISO Address flag, Y-truncate to 70 char (accepted ISO address format) : Bank Name, Branch, Street, City, Post Zip, Region, Country. | Y or N | ||
| payBranchType | Payment Branch Type | I IBAN, B Branch,H Head Office,R Routing, P Payment | ||
| freeToken | Free token generated for supplementary calls. These are from the primary service calls. | Alphanumeric & Extended Characters | ||
| bic8 | BIC 8 | Y or N | ||
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | ||
| page | This requests the page number you are after, the default for this is 1 | Numeric | ||
| pageSize | This defines the number of branches on a page, the default is 10 | Numeric | ||
| pageTotal | This defines the total number of branches on a page | Numeric | ||
| recommendedNatId | Our recommended national id | Alphanumeric | ||
| recommendedAcct | Our recommended account number | Alphanumeric | ||
| recommendedBIC | Our recommended BIC | Alphanumeric | ||
| branch details | ||||
| bankName | Bank Name | Alpha | ||
| branch | Branch Name | Alpha | ||
| street | Address | Alpha | ||
| city | City | Alpha | ||
| postZip | Post or Zip Code | Alpha | ||
| region | State or County | Alpha | ||
| country | Country name | Alpha | ||
| bankToken | Banktoken for the branch | Alphanumeric | ||
| codeName1 | SWIFT BIC field | Alpha | ||
| codeValue1 | SWIFT BIC for the branch | Alpha | ||
| codeName2 | CHIPS field | Alpha | ||
| codeValue2 | CHIPS code for the branch | Alpha | ||
| codeName3 | SWIFT BIC 4 field | Alpha | ||
| codeValue3 | 4-digit SWIFT BIC for the branch | Alpha | ||
| codeName4 | Name of the domestic Clearing Code | Alpha | ||
| codeValue4 | Domestic Clearing Code | Alpha | ||
| ctStatus | Is the bank SEPA credit transfer compliant | Y or N | ||
| ddStatus | Is the bank SEPA direct debit compliant | Y or N | ||
| bbStatus | Is the bank SEPA B2B direct debit compliant | Y or N | ||
| ctStatus | Is the bank SEPA instant Credit compliant | Y or N | ||
| ssiAvailable | Do we have correspondent details available | Y or N | ||
| payServiceAvailable | Do we have domestic clearing information available | Y or N | ||
| contactsAvailable | Do we have contact details available | Y or N | ||
| messageAvailable | Do we have payment message details available | Y or N | ||
| holidayAvailable | Do we have holiday details available. | Y or N | ||
| bankToken | Bank token | Alphanumeric & Extended Characters | ||
| ctStatus | Is the Creditor branch SEPA credit transfer compliant | Y or N | ||
| ddStatus | Is the Creditor branch SEPA direct debit compliant | Y or N | ||
| bbStatus | Is the Creditor branch B2B compliant | Y or N | ||
| ictStatus | Is the Creditor branch SEPA instant credit compliant | Y or N | ||
| ssiAvailable | Do we have correspondent details available | Y or N | ||
| payServiceAvailable | Do we have domestic clearing information available. | Y or N | ||
| contactsAvailable | Do we have contact details available. | Y or N | ||
| messageAvailable | Do we have payment message details available. | Y or N | ||
| holidayAvailable | Do we have holiday details available. | Y or N | ||
| head office details | ||||
| branchTypeLabel | Branch Type Label | Alpha | ||
| bankName | Bank Name | Alpha | ||
| branch | Branch Name | Alpha | ||
| street | Address | Alpha | ||
| city | City | Alpha | ||
| postZip | Post or Zip Code | Alpha | ||
| region | State or County | Alpha | ||
| country | Country name | Alpha | ||
| codeName1 | SWIFT BIC field | Alpha | ||
| codeValue1 | SWIFT BIC for the branch | Alpha | ||
| codeName2 | CHIPS field | Alpha | ||
| codeValue2 | CHIPS code for the branch | Alpha | ||
| codeName3 | SWIFT BIC 4 field | Alpha | ||
| codeValue3 | 4 digit SWIFT BIC for the branch | Alpha | ||
| codeName4 | Name of the domestic Clearing Code | Alpha | ||
| codeValue4 | Domestic Clearing Code | Alpha | ||
| ssiAvailable | Do we have correspondent details available | Y or N | ||
| payServiceAvailable | Do we have domestic clearing information available | Y or N | ||
| contactsAvailable | Do we have contact details available. | Y or N | ||
| messageAvailable | Do we have payment message details available. | Y or N | ||
| holidayAvailable | Do we have holiday details available. | Y or N | ||
| euSanctions | Sanctions by EU | Y or N | ||
| hmtSanctions | Sanctions by HM | Y or N | ||
| ofacSanctions | Sanctions by OFAC | Y or N | ||
| unSanctions | Sanctions by UN | Y or N | ||
| paymentBicDetails | ||||
| branchTypeLabel | Branch Type | Alpha | ||
| bankName | Banks Name | Alphanumeric | ||
| street | Street Name | Alphanumeric | ||
| city | City name | Alphanumeric | ||
| postZip | Postal code | Alphanumeric | ||
| region | Region | Alpha | ||
| country | ISO Country Name | Alphanumeric | ||
| codeName1 | Code set 1 name | Alphanumeric | ||
| codeValue1 | Code set 1 value | Alphanumeric | ||
| codeName2 | Code set 2 name | Alphanumeric | ||
| codeValue2 | Code set 2 value | Alphanumeric | ||
| codeName3 | Code set 3 name | Alphanumeric | ||
| codeValue3 | Code set 3 value | Alphanumeric | ||
| codeName4 | Code set 4 name | Alphanumeric | ||
| codeValue4 | Code set 4 value | Alphanumeric | ||
| euSanctions | Sanctions by EU | Y or N | ||
| hmtSanctions | Sanctions by HM | Y or N | ||
| ofacSanctions | Sanctions by OFAC | Y or N | ||
| unSanctions | Sanctions by UN | Y or N | ||
| ssiAvailable | Do we have correspondent details available | Y or N | ||
| payServiceAvailable | Do we have domestic clearing information available | Y or N | ||
| contactsAvailable | Do we have contact details available. | Y or N | ||
| messageAvailable | Do we have payment message details available. | Y or N | ||
| holidayAvailable | Do we have holiday details available. | Y or N | ||
| bankName | Banks Name | Alphanumeric | ||
| branch | Branch | Alphanumeric | ||
| street | Street Name | Alphanumeric | ||
| city | City name | Alphanumeric | ||
| postZip | Postal code | Alphanumeric | ||
| region | Region | Alpha | ||
| country | ISO Country Name | Alphanumeric |
Test example
free token
bank token