public

Public checkout data

Public (unauthenticated) checkout read — what the hosted checkout page polls. Terminal statuses are cached for 60 s. The payment payload (pix or depix, per payment_method) is present only while pending. On the depix rail, depix.detected flips to true as soon as a matching payment is seen on the network — the status still only moves at the first confirmation.

get/api/pay/{id}

Request

  • Base URL: https://api.depixapp.com
  • URL: https://api.depixapp.com/api/pay/{id}
  • Auth: none required

Path parameters

idstring required

Checkout id (chk_*).

Response

Public checkout state.

idstring required

Checkout id (chk_*).

amountinteger required

Charge amount in cents.

currency'BRL' required

Always BRL.

descriptionstring nullable required

Checkout description.

image_urlstring nullable required

Checkout image URL.

merchant_namestring required

Merchant display name.

merchant_usernamestring required

Legacy alias of merchant_slug (kept for integrators; read merchant_slug instead).

merchant_slugstring required

Merchant public URL slug.

remaining_secondsinteger required

Seconds until expiry (0 when expired or not pending). On the depix rail a payment broadcast in the last seconds still settles: the checkout only turns expired 15 minutes after expires_at, so keep polling while remaining_seconds is 0 and the status is still pending.

expires_atstring nullable required

Expiry timestamp (RFC 3339 UTC).

redirect_urlstring nullable required

Post-payment redirect URL.

is_testboolean required

True for sandbox checkouts (non-payable placeholder payload).

payment_method'pix' | 'depix'

Which rail settles the checkout. pix (default): the payer pays a PIX QR and the provider delivers DePix to the merchant. depix: the payer sends DePix wallet-to-wallet on Liquid to an address dedicated to this merchant, and settlement is observed on-chain — no PIX QR exists on this rail.

Changes

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