Get Payout

GET /api/v1/payouts/:id

Overview

Retrieves the details of a specific payout using its unique identifier. This endpoint returns the current state of the payout.

Authorization

Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY

Request Details

Parameter	Type	Description
`id`	string	Unique identifier of the payout (e.g., `pout_t24cg6MLdv1PgUiO`).

The response returns the Payout together with its public token configuration, related merchant balance transaction when available, and an ordered activity summary. activities records creation and a terminal settlement or failure; use the Payout status as the canonical current state.

Example Response

{
  "id": "pout_t24cg6MLdv1PgUiO",
  "account_id": "acct_1",
  "chain": "base",
  "amount": "5.0",
  "currency": "USDC",
  "destination_address": "0xB3906750209897ee480AcfA6cE64538ED0dB5A42",
  "metadata": null,
  "status": "succeeded",
  "payout_type": "manual",
  "requires_approval": 0,
  "tx_hash": "0x26cd67e2959c40b4f7257a0c12d0a5c08151bef0f10e71bf8985d4fb23274d49",
  "error_message": null,
  "created_at": "2025-09-05T14:04:55.000Z",
  "updated_at": "2025-09-05T14:05:10.000Z",
  "token": {
    "id": "tok_base_usdc",
    "currency": "USDC",
    "chain": "base",
    "decimals": 6,
    "name": "USD Coin",
    "chain_id": 8453,
    "chain_name": "Base"
  },
  "balance_transaction": {
    "id": "btx_payout_1",
    "account_id": "acct_1",
    "balance_id": "bal_base_usdc",
    "amount": "-5.0",
    "currency": "USDC",
    "chain": "base",
    "fee": "0.05",
    "total": "-5.05",
    "type": "debit",
    "resource_type": "payout",
    "resource_id": "pout_t24cg6MLdv1PgUiO"
  },
  "activities": [
    {
      "type": "created",
      "id": "pout_t24cg6MLdv1PgUiO",
      "destination_address": "0xB3906750209897ee480AcfA6cE64538ED0dB5A42",
      "datetime": "2025-09-05T14:04:55.000Z"
    },
    {
      "type": "settled",
      "amount": "5.0",
      "currency": "USDC",
      "chain": "base",
      "from_address": "0x4A7F8B8c6f6F74D1C8660D7DdC2d3A84710B97b5",
      "to_address": "0xB3906750209897ee480AcfA6cE64538ED0dB5A42",
      "transaction_hash": "0x26cd67e2959c40b4f7257a0c12d0a5c08151bef0f10e71bf8985d4fb23274d49",
      "datetime": "2025-09-05T14:05:10.000Z"
    }
  ]
}

Get Payout

Overview

Authorization

Request

Request Parameters

Response

Example Response

On this page

Full Explorer