Create Payout

POST /v1/payouts

Overview

Creates a new payout to transfer funds to a specified destination address. This endpoint generates a payout request with the provided amount and blockchain details.

Authorization

• Header: Authorization: Bearer sk_test_907...de66

Request Details

Request

cURL

curl https://api-prod.paybytoken.io/v1/payouts \
  -X POST \
  -H "Authorization: Bearer sk_test_907...de66" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "5",
    "currency": "USDC",
    "chain": "base",
    "address": "0xB3906750209897ee480AcfA6cE64538ED0dB5A42"
  }'

Request Parameters

Parameter	Type	Description
amount	string	The amount to be paid out (e.g., "5").
currency	string	The currency code (e.g., "USDC").
chain	string	The blockchain chain (e.g., "base").
address	string	The destination address for the payout (e.g., 0xB3906750209897ee480AcfA6cE64538ED0dB5A42).

Response Details

Response

The response returns a Payout object containing details about the created payout. See Payouts Overview for the full object definition.

Example Response

Success

{
  "id": "pout_t24cg6MLdv1PgUiO",
  "account_id": "acct_1",
  "chain": "base",
  "amount": "5.0",
  "currency": "USDC",
  "destination_address": "0xB3906750209897ee480AcfA6cE64538ED0dB5A42",
  "metadata": null,
  "status": "pending",
  "payout_type": "manual",
  "requires_approval": 0,
  "tx_hash": null,
  "error_message": null,
  "created_at": "2025-09-05T14:04:55.000Z",
  "updated_at": "2025-09-05T14:04:55.000Z"
}