Retrieve a payout

GET/v1/payouts/{id}

Authorization

Send your API key as a bearer token in the Authorization header. Secret API key: Authorization: Bearer ctp_live_sk_…. A publishable key (ctp_…_pk_…) is accepted by these operations only, which serve reference data: getRate, listAssets, listNetworks (each marked x-publishable-key: true). Every other operation refuses it with 403 publishable_key_not_allowed, whatever Origin the request carries: that header binds browsers, not other clients, and nothing on this API relies on it.

Path parameters

Name	Type	Description
id required	string	At most 100 characters.

Example request

cURL

curl "https://api.ctpeway.com/v1/payouts/{id}" \
  -H "Authorization: Bearer $CTPEWAY_API_KEY"

Node SDK

import { CtpeWay } from '@ctpeway/sdk';

const ctpeway = new CtpeWay(process.env.CTPEWAY_API_KEY);

const result = await ctpeway.payouts.retrieve('<id>');

Response

200 OK

Field	Type	Description
id	string
status	string	One of pending, processing, included, confirmed, failed.
network	string
asset	string
asset_id	string
contract optional	string
decimals	integer
amount	string	What the destination receives, base units of asset. A whole number written as a string of digits.
destination	string
memo optional	string
tx_hash optional	string
refund_id optional	string	Set when the payout pays a refund.
failure_code optional	string	Why a failed payout failed. Among them: canceled (canceled before it was signed), stale (not signed within two hours of being created, so given up instead of paid late), conflict (something else used the wallet’s nonce or coins first), expired (signed bytes the network never took), reverted (included, but its execution failed), chain:insufficient_funds, destination_not_payable, signer_refused:<reason>. In every case nothing was sent; failure_message says it in a sentence.
requested_by	object
requested_by.type	string	One of user, apiKey.
requested_by.id	string
created_at	string (date-time)
confirmed_at optional	string (date-time)
failed_at optional	string (date-time)
native_asset	string	Symbol of the coin the network fee is paid in.
native_decimals	integer
max_network_fee optional	string	The most the transaction may cost, base units of native_asset: what was set aside for its fee when the payout was created. A whole number written as a string of digits.
network_fee optional	string	What the transaction actually paid for its inclusion, base units of native_asset. Present once the transaction is in a block, on networks that report it; gone again if a reorganisation takes the transaction out of its block. A whole number written as a string of digits.
livemode	boolean
failure_message optional	string	What failure_code means, in a sentence for a person. Absent for codes that need no explanation.

{
  "id": "string",
  "status": "pending",
  "network": "string",
  "asset": "string",
  "asset_id": "string",
  "contract": "string",
  "decimals": 0,
  "amount": "1000000",
  "destination": "string",
  "memo": "string",
  "tx_hash": "string",
  "refund_id": "string",
  "failure_code": "string",
  "requested_by": {
    "type": "user",
    "id": "string"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "confirmed_at": "2026-01-01T00:00:00.000Z",
  "failed_at": "2026-01-01T00:00:00.000Z",
  "native_asset": "string",
  "native_decimals": 0,
  "max_network_fee": "1000000",
  "network_fee": "1000000",
  "livemode": true,
  "failure_message": "string"
}

The values are placeholders generated from the schema. They show the shape, not real data.

Errors

A failed request answers with the error format described under Errors.

Besides the codes any endpoint can return, this endpoint can answer with these code values:

• payout_not_found