Payment links

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/payment-links	List payment links
POST	/v1/payment-links	Create a payment link
GET	/v1/payment-links/{id}	Retrieve a payment link
PATCH	/v1/payment-links/{id}	Activate or deactivate a link

GET /v1/payment-links

List payment links

Your links, both active and deactivated.

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/payment-links

Create a payment link

A reusable or single-use link, with an expiry and a usage count. The payer chooses their payment method on a page we host: no payment data passes through your servers. Omitting amount_minor creates an open link, whose amount the payer sets.

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 — Link 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/payment-links/{id}

Retrieve a payment link

The link and its usage counter.

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

PATCH /v1/payment-links/{id}

Activate or deactivate a link

Deactivating a link stops it immediately for payments to come; payments already completed are untouched.

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