API Reference

Deposit Webhooks

This page shows webhooks for deposits. Webhooks for deposit are a mechanism for receiving real-time notifications about events related to deposit transactions.

Deposit Completed

These webhooks are for deposits into the business main wallets

{
   "id": "e64488ba-906b-4717-9e33-cd18fa5c8f8b",
   "event": "deposit.completed",
   "resource_type": "deposit",
   "data": {
      "amount": {
         "amount": 20,
         "currency": "USD",
         "symbol": ""
      },
      "business_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
      "cancel_reason": null,
      "completed_at": null,
      "compliance_notes": null,
      "compliance_status": "pending",
      "created_at": "2024-04-19T11:17:29.463479Z",
      "deposited_amount": {
         "amount": 20,
         "currency": "USD",
         "symbol": ""
      },
      "id": "e64488ba-906b-4717-9e33-cd18fa5c8f8b",
      "initiated_amount": {
         "amount": 20,
         "currency": "USD",
         "symbol": ""
      },
      "is_date_updated": false,
      "markup": null,
      "method": "wire_transfer",
      "reference": "bacc_2YXIrz8DOjVSuSlx7SID3QYjva9",
      "status": "completed",
      "transaction_type": "deposit",
      "updated_at": "2024-04-19T11:17:29.473887Z"
   },
   "live": false,
   "timestamp": 1713521972
}

Deposit into Virtual Accounts

These webhooks are for deposits into the virtual accounts created for customers

{
   "id": "e64488ba-906b-4717-9e33-cd18fa5c8f8b",
   "event": "payment",
   "resource_type": "deposit",
   "data": {
    "id": "123456",
    "customer_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
    "business_id": "bfa03a8b-7963-432c-870d-1615e1ade10f",
    "reference": "842ccb30-2b7b-437e-b991-e1320c3b0fb9",
    "currency": "USD",
    "amount": 1000.50,
    "deposited_amount": 1000.50,
    "deposited_currency": "USD",
    "channel": "bank_transfer",
    "depositor_details": null,
    "created_at": "2024-05-22T14:48:00Z",
    "status": "completed"
   },
   "live": false,
   "timestamp": 1713521972
}

{
   "id": "e64488ba-906b-4717-9e33-cd18fa5c8f8b",
   "event": "payment",
   "resource_type": "deposit",
   "data": {
    "id": "123456",
    "customer_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
    "business_id": "bfa03a8b-7963-432c-870d-1615e1ade10f",
    "reference": "842ccb30-2b7b-437e-b991-e1320c3b0fb9",
    "currency": "GBP",
    "amount": 1000.50,
    "deposited_amount": 1000.50,
    "deposited_currency": "GBP",
    "channel": "bank_transfer",
    "depositor_details": {
   		 "name": "John Doe",
   		 "swift_code": "SWIFT1234",
   		 "sort_code": "",
   		 "bank_name": "",
   		 "account_number": "",
   		 "iban": "GB82WEST12345698765432"
		},
    "created_at": "2024-05-22T14:48:00Z",
    "status": "completed"
   },
   "live": false,
   "timestamp": 1713521972
}