Create a payout

POST /api/v1/payouts

Overview

Creates an asynchronous payout and reserves the amount plus the configured fee. If address is omitted, Paybytoken uses the active payout address configured for the account and chain.

Authorization

Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY

Request Details

Request

curl https://api-prod.paybytoken.io/api/v1/payouts \
  -X POST \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY" \
  -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`).
`metadata`	object	Optional merchant-authored correlation data.

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

{
  "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"
}