Endpoint: https://api.validate.bankersalmanac.com/payment-processing
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/paymentProcessing
Overview
This call is designed to return the correspondent bank details required to make a payment. The call will validate the clients account number and bank code data and respond with the bank details and the correspondent details for the currency that the user entered. The search criteria as below, and also requires the user to enter a valid ISO currency code.
- National id
- BIC
- National id and domestic account number
- BIC and domestic account number
- Structured account number (BBAN, IBAN or CLABE)
The service returns a recommended account number and national id and BIC and any correspondents for the chosen currency. The service will also return the details for the Branch and additional branch (these may be the same branch) and can be specified in the request parameters.
The details in the response for each of the 2 branches include:
- Name
- Address
- Domestic and International Codes
- SEPA Status
- Correspondent details
- Indicators of other currencies that the bank transacts in
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| countryCode | Country Code | Alpha | Optional | |
| currencyCode | ISO 3 digits currency code | Alpha | Mandatory | |
| accountNumber | Domestic bank account number or IBAN | Alphanumeric | Optional | |
| nationalId | Domestic bank code or SWIFT BIC | Alphanumeric | Optional | |
| bic8 | Y = 8 digit BIC returned for head office BICs or N = 11 digit BIC always returned | Y or N | Optional | |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | Optional | |
| ref | Your reference | Alphanumeric & Extended Characters | Optional | |
| group | Group | Alphanumeric | Optional | |
| bankToken | If you have performed a valdiation and wish to retrieve the correspndents then enter the bankToken here to retrieve additional details at no additional cost. The only other required details are the bankToken to identify the branch and the currency code | Alphanumeric & Extended Characters | Mandatory | |
| token | Security token | Alphanumeric & Extended Characters | Mandatory | |
| freeToken | If you have perfomed a valdiation and wish to retrieve the correspndents then enter the freeToken here to retrieve additional details at no additional cost. The only other required details are the bankToken to identify the branch and the currency code | Alphanumeric & Extended Characters | Mandatory | |
| requestBranch | The requestBranch parameter, this would allow us to put in a letter to specify the branch. H – Head office or F – first branch retrieved | H or F | Optional | |
| 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 modifications
| Field Name | Description | Format |
| branchDetails | ||
| contactsAvailable | Contact details available | Y or N |
| paymentBicDetails | ||
| contactsAvailable | Contact 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/paymentProcessing
| Field Name | Description | Format | ||
| countryCode | ISO Country Code | Alpha | ||
| currencyCode | ISO currency code | Alpha | ||
| nationalId | Domestic National ID | Alphanumeric | ||
| accountNumber | Domestic Account Number, BBAN or IBAN | Alphanumeric | ||
| status | Status of the call (e.g. pass, caution or fail) | Alpha | ||
| comment | Description of the status | Alphanumeric & Extended Characters | ||
| recommendedNatId | Recommended change to the entered national id | Alphanumeric | ||
| recommendedAcct | Recommended change to the entered account number | Alphanumeric | ||
| recommendedBIC | Recommended change to the entered BIC | Alphanumeric | ||
| ref | Record reference | Alphanumeric & Extended Characters | ||
| group | Used to group stored record – currently not in use | Alphanumeric | ||
| freeToken | This token allows you to use the contacts and pay service calls free to retrieve these details for a branch for a limited time | Alphanumeric & Extended Characters | ||
| branchDetails | ||||
| bankName | Banks Name | Alphanumeric | ||
| bankToken | This token allows you to get the bank and branch details for this branch using call 1.3 free of charge, in conjunction with the freeToken | Alphanumeric & Extended Characters | ||
| street | Street Name | Alphanumeric | ||
| city | City name | Alphanumeric | ||
| postZip | Postal code | Alphanumeric | ||
| region | Region | Alpha | ||
| country | ISO Country Name | Alphanumeric | ||
| availableCurrencies | ISO currency code of the available correspondents | Alpha | ||
| contactsAvailable | Contact details available | Y or N | ||
| branchDetails.codeDetails | ||||
| 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 | ||
| branchDetails.sepaDetails | ||||
| ddStatus | SEPA Direct Debit Core Compliance Status | Alpha | ||
| bbStatus | SEPA Direct Debit B2B Compliance Status | Alpha | ||
| ctStatus | SEPA Credit Transfer Compliance Status | Alpha | ||
| branchDetails.ssiDetails | ||||
| natId | Bank Code | Alphanumeric | ||
| subCategory | Subcategory of the payment | Alpha | ||
| assetCategory | Asset category of the payment | ALL, COMMERCAIL, FINANCIAL | ||
| corresBIC | BIC of the correspondent | |||
| bankName | Name of correspondent banks | |||
| corresAcct | Account number of the correspondent account | |||
| intrmyBIC1 | BIC of the correspondents intermediary bank | |||
| intrmyAcct1 | Account number of the correspondent intermediary bank | |||
| intrmyBIC2 | BIC of the correspondents intermediary bank | |||
| intrmyAcct2 | Account number of the correspondent account intermediary bank | |||
| paymentBicDetails | ||||
| contactsAvailable | Contact details available | Y or N | ||
| 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 | ||
| paymentBicDetails.codeDetails | ||||
| 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 |
Test Examples
free token