Fiat

Create a payout

Changed on

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.

post/v1/wallets/{wallet_id}/payout/fiat

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/wallets/{wallet_id}/payout/fiat
  • Auth
    HTTP basic

Path parameters

wallet_idstring required

The ID of the wallet.

Headers

privy-app-idstring required

ID of your Privy app.

privy-authorization-signaturestring

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

privy-request-expirystring

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

privy-idempotency-keystring

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

Request body

developer_fee_percentstring

A fee your app keeps on the payout, as a percentage of the payout amount. Omit for no fee.

Example request

{
  "developer_fee_percent": "1.5"
}

Response

The created payout wallet action.

idstring required

The ID of the wallet action.

status'pending' | 'succeeded' | 'rejected' | 'failed' required

The current status of the wallet action.

wallet_idstring required

The ID of the wallet involved in the action.

created_atstring date-time required

ISO 8601 timestamp of when the wallet action was created.

reference_idstring nullable

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

type'payout' required
provider'bridge' required

Supported fiat orchestration providers.

environment'sandbox' | 'production' required

The Privy API environment.

developer_fee_percentstring required

The fee your app keeps on the payout, as a percentage. "0" when none was set.

Example response

{
  "steps": [
    {
      "gas_credits_charged": {
        "value": "100.00",
        "currency": "usd"
      }
    }
  ],
  "environment": "sandbox",
  "developer_fee_percent": "1.5"
}

Changes

  • f09c8fa8dbc4Revision changes
    • info

      added the new optional request property

  • 527110c2c2f4Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      response property steps/items/oneOf[subschema #1: EVMTransactionWalletActionStep]/gas_credits_charged_usd deprecated

    • info

      response property steps/items/oneOf[subschema #2: EVMUserOperationWalletActionStep]/gas_credits_charged_usd deprecated

    • info

      response property steps/items/oneOf[subschema #3: SVMTransactionWalletActionStep]/gas_credits_charged_usd deprecated

    • info

      response property steps/items/oneOf[subschema #4: TVMTransactionWalletActionStep]/gas_credits_charged_usd deprecated