Beneficiary Verification Status

This event is triggered when Nium has successfully verified the bank account details of the beneficiary as verified or not_verified.

📌

IMPORTANT

Transactions to this beneficiary can still be returned due to several reasons, such as compliance reject, bank reject, account closed, or other reasons.

https://<customerHost:Port>/webhook

Header

FieldDescription
Content-Typeapplication/json

Request example

curl --location --request POST 'https://<customerHost:Port>/webhook' \
-H 'content-type: application/json' \
-d '{
  "accountValidationId": "656863213342c9bccac25aef",
  "status": "verified",
  "template": "BENEFICIARY_VERIFICATION_STATUS",
  "tags": [
    {
      "key": "Transaction Reference Number",
      "value": "TR1234"
    }]
}'

Request body

FieldsDescriptionType
accountValidationIdThe unique client identifier that's generated and shared after calling Account verification (Confirmation of Payee) APIString
beneficiaryAccountNameThis field shows the payee name associated with the bank account. This is an optional field.String
statusThis field indicates the status of the of account validation. The value for this field is verified or not_verified.Boolean
templateThe value for this field is BENEFICIARY_VERIFICATION_STATUS.String