Skip to main content
WEBHOOK

Body

application/json

Payload for the wallet_action.payout.succeeded webhook event.

type
enum<string>
required

The type of webhook event.

Available options:
wallet_action.payout.succeeded
wallet_action_id
string
required

The ID of the wallet action.

wallet_id
string
required

The ID of the wallet involved in the action.

action_type
required

Type of wallet action

Available options:
swap,
transfer,
earn_deposit,
earn_withdraw,
earn_incentive_claim,
earn_fee_collect,
payout,
tmmf_deposit,
tmmf_withdraw
created_at
string
required

ISO 8601 timestamp of when the wallet action was created.

provider
enum<string>
required

The offramp provider that settles the payout.

Available options:
bridge
environment
enum<string>
required

The provider environment the payout runs against.

Available options:
sandbox,
production
Example:

"sandbox"

source_asset
string
required

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

source_chain
string
required

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

source_amount
string
required

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

destination_fiat_account_id
string
required

The registered external fiat account the payout settles to.

destination_currency
string
required

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

destination_payment_rail
string
required

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

status
enum<string>
required

The status of the wallet action.

Available options:
succeeded
steps
(EVMTransactionWalletActionStep · object | EVMUserOperationWalletActionStep · object | SVMTransactionWalletActionStep · object | TVMTransactionWalletActionStep · object | ExternalTransactionWalletActionStep · object | CustodianTransactionWalletActionStep · object | TempoZoneSettlementWalletActionStep · object | WisdomTreeSettlementWalletActionStep · object)[]
required

The steps of the wallet action, including transaction hashes; gas_credits_charged on a step may still be null when this webhook fires, so fetch the wallet action directly for up-to-date gas data.

A wallet action step consisting of an EVM transaction.

completed_at
string
required

ISO 8601 timestamp of when the wallet action completed successfully.

event_id
string
required

The ID of this event, stable across repeat deliveries so clients can deduplicate on it.

reference_id
string | null

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

Response

200

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