Endpoint: https://api.validate.bankersalmanac.com/bank/search
Swager link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bankSearch
Overview
This call allows you to search for a bank branch by its name. The response will retrieve the branch details including the domestic bank codes.
The user will need to enter the bank name and country code and can optionally enter city and will retrieve a list of banks that match these details.
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default value |
| countryCode | ISO 2 digit Country Code | Alpha | Mandatory | |
| bankName | Banks name to search for | Alpha | Mandatory | |
| address | Bank address | Alpha | Optional | |
| city | City the bank is in | Alpha | Optional | |
| postZipCode | Zip or Postal code of the bank | Alpha | Optional | |
| dataStore | Data Storage | Y or N | Optional | |
| ref | No functional use | Alphanumeric | Optional | |
| group | Group | Alphanumeric & Extended Characters | Optional | |
| Bic 8 | BIC 8 | Y or N | Optional | |
| page | Page Number | numeric | Optional | 1 |
| pageSize | Page Size | numeric | Optional | 10 |
| token | Security Token | Alphanumeric & Extended Characters | Mandatory | |
| errorComment | Error Type | E | Optional | |
| beginsWith | Begins With or Contains Search | Y or N | Optional |
Response modifications
The response will give you the branch details including the domestic bank codes:
| 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 |
| bank details code 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 |
| ictStatus | Is the bank SEPA instant Credit compliant | Y or N |
| ssiAvailable | Do we have correspondent details available | 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:
| 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 | Alphanumeric |
| group | ||
| 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 |
| free Token | Free token generated for supplementary calls. These are from the primary service calls. | Alphanumeric & Extended Characters |
| branch details | ||
| bankName | Bank Name | Alpha |
| branch | Branch Nam | Alpha |
| street | Address | Alpha |
| city | City | Alpha |
| postZip | Post or Zip Code | Alpha |
| region | State or County | Alpha |
| country | Country name | Alpha |
| Bank token | bank token for the branch | Alphanumeric |
| bank details code details | ||
| 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 |
| ictStatus | Is the bank SEPA instant Credit compliant | Y or N |
| ssiAvailable | Do we have correspondent details available | 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 | This can be used in conjunction with the free token to retrieve additional details on this branch. | Alphanumeric & Extended Characters |
| freeToken | This can be used in conjunction with the bank token to retrieve additional details. | Alphanumeric & Extended Characters |
| 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 |
Test example
For example, in order to search Barclays Bank PLC from Great Britain, the details we require are:
Country Code: GB
Bank Name: Barclays Bank PLC