Skip to main content
POST
Create a payout

Authorizations

Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id
string
required

ID of your Privy app.

privy-authorization-signature
string

Request authorization signature. If multiple signatures are required, they should be comma separated.

privy-request-expiry
string

Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed.

privy-idempotency-key
string

Idempotency keys ensure API requests are executed only once within a 24-hour window.

Path Parameters

wallet_id
string
required

The ID of the wallet.

Body

application/json

Request body for initiating a payout (crypto to fiat offramp) from a wallet.

source
PayoutSource · object
required

The source crypto asset, chain, and amount for a payout.

destination
PayoutDestination · object
required

The destination bank account for a payout.

Response

200 - application/json

The created payout wallet action.

A payout wallet action. Crypto is sent on-chain to a liquidation address that offramps to the destination bank account.

id
string
required

The ID of the wallet action.

status
enum<string>
required

The current status of the wallet action.

Available options:
pending,
succeeded,
rejected,
failed
wallet_id
string
required

The ID of the wallet involved in the action.

created_at
string<date-time>
required

ISO 8601 timestamp of when the wallet action was created.

type
enum<string>
required
Available options:
payout
provider
enum<string>
required

Supported fiat orchestration providers.

Available options:
bridge
environment
enum<string>
required

The Privy API environment.

Available options:
sandbox,
production
Example:

"sandbox"

source
PayoutSource · object
required

The source crypto asset, chain, and amount for a payout.

destination
PayoutDestination · object
required

The destination bank account for a payout.

failure_reason
FailureReason · object

Top-level failure context for the wallet action. Present on rejected or failed actions when available.

steps
(EVMTransactionWalletActionStep · object | EVMUserOperationWalletActionStep · object | SVMTransactionWalletActionStep · object | TVMTransactionWalletActionStep · object | ExternalTransactionWalletActionStep · object | CustodianTransactionWalletActionStep · object)[]

The steps of the wallet action. Only returned if ?include=steps is provided.

A wallet action step consisting of an EVM transaction.