Withdrawal Payload Reference

JSON bodies delivered for withdrawal webhook lifecycle events. For supported events and setup, see Withdrawal webhooks. See Webhook request headers for delivery headers.

JSON

{
  "event": "COMPLETED",
  "withdrawalDetailId": "6655001000000000000000c1",
  "companyId": "6343e77d91c393456aa56462",
  "customerId": "merchant-customer-1"
}

Field	Type	Description
`event`	string	One of `SUBMITTING`, `SUBMITTED`, `BRIDGING`, `COMPLETED`, `FAILED`, `FAILED_EXPIRED`, or `REFUNDED_BY_PROVIDER`.
`withdrawalDetailId`	string	Withdrawal detail ID. Use with Get Withdrawal Detail for full status.
`companyId`	string	Your company ID.
`customerId`	string	Optional. Present when the withdrawal was created with a customer identifier.

customerId is included only when the withdrawal was created with a customer identifier.

⌘I

API

WALLET

CURRENCY

THEMES

PAY LINKS

TRANSACTIONS

SUBSCRIPTIONS

CHARGES

DEPOSITS

WITHDRAWALS

WEBHOOKS

HEADLESS PAYMENTS

ALLOW LIST

PLATFORM

EXPORTS