Payout created

Fired when a wallet action is created and execution has begun. The action is now pending.

postWebhookwallet_action.payout.created

Payload

type'wallet_action.payout.created' required

The type of webhook event.

reference_idstring nullable

Developer-provided reference ID, if one was included in the request.

wallet_action_idstring required

The ID of the wallet action.

wallet_idstring required

The ID of the wallet involved in the action.

action_type'swap' | 'transfer' | 'earn_deposit' | 'earn_withdraw' | 'earn_incentive_claim' | 'earn_fee_collect' | 'payout' required

Type of wallet action

created_atstring required

ISO 8601 timestamp of when the wallet action was created.

provider'bridge' required

The offramp provider that settles the payout.

environment'sandbox' | 'production' required

The provider environment the payout runs against.

source_assetstring required

Source crypto asset sent on-chain (e.g. "usdc").

source_chainstring required

Source chain the crypto was sent from (e.g. "base").

source_amountstring required

Decimal amount offramped, in the asset's standard units (e.g. "100.00").

destination_fiat_account_idstring required

The registered external fiat account the payout settles to.

destination_currencystring required

The fiat currency the payout settles in (e.g. "usd").

destination_payment_railstring required

The fiat payment rail the payout settles over (e.g. "ach", "sepa", "wire").

status'pending' required

The status of the wallet action.

Example payload

{
  "environment": "sandbox"
}

Response

Return a 200 status to indicate that the webhook was received successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.