Create a payout
Initiates a payout (crypto to fiat offramp) from a wallet to a previously registered external fiat account. Returns a pending wallet action; the crypto transfer and fiat settlement are processed asynchronously.
Authorizations
Basic Auth header with your app ID as the username and your app secret as the password.
Headers
ID of your Privy app.
Request authorization signature. If multiple signatures are required, they should be comma separated.
Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed.
Idempotency keys ensure API requests are executed only once within a 24-hour window.
Path Parameters
The ID of the wallet.
Body
Response
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.
The ID of the wallet action.
The current status of the wallet action.
pending, succeeded, rejected, failed The ID of the wallet involved in the action.
ISO 8601 timestamp of when the wallet action was created.
payout Supported fiat orchestration providers.
bridge The Privy API environment.
sandbox, production "sandbox"
The source crypto asset, chain, and amount for a payout.
The destination bank account for a payout.
Top-level failure context for the wallet action. Present on rejected or failed actions when available.
The steps of the wallet action. Only returned if ?include=steps is provided.
A wallet action step consisting of an EVM transaction.
- EVMTransactionWalletActionStep
- EVMUserOperationWalletActionStep
- SVMTransactionWalletActionStep
- TVMTransactionWalletActionStep
- ExternalTransactionWalletActionStep
- CustodianTransactionWalletActionStep

