List refunds

GET/v1/refunds

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.

Query parameters

Name	Type	Description
limit	integer	Number of items to return (1 to 100). Default 50. Minimum 1, maximum 100.
starting_after	string	Return items after this id: pass next_cursor of the previous page. At most 100 characters.
status	string	One of pending, completed, failed.
payment_id	string	At most 100 characters.
invoice_id	string	At most 100 characters.

Example request

cURL

curl "https://api.ctpeway.com/v1/refunds" \
  -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.refunds.list();

Response

200 OK

Field	Type	Description
data	array of objects
data[].id	string
data[].status	string	One of pending, completed, failed.
data[].payment_id	string
data[].invoice_id optional	string
data[].payout_id optional	string
data[].network	string
data[].asset	string
data[].asset_id	string
data[].contract optional	string
data[].decimals	integer
data[].amount	string	Base units of asset, the asset of the refunded payment. A whole number written as a string of digits.
data[].destination	string
data[].reason	string
data[].tx_hash optional	string
data[].failure_code optional	string
data[].created_at	string (date-time)
data[].completed_at optional	string (date-time)
data[].failed_at optional	string (date-time)
data[].livemode	boolean
data[].simulated	boolean	true: the refund of a simulated payment (test mode). It was played, not paid: no payout, no transaction, and tx_hash is a sim_… placeholder.
data[].failure_message optional	string	What failure_code means, in a sentence for a person. Absent for codes that need no explanation.
has_more	boolean	Whether more items exist after this page.
next_cursor	string or null	Pass as starting_after to get the next page; null on the last page.

{
  "data": [
    {
      "id": "string",
      "status": "pending",
      "payment_id": "string",
      "invoice_id": "string",
      "payout_id": "string",
      "network": "string",
      "asset": "string",
      "asset_id": "string",
      "contract": "string",
      "decimals": 0,
      "amount": "1000000",
      "destination": "string",
      "reason": "string",
      "tx_hash": "string",
      "failure_code": "string",
      "created_at": "2026-01-01T00:00:00.000Z",
      "completed_at": "2026-01-01T00:00:00.000Z",
      "failed_at": "2026-01-01T00:00:00.000Z",
      "livemode": true,
      "simulated": true,
      "failure_message": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "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:

• invalid_cursor