Class Payouts

Send batch crypto payouts and inspect withdraw options (scopes: payouts:write to send, payouts:read to read).

Index

Constructors

Methods

create get options

Constructors

constructor

new Payouts(c: Requester): Payouts
Parameters
- c: Requester
Returns Payouts
- Defined in src/resources/payouts.ts:52

Methods

create

create(
params: { items: PayoutItem[] },
opts?: IdempotencyOptions,
): Promise<PayoutBatch>
Submit a batch payout to one or more recipients (scope: payouts:write).

Strongly prefer passing an idempotencyKey: if the call is retried (network blip, timeout) the same key returns the ORIGINAL batch instead of paying a second time.
Parameters
- params: { items: PayoutItem[] }
  The payout batch.
  - items: PayoutItem[]
    One PayoutItem per recipient. Required, non-empty.
- opts: IdempotencyOptions = {}
  Optional request options.
  
  A request option that sets the Idempotency-Key header on a money-moving POST.
  - OptionalidempotencyKey?: string
    A unique client-generated key (e.g. a UUID). Retrying the call with the same key + body replays the original response instead of performing the action twice; a different body with the same key returns a 409. Omit to send no idempotency key.
Returns Promise<PayoutBatch>
The created PayoutBatch with its merchantBatchNo and sub-orders.
Throws
On failure (e.g. 401/403 missing payouts:write, 422 insufficient balance, 429 rate limit).
Example
```
const batch = await client.payouts.create(
  { items: [{ recipientAddress: "T...", chain: "TRON", amount: { amount: "25.00", currency: "USDT" } }] },
  { idempotencyKey: crypto.randomUUID() },
);
```
- Defined in src/resources/payouts.ts:74

get

get(id: string): Promise<PayoutBatch>
Fetch a payout batch's current status (scope: payouts:read).
Parameters
- id: string
  The batch id / merchantBatchNo from Payouts.create.
Returns Promise<PayoutBatch>
The PayoutBatch with its latest status and sub-orders.

Throws
On failure (e.g. 404 unknown batch, 401/403 auth).
- Defined in src/resources/payouts.ts:95

options

options(params: { currency: string }): Promise<Page<WithdrawOption>>
List the chains a currency can be paid out on, with each chain's fee and min/max limits.
Parameters
- params: { currency: string }
  Options.
  - currency: string
    Currency/asset code to look up, e.g. "USDT". Required.
Returns Promise<Page<WithdrawOption>>
The raw { items, nextCursor } (nextCursor always null) of WithdrawOption.

Throws
On failure (e.g. 401/403 missing payouts:read).
- Defined in src/resources/payouts.ts:85