Class Refunds

Issue and track refunds on settled collections (scope: payments:write).

Index

Constructors

Methods

create get list

Constructors

constructor

new Refunds(c: Requester): Refunds
Parameters
- c: Requester
Returns Refunds
- Defined in src/resources/refunds.ts:76

Methods

create

create(params: CreateRefundParams, opts?: IdempotencyOptions): Promise<Refund>
Refund all or part of a previously settled collection.
Parameters
- params: CreateRefundParams
  The refund to create; see CreateRefundParams.
- opts: IdempotencyOptions = {}
  Optional { idempotencyKey } — retrying with the same key + body replays the original.
Returns Promise<Refund>
The created Refund with its refundRequestId and status.
Throws
On failure (e.g. 401/403 missing payments:write, 422 over-refund, 404 unknown order, 409 idempotency conflict).
Example
```
const refund = await client.refunds.create(
  { merchantTradeNo: "order_123", amount: { amount: "10.00", currency: "USDT" }, reason: "customer request" },
  { idempotencyKey: crypto.randomUUID() },
);
```
- Defined in src/resources/refunds.ts:92

get

get(id: string): Promise<Refund>
Fetch a refund's current status.
Parameters
- id: string
  The refundRequestId returned by Refunds.create.
Returns Promise<Refund>
The Refund with its latest status.

Throws
On failure (e.g. 404 unknown refund, 401/403 auth).
- Defined in src/resources/refunds.ts:102

list

list(query?: LedgerQuery): Promise<LedgerPage>
List the settled REFUND ledger history (scope: payments:read). Keyset-paginated.
Parameters
- query: LedgerQuery = {}
  Time window + asset filter + pagination; see LedgerQuery.
Returns Promise<LedgerPage>
The raw { items, total, nextCursor } — a LedgerPage of LedgerEntry.

Throws
On failure (e.g. 401/403 auth).
- Defined in src/resources/refunds.ts:112