Specification
CDV
Check Digit Verification
Request
Verify bank account numbers.
Path
POST /cdv
Request Body
{
"records": [{
"bank_branch_code": "051001",
"bank_account_number": "10004291601",
"bank_account_type_lookups_id": "loo_abc123..."
}]
}
Request Parameters
Field | Required | Type | Description | Example |
|---|---|---|---|---|
| *.bank_account_number | Y | String(17) | Bank account number to be collected from | 10004291601 |
| *.bank_account_type_lookups_id | Y | String(32) | Lookups ID relating to a bank account e.g. Cheque. Lookups type must be 'Bank Account' | loo_abc123... |
| *.bank_branch_code | Y | Integer | Bank branch code for the account number | 632005 |
Response Body
{
"status": true,
"results": [{
"passed": true,
"bank_branch_code": "051001",
"bank_account_number": "10004291601",
"bank_account_type_lookups_id": "68a867b92289b4423ea853e0b1cd1013",
"modified_bank_account_number": null,
"warning": null,
"error": null
}, ...]
}
Response Parameters
Field | Type | Description | Example |
|---|---|---|---|
| *.passed | Boolean | true - The bank account number is valid | true |
| *.bank_account_number | String(17) | Bank account number to be collected from | 10004291601 |
| *.bank_account_type_lookups_id | String(32) | Lookups ID relating to a bank account e.g. Cheque. Lookups type must be 'Bank Account' | loo_abc123... |
| *.bank_branch_code | Integer | Bank branch code for the account number | 632005 |
| *.modified_bank_account_number | String(17) | Some bank accounts numbers need to be modified before submitting to the bank. Like dropping the most significant bit for Unibank. If this field is not null you should use this bank account number for making payments instead. | |
| *.warning | String(128) | Any warning messages associated with this bank account | Debits into savings is not allowed |
| *.error | String(128) | Any formatting error preventing the CDV from being calculated. | Invalid branch code range |