Transfers
This section describes transfer notifcations
Available Transfer Events
EVENT | DESCRIPTION |
---|---|
banking.transfer.created | A new transfer request has been initiated on your account. |
banking.transfer.processing | The transfer has been approved and is now in processing |
banking.transfer.cancelled | The previously initiated transfer has been cancelled |
banking.transfer.completed | The transfer has been successfully completed and funds have been transferred from your account |
banking.transfer.failed | The transfer has failed, and the transfer could not be completed |
Sample Transfer Event
{
"id": "0196910c-ea1b-7e35-bfa1-9dd5cacd76f8",
"event": "banking.transfer.completed",
"timestamp": 1746189127535,
"data": {
"id": "019648f3-44ae-7e26-8cdd-92fab31c52de",
"state": "COMPLETED",
"status_description": "Transfer completed successfully",
"created_date": "2025-04-18T12:50:24.559Z",
"updated_date": "2025-04-18T12:50:27.389Z",
"completion_date": "2025-04-18T12:50:27.045Z",
"internal_reference": "wz-payout-HTEb-1744980624557",
"client_metadata": {},
"account_id": "01958a45-02ba-7d3e-beeb-3a65d97230ab",
"source_amount": {
"value": 20000,
"currency": "USD"
},
"total_fees": {
"value": 100,
"currency": "USD"
},
"destination_amount": {
"value": 20000,
"currency": "USD"
},
"reason": "Business Payments",
"payment_reference": "293389483-009",
"beneficiary": {
"id": "019638b9-c63d-76c6-91f6-a7ccec3707ed",
"type": "SWIFT",
"name": "Emmanuel Igbodudu",
"country_code": "US",
"kind": "BUSINESS",
"bank_account": {
"bank_name": "Revolut ltd",
"swift_code": "REVOGB21",
"account_number": "GB34REVO00997019274916"
}
},
"sender_reference": "293389483-009",
"provider_references": [],
"balance_before": {
"value": 320000,
"currency": "USD"
},
"balance_after": {
"value": 300000,
"currency": "USD"
}
}
}
Transfer Event Schema Definition
Field | Data Type | Description |
---|---|---|
id | string | Unique identifier for the webhook event (UUID format) |
event | string | Type of event see transfer events |
timestamp | number | Unix timestamp in milliseconds when the event was generated |
data | object | An object containing the transfer data. See transfer Schema |
Updated 2 months ago