Payments

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method	Path	Description
GET	/v1/payments	List payments
POST	/v1/payments	Create a payment (hosted checkout)
GET	/v1/payments/{id}	Retrieve a payment

GET /v1/payments

List payments

Served by the read model, from a replica: no report can ever slow a payment down.

Parameters

Name	In	Required	Description
page	query	no	Page, starting at 1.
per_page	query	no	Page size, 100 at most.

Responses

• 200 — OK
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope, or the account is not active
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After

POST /v1/payments

Create a payment (hosted checkout)

Creates a collection operation and returns what you need to charge the customer — a payment URL, a deep link or a QR, depending on the rail. asset_id and platform_id are identifiers, not symbols: GET /v1/assets and GET /v1/corridors give the ones this account may use. Omitting rail lets routing choose; naming one forces it, and fails rather than falling back.

Parameters

Name	In	Required	Description
Idempotency-Key	header	no	An idempotency key specific to THIS operation. Replaying the same key with the same payload returns the original; replaying it with a different payload is refused (409).

Responses

• 201 — Operation created
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope, or the account is not active
• 409 — Idempotency key replayed with a different payload
• 422 — Well-formed but refused: missing field, closed corridor, insufficient balance
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After

GET /v1/payments/{id}

Retrieve a payment

A local read: nothing is asked of the rail. The payer's details are masked, because the read model never holds the raw values.

Parameters

Name	In	Required	Description
id	path	yes	Internal identifier, the operation's reference, or your own client_ref.

Responses

• 200 — OK
• 401 — API key missing or rejected
• 403 — The key does not carry the required scope, or the account is not active
• 404 — Unknown, or belonging to another account
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After