Skip to main content
WEBHOOK

Body

application/json

Payload delivered for the funds.withdrawal_complete webhook event.

type
string
required

Webhook event identifier.

Allowed value: "funds.withdrawal_complete"
transaction_id
string
required

Opaque withdrawal transaction identifier.

user_id
string
required

Canonical identifier for a user in the Payward public API.

Required string length: 14 - 42
account_id
string
required

Canonical identifier for an account in the Payward public API.

Required string length: 14 - 42
amount
FundsWithdrawalAssetAmount · object

When amount.asset equals fee.asset, the gross withdrawal amount, inclusive of the fee. When the fee uses another asset, the withdrawal amount in its own asset. PWS reports it when the source value can be resolved to a public asset.

fee
FundsWithdrawalAssetAmount · object

Fee charged for the withdrawal. When the fee uses a different asset from amount, PWS reports it separately. PWS reports it independently when the value can be resolved to a public asset.

Response

2XX

Delivery endpoint accepted the webhook.