Endpoint: https://api.validate.bankersalmanac.com/conversion
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/conversion
Overview
This endpoint breaks an IBAN down into all the relevant fields and provides the branch and head office details.
Endpoint inputs
The request input requires the IBAN for which will be provided the details:
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| accountNumber | Domestic Account Number, BBAN or IBAN | Alphanumeric | Mandatory |
Response modifications
The response will contain the branch and head office details for the IBAN inserted:
| Field Name | Description | Format |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N |
| 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 |
| branchDetails | ||
| 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 |
| headOfficeDetails | ||
| 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 |
| paymentBicDetails | ||
| 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/conversion
| Field Name | Description | Format | ||
| countryCode | Country Code | Alpha | ||
| IBAN | IBAN | Alphanumeric | ||
| BBAN | BBAN | Alphanumeric | ||
| nationalId | Bank code entered in the search | Alphanumeric | ||
| accountNumber | Account number entered in the search | Alphanumeric | ||
| BIC11 | 11 characters BIC | Alphanumeric | ||
| BIC8 | 8 characters BIC | Alphanumeric | ||
| status | Status of the response PASS, CAUTION or FAIL | Alpha | ||
| statusCode | Error code | Alpha | ||
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | ||
| comment | Description of the status | Alpha | ||
| ref | Reference | Alphanumeric & Extended Characters | ||
| group | The group name that this data should be saved in. | Alphanumeric | ||
| 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 | ||
| branchDetails | ||||
| 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 | ||
| ctStatus | Is the bank SEPA credit transfer compliant | YES or NO | ||
| ddStatus | Is the bank SEPA direct debit compliant | YES or NO | ||
| bbStatus | Is the bank SEPA B2B direct debit compliant | YES or NO | ||
| ctStatus | Is the bank SEPA instant Credit compliant | YES or NO | ||
| 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 | ||
| headOfficeDetails | ||||
| 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 | ||
| paymentBicDetails | ||||
| branchTypeLabel | Branch Type | Alpha | ||
| bankName | Bank Name | Alpha | ||
| branch | Branch | Alpha | ||
| street | Street | Alpha | ||
| city | City | Alpha | ||
| postZip | Zip Code | Alpha | ||
| region | Region | Alpha | ||
| country | Country | Alpha | ||
| paymentBicDetails.codeDetails | ||||
| 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 | ||
| paymentBicDetails.additionalData | ||||
| 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
"accountNumber": "GB50LOYD30940801638696"