Balance Webhook

Content-Type: application/json

Body

NameTypeDescription
datainterface{}Data
typestringcashout / cashin / create_payment
client_idstringClient ID

Errors

StatusMesssage
200Success
401Unauthorized

Example

Request

[POST] client-API

Response This response for Client

Cash In Webhook

{
  "data": {
    "cash_in_type": "payment",
    "status": "Completed",
    "transaction_id": "f0bc03f5-5d94-46a4-8b85-54f1765da88a",
    "business_id": 10101,
    "payment_method": "Credit Card",
    "total_amount": 1500.5,
    "net_amount": 1470.5,
    "account_id": "f0bc03f5-5d94-46a4-8b85-54f1765da88a",
    "total_fee": 30,
    "currency_code": "USD",
    "reference_id": "REF123456789",
    "request_id": "REQ123456789",
    "created_at": "2024-08-29T14:30:00",
    "reconciled_at": "2024-08-29T15:00:00",
    "settled_at": "2024-08-29T16:00:00",
    "note": "Payment for invoice INV123456"
  },
  "type": "cashin",
  "client_id": "64d1202b-ca10-49a6-82b1-3ab5c14bcbe3"
}

Cash Out Webhook

{
  "data": {
    "account_id": "8d64c7e3-9273-4a3c-9c8b-3e138979e8ea",
    "beneficiary_info": {
      "name": "John Doe",
      "bank_account": "1234567890",
      "bank_name": "Example Bank",
      "swift_code": "EXAMPUS33"
    },
    "business_id": 30303,
    "cash_out_type": "Withdrawal",
    "status": "Processing",
    "amount": 1000,
    "net_amount": 990,
    "total_fee": 10,
    "currency_code": "GBP",
    "provider_payment_number": "PPN123456",
    "created_at": "2024-08-28T10:00:00",
    "reconciled_at": null,
    "settled_at": null,
    "new_balance": 5000,
    "note": "Withdrawal request initiated",
    "request_id": "REQ654321987",
    "category_id": 40404,
    "reference_id": "REF654321987",
    "is_internal_transfer": false
  },
  "type": "cashout",
  "client_id": "64d1202b-ca10-49a6-82b1-3ab5c14bcbe3"
}

Payment Success Webhook

{
  "data": {
    "payment_id": "PAY123456789",
    "amount": 2500.75,
    "account_receiver_name": "Alice Johnson",
    "transaction_code": "TRX987654321",
    "transaction_at": 1693392000,
    "description": "Payment for order ORD456789",
    "reference_code": "REF654321987"
  },
  "type": "create_payment",
  "client_id": "64d1202b-ca10-49a6-82b1-3ab5c14bcbe3"
}