Endpoint: https://api.validate.bankersalmanac.com/ssi/payer-payee
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/ssiPayerPayee
Overview
This call is designed to return the correspondent bank details required to make a payment for the payment details entered. This call does not return any details on the branch itself.
The call will validate the clients account number and bank code data and respond with only the correspondent details for the currency that the user entered.
The service returns the various correspondent details depending on the currency requiring settling and the particular asset category.
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| countryCode | ISO Country Code | Alpha | Mandatory | |
| nationalId | Domestic bank ID | Alphanumeric | Mandatory | |
| currencyCode | ISO currency code of the payment | Alpha | Mandatory | |
| dataStore | Yes/No flag if you wish the data to be stored and scanned by us | Y or N | Optional | N |
| ref | Free text unique reference | Alphanumeric & Extended Characters | Optional | |
| token | Security token | Alphanumeric & Extended Characters | Mandatory | |
| bic8 | Yes/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11 | Y or N | Mandatory | N |
| originBIC | BIC of the correspondent | Alphanumeric | Mandatory | I |
| originAcct | Acct of the correspondent | Alphanumeric | Mandatory | |
| errorComment | 1-character flag to determine if the enhanced “comment” from VSS will be returned | Alpha | Optional | |
| assetCategory | Asset category of the payment | Alphanumeric | Mandatory | |
| benAcct | BIC of the Beneficiary | Alphanumeric | Mandatory |
Response modifications
The response for this request can be modified with a number of flags which allow us to give you a response which meets your business requirements.
| Field Name | Description | Format |
| bic8 | Yes/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11 | Y or N |
| beneficiary | ||
| contactsAvailable | Do we have 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/ssiPayerPayee
| 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 | ||
| recommendedAcct | Our recommended account number | Alphanumeric | ||
| recommendedBIC | Our recommended BIC | Alphanumeric | ||
| bic8 | Yes/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11 | Y or N | ||
| ref | Free text unique reference | Alphanumeric & Extended Characters | ||
| originator | ||||
| nm | Name of the originator | Alphanumeric & Extended Characters | ||
| pstlAdr | Address of the originator | Alphanumeric & Extended Characters | ||
| bic | Bic of the correspondent | Alphanumeric | ||
| acct | Account number of the correspondent | Alphanumeric | ||
| originator.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 | ||
| originator.ssiDetails | ||||
| subCategory | Asset subbcategory of the payment | Alphanumeric | ||
| assetCategory | Asset category of the payment | ALL, COMMERCIAL, FINANCIAL | ||
| corresBIC | BIC of the correspondent | Alphanumeric | ||
| corresAcct | Account number of the correspondent | Alphanumeric | ||
| preferred | Preferred flag | Alpha | ||
| beneficiary | ||||
| nm | Name of the beneficiary | Alphanumeric & Extended Characters | ||
| pstlAdr | Address of the beneficiary | Alphanumeric & Extended Characters | ||
| nationalId | National ID | Alphanumeric | ||
| bic | BIC of the beneficiary | Alphanumeric | ||
| acct | Acct of the beneficiary | Alphanumeric | ||
| contactsAvailable | Do we have contact details available | Y or N | ||
| beneficiary.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 | ||
| beneficiary.ssiDetails | ||||
| assetCategory | Asset category of the payment | ALL, COMMERCAIL, FINANCIAL | ||
| corresBIC | BIC of the correspondent | Alphanumeric | ||
| corresAcct | Account number of the correspondent | Alphanumeric | ||
| intrmyBIC1 | BIC of the correspondent’s intermediary bank | Alphanumeric | ||
| intrmyAcct1 | Account number of the correspondent intermediary bank | Alphanumeric | ||
| intrmyBIC2 | BIC of the correspondents intermediary bank | Alphanumeric | ||
| intrmyAcct2 | Account number of the correspondent account intermediary bank | Alphanumeric | ||
| institutionName | Name of the intitution | Alphanumeric | ||
| city | City name | Alphanumeric | ||
| countryName | Country name | Alphanumeric | ||
| countryCode | Country code | Alphanumeric | ||
| natId | National ID | Alphanumeric | ||
| preferred | Preferred flag | Alpha |
Test Examples
originBIC: BBDEBRSPXXX
originAcct: BR5060746948031140003855295C1
currencyCode: USD
assetCategory: ALL
countryCode: GB
nationalID: 162619
benAcct: 11270046