Payouts

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/payouts	List payouts
POST	/v1/payouts	Make a payout
GET	/v1/payouts/{id}	Retrieve a payout

GET /v1/payouts

List payouts

Same pagination as payments.

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/payouts

Make a payout

Sends to a mobile wallet or a bank account. Scope can_payout required, and the account must be activated for live mode.

⚠️ A payout RESERVES the funds at creation: an insufficient balance is refused on the spot, and there is no overdraft.

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 — Payout 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/payouts/{id}

Retrieve a payout

The same masked view as GET /v1/payments/{id}, with the same ownership check.

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
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After