Endpoint: https://api.validate.bankersalmanac.com/bank/account-number
Swager link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bankAccountNumber
Overview
To validate an account number once you have completed a bank name search you will need to take the Free Token from the repose and Bank Token from the branch that your client identified and use these with the clients account number to validate the full bank details.
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| accountNumber | Domestic Account Number, BBAN or IBAN | Alphanumeric | Mandatory | |
| bankToken | Token that defined the bank branch from a validation call. | Alphanumeric & Extended Characters | Mandatory | |
| freeToken | Free token generated for supplementary calls. These are from the primary service calls. | Alphanumeric & Extended Characters | Mandatory | |
| group | The group name that this data should be saved in. | Alphanumeric | Optional | |
| ref | Reference | Alphanumeric & Extended Characters | 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.sepaDetails | ||
| ctStatus | Is the bank SEPA direct debit compliant | Y or N |
| ddStatus | Is the bank SEPA B2B direct debit compliant | Y or N |
| bbStatus | Is the bank SEPA instant Credit compliant | Y or N |
| branchDetails.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 |
| sepa details | ||
| ctStatus | Is the bank SEPA direct debit compliant | Y or N |
| ddStatus | Is the bank SEPA B2B direct debit compliant | Y or N |
| bbStatus | Is the bank SEPA instant Credit compliant | Y or N |
| additional 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 |
| 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 |
| bic8 | Is bic8 flag ? | Y or N |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N |
| noBranch | Should not return branch details? If Y, will not show branches. Only HO and payment branch. | Y or N |
| isoAddr | Is field size restricted to ISO defined 70 characters? Fields: BankName, Branch, street, city, postzip, region, count | Y or N |
| payBranchType | Branch type | I IBAN, R Routing, B Branch , P Payment, H Head Office |
Response outcomes
To understand the responses, please refer to Swagger – https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/bankAccountNumber
| Field Name | Description | Format | ||
| nationalId | Bank code based from given bank token | Alphanumeric | ||
| accountNumber | Given account number | Alphanumeric | ||
| status | Status of the response PASS, CAUTION or FAIL | Alpha | ||
| comment | Description of the status | Alpha | ||
| recommendedNatId | Our recommended national id | Alphanumeric | ||
| recommendedAcct | Our recommended account number | Alphanumeric | ||
| recommendedBIC | Our recommended BIC | Alphanumeric | ||
| ref | Reference | Alphanumeric & Extended Characters | ||
| group | The group name that this data should be saved in. | Alphanumeric | ||
| 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 | ||
| bankToken | Bank token | Alphanumeric & Extended Characters | ||
| branchDetails.codeDetails | ||||
| codeName1 | Branch BIC label | Alpha | ||
| codeValue1 | Branch BIC value | Alphanumeric | ||
| codeName2 | CHIPS field | Alpha | ||
| codeValue2 | CHIPS code for the branch | Alpha | ||
| codeName3 | Branch BIC-4 label | Alphanumeric | ||
| codeValue3 | Branch BIC-4 value | Alphanumeric | ||
| codeName4 | Name of the domestic Clearing Code | Alpha | ||
| codeValue4 | Domestic Clearing Code | Alpha | ||
| branchDetails.sepaDetails | ||||
| ctStatus | Is the bank SEPA direct debit compliant | Y or N | ||
| ddStatus | Is the bank SEPA B2B direct debit compliant | Y or N | ||
| bbStatus | Is the bank SEPA instant Credit compliant | Y or N | ||
| branchDetails.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 | ||
| 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 | ||
| headOfficeDetails.codeDetails | ||||
| codeName1 | Branch BIC label | Alpha | ||
| codeValue1 | Branch BIC value | Alphanumeric | ||
| codeName2 | CHIPS field | Alpha | ||
| codeValue2 | CHIPS code for the branch | Alpha | ||
| codeName3 | Branch BIC-4 label | Alphanumeric | ||
| codeValue3 | Branch BIC-4 value | Alphanumeric | ||
| codeName4 | Name of the domestic Clearing Code | Alpha | ||
| codeValue4 | Domestic Clearing Code | Alpha | ||
| sepa details | ||||
| ctStatus | Is the bank SEPA direct debit compliant | Y or N | ||
| ddStatus | Is the bank SEPA B2B direct debit compliant | Y or N | ||
| bbStatus | Is the bank SEPA instant Credit compliant | Y or N | ||
| additional 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 | ||
| paymentBicDetails | ||||
| 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 | ||
| paymentBicDetails.codeDetails | ||||
| codeName1 | Branch BIC label | Alpha | ||
| codeValue1 | Branch BIC value | Alphanumeric | ||
| codeName2 | CHIPS field | Alpha | ||
| codeValue2 | CHIPS code for the branch | Alpha | ||
| codeName3 | Branch BIC-4 label | Alphanumeric | ||
| codeValue3 | Branch BIC-4 value | Alphanumeric | ||
| 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 | ||
| bic8 | Is bic8 flag ? | Y or N | ||
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | ||
| noBranch | Should not return branch details? If Y, will not show branches. Only HO and payment branch. | Y or N | ||
| isoAddr | Is field size restricted to ISO defined 70 characters? Fields: BankName, Branch, street, city, postzip, region, count | Y or N | ||
| payBranchType | Branch type | I IBAN, R Routing, B Branch , P Payment, H Head Office | ||
| freeToken | Free token generated for supplementary calls. These are from the primary service calls. | Alphanumeric & Extended Characters |
Test Example
“accountNumber”: “GB50LOYD30940801638696”,
“bankToken”