Class Checkouts

Create and manage hosted checkout links where the payer picks the asset/chain on the page (scopes: invoices:write to mutate, invoices:read to read). For an up-front fixed-address flow, use "../resources/invoices".Invoices instead.

Index

Constructors

constructor

Methods

create del get list update

Constructors

constructor

new Checkouts(c: Requester): Checkouts
Parameters
- c: Requester
Returns Checkouts
- Defined in src/resources/checkouts.ts:101

Methods

create

create(params: CreateCheckoutParams): Promise<CheckoutLink>
Create a hosted checkout link (scope: invoices:write).
Parameters
- params: CreateCheckoutParams
  The checkout to create; see CreateCheckoutParams.
Returns Promise<CheckoutLink>
A CheckoutLink with the hosted checkoutUrl/payPath and token.
Throws
On failure (e.g. 401/403 missing invoices:write).
Example
```
const link = await client.checkouts.create({
  reference: "order_1001",
  amount: { amount: "49.00", currency: "USDT" },
});
console.log(link.checkoutUrl);
```
- Defined in src/resources/checkouts.ts:117

del

del(token: string): Promise<{ ok: boolean }>
Void a checkout so it can no longer be paid (scope: invoices:write).
Parameters
- token: string
  The checkout token.
Returns Promise<{ ok: boolean }>
{ ok: true } on success.

Throws
On failure (e.g. 404 unknown token, 409 already paid).
- Defined in src/resources/checkouts.ts:158

get

get(token: string): Promise<Invoice>
Fetch a single checkout by its token (scope: invoices:read).
Parameters
- token: string
  The checkout token from CheckoutLink.token.
Returns Promise<Invoice>
The Invoice record.

Throws
On failure (e.g. 404 unknown token).
- Defined in src/resources/checkouts.ts:137

list

list(query?: InvoiceListQuery): Promise<Page<Invoice>>
List checkout links, newest first (scope: invoices:read). Keyset-paginated.
Parameters
- query: InvoiceListQuery = {}
  Filters + pagination; pass a prior page's nextCursor as before.
Returns Promise<Page<Invoice>>
The raw { items, nextCursor } page of Invoice records.

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

update

update(token: string, patch: InvoiceUpdate): Promise<Invoice>
Update a checkout (pause/resume, change redirect/expiry/description) (scope: invoices:write).
Parameters
- token: string
  The checkout token.
- patch: InvoiceUpdate
  Partial update; omit a field to leave it, send null to clear it. See InvoiceUpdate.
Returns Promise<Invoice>
The updated Invoice.

Throws
On failure (e.g. 404 unknown token, 401/403 auth).
- Defined in src/resources/checkouts.ts:148

Class Checkouts

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Checkouts

Methods

create

Parameters

Returns Promise<CheckoutLink>

Throws

Example

del

Parameters

Returns Promise<{ ok: boolean }>

Throws

get

Parameters

Returns Promise<Invoice>

Throws

list

Parameters

Returns Promise<Page<Invoice>>

Throws

update

Parameters

Returns Promise<Invoice>

Throws

Settings

On This Page