Verification
CDV
Validate South African account numbers using Check Digit Verification algorithms. Ensure data integrity and reduce collection failures by verifying customer identification and bank account details before processing.
Request
Verify bank account number format.
Path
POST /cdv
Request Body
{
"records": [{
"bank_branch_code": "051001",
"bank_account_number": "10004291601",
"bank_account_type": "CHEQUE_OR_CURRENT"
}]
}
Request Parameters
Field | Required | Type | Description | Example |
|---|---|---|---|---|
| *.bank_account_number | Y | String(17) | Bank account number to be collected from | 10004291601 |
| *.bank_account_type | Y | ENUM | (CHEQUE_OR_CURRENT, SAVINGS, TRANSMISSION) | CHEQUE_OR_CURRENT |
| *.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": "CHEQUE_OR_CURRENT",
"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 | ENUM | (CHEQUE_OR_CURRENT, SAVINGS, TRANSMISSION) | CHEQUE_OR_CURRENT |
| *.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 collections 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 |
Refunds
Refund a settled online card, Apple Pay or Google Pay transaction back to the cardholder. Pass the transaction ID of the original charge with a reason; full or partial amounts are supported.
AVS-R
Real-time Account Verification Service to validate bank account ownership and details before processing collections. Reduce failed transactions and fraud by confirming account holder names match provided customer information.