products

List a product's checkouts

Paginated checkouts created from one product. Requires scope merchant_read on the API-key path.

get/api/products/{id}/checkouts

Request

  • Base URL: https://api.depixapp.com
  • URL: https://api.depixapp.com/api/products/{id}/checkouts
  • Auth: HTTP bearer

Path parameters

idstring required

Product id (prd_*).

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.

limitinteger

Page size (1–100, default 50).

offsetinteger

Pagination offset (default 0).

Response

Product checkouts.

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.