Beneficiary Webhooks
Beneficiary webhooks are fired when a customers adds a beneficiary
Beneficiary webhooks are fired when a customers adds a beneficiary
This is a webhook that is fired when a created beneficiary is ready to receive funds
JSON
{
"event": "beneficiary.status.changed",
"data": {
"id": "3098e923-bb2f-49eb-b802-1fb6d638f347",
"status": "success",
"reference": "6819f3ad7ef4",
"callbackUrl": null,
"companyId": "45422f21-9a0e-479e-9e10-615556448a78"
}
}
Beneficiary Status Pending
This webhook is fired immediately after you add a new beneficiary a pending webhook is sent.
JSON
{
"event": "beneficiary.status.pending",
"data": {
"companyId": "7c1cf6e0-92d7-45a4-abc8-1548ef6c0ffd",
"id": "56af31e1-e37d-4076-bb47-a1b9c762f8db",
"reference": "27dad4dfd3bb",
"status": "pending",
}
}
Beneficiary Status Success
This webhook is once the beneficiary has been added successfully.
JSON
{
"event": "beneficiary.status.success",
"data": {
"companyId": "7c1cf6e0-92d7-45a4-abc8-1548ef6c0ffd",
"id": "56af31e1-e37d-4076-bb47-a1b9c762f8db",
"reference": "27dad4dfd3bb",
"status": "success",
"callbackUrl": null,
}
}