| Event | Description | Default |
|---|---|---|
| payee_verification.completed | Triggered when a verification finishes with verification_status of valid or invalid | on |
| payee_verification.failed | Triggered when a verification fails to complete (e.g. provider timeout or error) - no fee is charged for this outcome | on |
not_supported does not trigger either event, since no verification attempt actually ran.
Sample Events
payee_verification.completed
JSON
{
"type": "payee_verification.completed",
"id": "evt_d6a633obm14biavhciig",
"object": "event",
"created_at": "2026-04-07T10:00:05Z",
"data": {
"id": "pyv_d6a633obm14biavhcia0",
"object": "payee_verification",
"verification_status": "valid",
"status_description": "",
"beneficiary": "bnf_d6a633ogm14biavhci0g",
"beneficiary_details": {
"name": "John Doe",
"type": "individual",
"destination_details": {
"type": "bank",
"bank": {
"account_number": "9876543210",
"account_type": "savings",
"bank_codes": {
"ifsc_code": "HDFC0001234"
},
"bank_name": "HDFC Bank",
"country": "IN",
"currency": "INR"
}
}
},
"verified_information": {
"name_match_details": {
"type": "continuous",
"value": 0.97,
"summary": "strong_match"
},
"account_exists": true,
"beneficiary_type": "individual"
},
"balance_transaction": {
"holding_currency": "USD",
"balance_impact": -10,
"balance_transaction_id": "btr_d6a633obm14biavhci90"
},
"created_at": "2026-04-07T10:00:00Z",
"updated_at": "2026-04-07T10:00:05Z"
}
}
JSON
{
"type": "payee_verification.failed",
"id": "evt_d6a633pcn24biavhcj20",
"object": "event",
"created_at": "2026-04-07T10:00:05Z",
"data": {
"id": "pyv_d6a633pcn24biavhcj30",
"object": "payee_verification",
"verification_status": "failed",
"status_description": "Verification provider unavailable",
"beneficiary": "",
"beneficiary_details": {
"name": "John Doe",
"type": "individual",
"destination_details": {
"type": "bank",
"bank": {
"account_number": "9876543210",
"country": "IN",
"currency": "INR"
}
}
},
"created_at": "2026-04-07T10:00:00Z",
"updated_at": "2026-04-07T10:00:00Z"
}
}