Withdrawal Updated

Payload

{
  "api_version": "v1",
  "data": {
    "amount": 6.9,
    "created_at": "2023-12-01T05:00:00.401Z",
    "currency": "usd",
    "error_code": "account_closed",
    "error_message": "Destination bank account is invalid.",
    "estimated_availability": "2023-12-01T05:00:00.401Z",
    "fee_amount": 6.9,
    "fee_type": "exclusive",
    "id": "wdrl_xxxxxxxxxxxxx",
    "ledger_account": {
      "company_id": "string",
      "id": "ldgr_xxxxxxxxxxxxx"
    },
    "markup_fee": 6.9,
    "payout_token": {
      "created_at": "2023-12-01T05:00:00.401Z",
      "destination_currency_code": "USD",
      "id": "potk_xxxxxxxxxxxxx",
      "nickname": "My Business Account",
      "payer_name": "Acme Corp LLC"
    },
    "speed": "standard",
    "status": "requested",
    "trace_code": "021000021234567"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "withdrawal.updated"
}

Sent when a withdrawal is updated

Required permissions:

payout:withdrawal:read
payout:destination:read
webhook_receive:withdrawals

Payload

The payload of this webhook request is an object.

api_version"v1"Required

The API version for this webhook

dataobjectRequired

A withdrawal represents a request to transfer funds from a ledger account to an external payout method.

idstringRequired

A unique ID for every single webhook request

timestampdatetimeRequired

The timestamp in ISO 8601 format that the webhook was sent at on the server

type"withdrawal.updated"Required

The webhook event type

company_idstring or nullOptional

The company ID that this webhook event is associated with

Response

200

Return a 200 status to indicate that the data was received successfully

Headers

Payload

Response