Skip to main content
GET
/
api
/
v1
/
checkouts
Get checkouts by store ID
curl --request GET \
  --url https://api.zenobank.io/api/v1/checkouts \
  --header 'x-api-key: <x-api-key>'
[
  {
    "id": "ckl1234567890",
    "orderId": "order-12345",
    "priceCurrency": "USD",
    "priceAmount": "100.00",
    "status": "OPEN",
    "expiresAt": "2025-10-05T12:00:00Z",
    "checkoutUrl": "https://pay.zenobank.io/ckl1234567890",
    "createdAt": "2025-10-04T10:00:00Z",
    "webhookUrl": "https://example.com/webhook",
    "successRedirectUrl": "https://example.com/success"
  }
]

Headers

​
x-api-key
string
required

External API Key

Query Parameters

​
storeId
string
required
​
limit
number

Limit the number of items to return

Required range: x >= 1
Example:

100

​
offset
number

Offset the number of items to return

Required range: x >= 1
Example:

0

Response

200 - application/json
​
id
string
required

Checkout ID

Example:

"ckl1234567890"

​
orderId
string
required

Unique order identifier

Example:

"order-12345"

​
priceCurrency
string
required

Currency code

Example:

"USD"

​
priceAmount
string
required

Price amount

Example:

"100.00"

​
status
enum<string>
required

Current status of the checkout

Available options:
OPEN,
COMPLETED,
EXPIRED,
CANCELLED
Example:

"OPEN"

​
expiresAt
string<date-time> | null
required

Expiration date

Example:

"2025-10-05T12:00:00Z"

​
checkoutUrl
string
required

URL to complete the checkout

Example:

"https://pay.zenobank.io/ckl1234567890"

​
createdAt
string<date-time>
required

Creation date

Example:

"2025-10-04T10:00:00Z"

​
webhookUrl
string | null
required

Webhook URL to notify checkout status changes. For example, when the checkout is paid

Example:

"https://example.com/webhook"

​
successRedirectUrl
string | null
required

URL to redirect the user after checkout is successful

Example:

"https://example.com/success"