Skip to main content

Webhook Callback

After the customer completes the card verification flow on the hosted verification page, a webhook callback is sent to the cardVerifyHookUrl specified when creating the verification session.

Webhook Payload

{
"success": true,
"session_id": "c9dac86d-be60-42b5-bcdd-76950de46654",
"card_number": "412345XXXXXX2345",
"is_verified": false,
"cardholder_name": "JOHN DOE"
}

Fields

FieldTypeDescription
successbooleanIndicates whether the verification process completed successfully.
session_idstringUnique identifier for the verification session. Matches the session_id from the verify_url.
card_numberstringMasked card number for reference.
is_verifiedbooleantrue if the card was successfully verified, false otherwise.
cardholder_namestringName of the cardholder as entered during verification.

Handling the Webhook

  1. Verify the webhook — Use the Verify Webhook endpoint to validate the authenticity of the callback.
  2. Check is_verified — If true, the card can now be used for withdrawal and other protected operations.
  3. Update your records — Store the verification status against the corresponding customer and card.