Skip to main content
This webhook event notifies your application when withdrawal (payout) events occur. You receive events for PENDING, SUCCESS, and FAILED statuses.

​
Event Schema

FieldTypeDescription
eventTypestringType of event triggered (WITHDRAWAL)
statusstringCurrent status: PENDING, SUCCESS, or FAILED
payload.entrystringTransaction entry type (DEBIT)
payload.amountnumberTransaction amount
payload.methodstringPayment method (e.g., DEBIT_CARD, BANK_TRANSFER)
payload.summarystringSummary of the transaction
payload.currencystringCurrency (e.g., USD)
payload.entityIdstringID of the associated business or user
payload.walletIdstringUnique identifier of the wallet
payload.timestampnumberTimestamp of the event (in milliseconds)
payload.entityTypestringType of entity (USER, BUSINESS)
payload.descriptionstringDescription of the transaction
payload.transactionIdstringInternal transaction identifier
payload.paymentLinkobjectPayment link details associated with the withdrawal
payload.paymentLink.idstringUnique identifier of the payment link
payload.paymentLink.tokenstringToken for the payment link
payload.paymentLink.externalIdstringClient-provided identifier for the end user
payload.paymentLink.customDataobjectCustom metadata provided when creating the payment link
payload.feeChargedstringFee charged for the transaction

​
Example: PENDING

Sent when a withdrawal is initiated. 
{
  "eventType": "WITHDRAWAL",
  "status": "PENDING",
  "payload": {
    "description": "Withdrawal initiated",
    "method": "DEBIT_CARD",
    "transactionId": "7794112b-094e-443d-8454-7192aee10557",
    "walletId": "44805633-c437-4140-a312-0e626c6feb19",
    "entityId": "9b5e1e96-5796-4648-94d4-62253728291e",
    "entityType": "USER",
    "summary": "Withdrawal initiated",
    "entry": "DEBIT",
    "amount": 20.87,
    "currency": "USD",
    "timestamp": 1771347620788,
    "feeCharged": "2.04174"
  }
}

​
Example: SUCCESS

Sent when the withdrawal has completed successfully. 
{
  "eventType": "WITHDRAWAL",
  "status": "SUCCESS",
  "payload": {
    "description": "Payment sent",
    "method": "DEBIT_CARD",
    "transactionId": "7794112b-094e-443d-8454-7192aee10557",
    "walletId": "44805633-c437-4140-a312-0e626c6feb19",
    "entityId": "9b5e1e96-5796-4648-94d4-62253728291e",
    "entityType": "USER",
    "summary": "Payment sent",
    "entry": "DEBIT",
    "amount": 20.86826,
    "currency": "USD",
    "timestamp": 1771347630113,
    "paymentLink": {},
    "feeCharged": "2.04174"
    "entityId": "xxxxx-38de-4c75-a55e-049504783dec",
    "walletId": "xxxxx-bc92-4baa-aedb-d989c96f6ad8",
    "timestamp": 1766131682806,
    "entityType": "USER",
    "description": "Payment sent",
    "transactionId": "3136342d-0bdc-40ab-9867-04c6eb9e977d",
    "paymentLink": {
      "id": "70475cd7-f610-4d3b-8016-xxxx",
      "token": "sATV6OtvtVejkLRdCi2tHBl_xxxx",
      "externalId": "HVejkLRdCi2tHBl_xxxx",
      "customData": {}
    },
    "feeCharged": "1.4"
  }
}

​
Example: FAILED

Sent when the withdrawal fails. 
{
  "eventType": "WITHDRAWAL",
  "status": "FAILED",
  "payload": { }
}