CDV Message Flow

The diagram below shows the CDV message flow, which is a synchronous flow.

cdv

  1. You send Electrum a validateIdentifierUsingCheckDigit message (CheckDigitVerficationRequest schema) containing the bank account number to be verified, and the bank branch.
CheckDigitVerificationRequest Schema
object (AccountType)
required
object (BranchIdentification)
required
object (GenericAccountIdentifier)
verificationScheme
required
string

The name of the verification scheme to be used to verify the provided data.

  1. Once the verification has been done, Electrum sends you a CheckDigitVerficationReport containing the outcome of the verification. The outcome field will be populated with PASSED, FAILED, or SKIPPED (if the verification was not done for some reason).
CheckDigitVerificationReport Schema
outcome
required
string

Indicates whether the check digit verification was successful or not.

PASSED: The provided data passed verification.

FAILED: The provided data failed verification.

SKIPPED: No verification was performed.

Enum: "PASSED" "FAILED" "SKIPPED"
object (VerificationReasonInfo)

Provides detailed information on a verification reason.

Error Handling

Error at Electrum

If there is a system or other error at Electrum after you have sent a CheckDigitVerificationRequest, then Electrum will respond with an ErrorDetail message describing the failure. No further messaging is required and the channel may retry the transaction.

Timeout at Bank

If you do not receive a CheckDigitVerificationReport from Electrum after a specified period then your system will time out. No further messaging is required. The channel may retry the transaction.

Error at Bank

If an error is encountered on your system, then you may notify the channel of the error. No further messaging is required. The client may retry the transaction.

Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.