Class CheckoutsService

Service for managing Checkouts within the SDK Provides functionality for creating and configuring checkouts

Hierarchy (View Summary)

BaseService
- CheckoutsService

Index

Constructors

Methods

createCheckout getCheckout getCheckouts

Constructors

constructor

new CheckoutsService(
config: SDKConfig,
retryOptions: RetryOptions,
): CheckoutsService
Creates an instance of BaseService.
Parameters
- config: SDKConfig
  The SDK configuration options
- retryOptions: RetryOptions
  Options for request retry behavior
Returns CheckoutsService
Inherited from BaseService.constructor
- Defined in src/service/base.service.ts:22

Methods

createCheckout

createCheckout(
params: CreateCheckoutParams,
): Promise<APIResponse<CheckoutResponse>>
Creates a new checkout in the Coinbase Commerce platform
Parameters
- params: CreateCheckoutParams
  The checkout creation parameters
  - Optionalbuyer_locale?: string
  - Optionaldescription?: string
  - Optionalextended_description?: string
  - local_price: Price
  - Optionallogo_url?: string
  - Optionalmetadata?: CheckoutMetadata
  - Optionalname?: string
  - pricing_type: PricingType
  - Optionalrequested_info?: RequestedInfoItem[]
Returns Promise<APIResponse<CheckoutResponse>>
A promise that resolves to the created checkout
Example
```
const { data: checkout } = await commerce.checkouts.createCheckout({
  name: 'Test Checkout',
  description: 'Test checkout description',
  pricing_type: 'fixed_price',
  local_price: {
    amount: '100.00',
    currency: 'USD'
  },
  requested_info: ['email']
});
```
Throws
When the API request fails or validation fails
- Defined in src/service/checkouts.service.ts:47

getCheckout

getCheckout(checkout_id: string): Promise<APIResponse<CheckoutResponse>>
Retrieves a specific checkout by ID from the Coinbase Commerce platform
Parameters
- checkout_id: string
  The unique identifier of the checkout to retrieve
Returns Promise<APIResponse<CheckoutResponse>>
A promise that resolves to the checkout details
Example
```
const { data: checkout } = await commerce.checkouts.getCheckout('a3f457b7-2a06-4268-a97c-989c58d908fd');
console.log(checkout.data.name); // "Test Checkout"
```
Throws
When the API request fails or the checkout is not found
- Defined in src/service/checkouts.service.ts:71

getCheckouts

getCheckouts(
params?: GetCheckoutsParams,
): Promise<APIResponse<CheckoutsResponse>>
Retrieves a list of checkouts from the Coinbase Commerce platform
Parameters
- Optionalparams: GetCheckoutsParams
  Optional parameters for the list request
  - Optionalending_before?: string
  - Optionallimit?: number
  - Optionalorder?: "asc" | "desc"
  - Optionalstarting_after?: string
Returns Promise<APIResponse<CheckoutsResponse>>
A promise that resolves to a paginated list of checkouts
Example
```
// Get first page of checkouts
const { data: checkoutsList } = await commerce.checkouts.getCheckouts({
  limit: 10,
  order: 'desc'
});

// Get next page using cursor
const nextPage = await commerce.checkouts.getCheckouts({
  starting_after: checkoutsList.pagination.cursor_range[1]
});
```
Throws
When the API request fails or invalid parameters are provided
- Defined in src/service/checkouts.service.ts:107