Class CheckoutClient

Index

Constructors

Methods

cancelSession completeSession createEmbedToken createSession getOrder getOrderWithPayments listOrderPayments listOrders listPaymentTransactions request requestEnvelope

Constructors

constructor

new CheckoutClient(opts: CheckoutClientOptions): CheckoutClient
Parameters
- opts: CheckoutClientOptions
Returns CheckoutClient
- Defined in server.ts:260

Methods

cancelSession

cancelSession(sessionId: string): Promise<void>
Cancel an in-flight checkout session (e.g. the buyer abandoned the embed). Idempotent — cancelling an already-cancelled session is a no-op; a completed session cannot be cancelled (the API returns 422 already_completed).
Parameters
- sessionId: string
Returns Promise<void>
- Defined in server.ts:337

completeSession

completeSession(
sessionId: string,
input: CompleteCheckoutSessionInput,
): Promise<CompleteCheckoutSessionResult>
Parameters
- sessionId: string
- input: CompleteCheckoutSessionInput
Returns Promise<CompleteCheckoutSessionResult>
- Defined in server.ts:320

createEmbedToken

createEmbedToken(input: CreateEmbedTokenInput): Promise<CreateEmbedTokenResult>
Parameters
- input: CreateEmbedTokenInput
Returns Promise<CreateEmbedTokenResult>
- Defined in server.ts:344

createSession

createSession(input: CreateCheckoutSessionInput): Promise<CheckoutSession>
Parameters
- input: CreateCheckoutSessionInput
Returns Promise<CheckoutSession>
- Defined in server.ts:315

getOrder

getOrder(orderId: string): Promise<CheckoutOrder>
Parameters
- orderId: string
Returns Promise<CheckoutOrder>
- Defined in server.ts:349

getOrderWithPayments

getOrderWithPayments(orderId: string): Promise<CheckoutOrder>
Parameters
- orderId: string
Returns Promise<CheckoutOrder>
- Defined in server.ts:389

listOrderPayments

listOrderPayments(orderId: string): Promise<CheckoutPayment[]>
Parameters
- orderId: string
Returns Promise<CheckoutPayment[]>
- Defined in server.ts:373

listOrders

listOrders(options?: ListOrdersOptions): Promise<PaginatedOrders>
Parameters
- options: ListOrdersOptions = {}
Returns Promise<PaginatedOrders>
- Defined in server.ts:354

listPaymentTransactions

listPaymentTransactions(
paymentId: string,
): Promise<CheckoutPaymentTransaction[]>
Parameters
- paymentId: string
Returns Promise<CheckoutPaymentTransaction[]>
- Defined in server.ts:381

request

request<T = unknown>(method: string, path: string, body?: unknown): Promise<T>
Type Parameters
- T = unknown
Parameters
- method: string
- path: string
- Optionalbody: unknown
Returns Promise<T>
- Defined in server.ts:270

requestEnvelope

requestEnvelope<T = unknown>(
    method: string,
    path: string,
    body?: unknown,
): Promise<ThrottleEnvelope<T>>
Type Parameters
- T = unknown
Parameters
- method: string
- path: string
- Optionalbody: unknown
Returns Promise<ThrottleEnvelope<T>>
- Defined in server.ts:278