Bank Batch Cleansing
Data must be provided in a csv file, containing the following columns.
Column | Type | Required | Description |
---|---|---|---|
id | string | A unique identifier for the row | |
sort_code | string | ✔️ | The sort code of the bank account |
account_number | string | ✔️ | The account number of the bank account |
It is possible to perform more than one type of cleanse on a single CSV file. For example, a bank cleanse could be run on a file, followed by an address cleanse. Make sure that all the required columns are included for each cleanse you wish to perform. The columns can be included in any order. Fields can be left blank if the column is not applicable.
Cleansed File
The returned file will contain the provided columns, and the following:
bank_match_status
bank_error_codes
cleansed_sort_code
cleansed_account_number
The bank_match_status
column will contain the status of the cleanse.
Status | Description |
---|---|
full_match | The bank account was found and is a perfect match |
no_match | The provided bank account is not valid |
error | There was an error with the bank cleanse |
The bank_error_codes
column will contain a comma separated list of reasons why the cleanse wasn't a full match
account_number
Error | Description |
---|---|
account_number_invalid_format | The provided account number is not in a valid format |
account_number_not_found | The provided account number was not found |
sort_code
Error | Description |
---|---|
sort_code_invalid_format | The provided sort code is not in a valid format |
sort_code_not_found | The provided sort_code was not found |