Skip to main content
GET
List Checkouts
This API is in Beta. Endpoints and schemas may change without prior notice.
Results are sorted default-first, then most recently updated, and include ARCHIVED checkouts. Each item’s id is the checkout_code used by the Fetch and Publish endpoints. Pagination is opt-in: without page or size the response is a bare array with every matching checkout; sending either switches the response to a paginated envelope (data + pagination, where total is the full filtered count).

Authorizations

PUBLIC-API-KEY
string
header
required

Merchant public API key. Found in Yuno dashboard → Settings → API Keys.

PRIVATE-SECRET-KEY
string
header
required

Merchant private secret key, paired with the public key. Never embed in client-side code.

X-Account-Code
string
header
required

UUID of the merchant account scope for the request. The tenant is resolved only from this header.

Query Parameters

name
string

Case-insensitive contains filter on the checkout name. LIKE metacharacters (% and _) match literally.

id
string

Case-insensitive contains filter on the checkout identifier.

status
enum<string>

Filter by status. Accepts one or several values (ORed): repeat the parameter or send a comma-separated list (status=PUBLISHED,ARCHIVED). Invalid values are rejected with 400. Absent: all statuses.

Available options:
PUBLISHED,
NOT_PUBLISHED,
ARCHIVED
created_after
string<date-time>

Inclusive lower bound on created_at (ISO-8601 instant, e.g. 2026-05-01T00:00:00Z).

created_before
string<date-time>

Inclusive upper bound on created_at (ISO-8601 instant).

updated_after
string<date-time>

Inclusive lower bound on updated_at (ISO-8601 instant).

updated_before
string<date-time>

Inclusive upper bound on updated_at (ISO-8601 instant).

page
integer
default:1

Page number (1-based). Opt-in pagination: sending page or size switches the response to the paginated envelope. Default 1. Non-numeric values are rejected with 400.

Required range: x >= 1
size
integer
default:25

Page size. Opt-in pagination: sending page or size switches the response to the paginated envelope. Default 25, capped at 100. Non-numeric values are rejected with 400.

Required range: 1 <= x <= 100

Response

The account's checkouts. A bare array when page and size are absent; a paginated envelope (data + pagination) when either is present. Items carry the same 7 fields in both shapes. pagination.total is the full filtered count, not the page's row count.

id
string

Checkout identifier (UUID). Use it as the checkout_code in the fetch and publish endpoints.

name
string

Checkout name.

description
string

Checkout description.

status
enum<string>

Checkout status.

Available options:
PUBLISHED,
NOT_PUBLISHED,
ARCHIVED
is_default
boolean

Whether this checkout is the account's default.

created_at
string<date-time>

Creation timestamp (ISO-8601).

updated_at
string<date-time>

Last update timestamp (ISO-8601).