checkouts

List checkouts

Paginated checkout list for the authenticated merchant, filtered to the key's mode (sk_test_ sees only sandbox checkouts). Requires scope merchant_read on the API-key path.

This list is paginated and limit caps at 100. stats is computed over the WHOLE filter, not over the page, so stats.total is what tells you whether you have every row — summing amount across one page and calling it a total is how a reconciliation silently comes out short.

Held sales: a sale whose money is not released yet stays in processing and carries vault_hours (the wait it was booked for) and, once the provider answers, delay_until (the release date). ?status=processing with vault_hours > 0 or a delay_until is the reconciliation query for "paid, not settled yet" — money received but not landed, and until it lands the provider can still reverse it (see rejection_reasons). On a sale the hold policy decided not to hold, vault_hours is 0 and delay_until is null; on one it never saw, vault_hours is null too (see the field description — null is not zero).

get/api/checkouts

Request

  • Base URL: https://api.depixapp.com
  • URL: https://api.depixapp.com/api/checkouts
  • Auth: HTTP bearer

Query parameters

'pending'

Awaiting payment; the PIX QR is active until expires_at.

OR
'processing'

PIX paid; settlement in progress.

OR
'approved'

Payment approved by the provider; DePix on the way to the merchant.

OR
'completed'

TERMINAL — success: DePix delivered to the merchant.

OR
'expired'

TERMINAL — QR expired unpaid.

OR
'cancelled'

TERMINAL — cancelled upstream by the provider (refund/error).

Filter by status.

product_idstring

Filter by originating product id.

fromstring

Filter: created_at >= this timestamp. RFC 3339 ("2026-08-01T00:00:00Z"); the legacy "2026-08-01 00:00:00" shape is also accepted.

tostring

Filter: created_at <= this timestamp. RFC 3339 ("2026-08-31T23:59:59Z"); the legacy "2026-08-31 23:59:59" shape is also accepted.

qstring

Substring search over id and description.

limitinteger

Page size (1–100, default 50).

offsetinteger

Pagination offset (default 0).

Response

Checkout list.

limitinteger required

Applied page size (1–100).

offsetinteger required

Applied offset.

Changes

No recorded changes to this operation across all 1 revision of this API.