Skip to main content
This webhook event notifies your application about specific events happening in the system. The event contains metadata and detailed payload information.

Event Schema

FieldTypeDescription
eventTypestringType of event triggered (WITHDRAWAL)
statusstringCurrent status of the event (PENDING, SUCCESS, FAILED)
payload.entrystringTransaction entry type (DEBIT)
payload.amountnumberTransaction amount
payload.methodstringPayment method used (e.g., DEBIT_CARD, BANK_TRANSFER, VENMO, PAYPAL, PREPAID_CARD)
payload.summarystringSummary of the transaction
payload.currencystringCurrency of the transaction (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 (e.g., 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 Payload

{
  "eventType": "WITHDRAWAL",
  "status": "SUCCESS",
  "payload": {
    "entry": "DEBIT",
    "amount": 41.99,
    "method": "DEBIT_CARD",
    "summary": "Payment sent",
    "currency": "USD",
    "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"
  }
}