Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer access token from POST /v1/auth/token. Treat it as an opaque string — do not depend on its internal encoding, which has changed before and isn't part of the contract.

Query Parameters

outlet_id
string<uuid> | null

Outlet to scope the configuration to. Defaults to the merchant's DEFAULT outlet. A malformed UUID is rejected with 400.

branding_profile_id
string | null

Branding profile to resolve. Fail-open: an unknown, malformed or cross-merchant id falls back to the merchant default (never 404/422).

Maximum string length: 64

Response

Successful Response

Standard success envelope. Every successful response has this shape, with the operation's own payload under data.

data
MerchantCheckoutResponse · object | null

The operation's result. Its shape is documented per operation; omitted on responses that carry no payload.

message
string | null

Optional human-readable note. Omitted from the response when not set, which is the case for every payment operation today. Never parse it.

request_id
string | null

Correlation ID for this HTTP request, for logs and support. Send your own in the X-Request-Id header (letters, digits and hyphens, up to 36 characters -- other characters are stripped) or the gateway generates one. This is NOT the request_id idempotency key you send in a transaction body; the two are unrelated.

status
string
default:ok

Always ok on a successful (2xx) response. Errors use a different body shape entirely (RFC 9457 problem details), so branch on the HTTP status code, not on this field.

Last modified on September 15, 2026