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 (PaymentLinkList)
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

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).

Request body

Field	Type	Required	Description
title	string	yes	What the payer sees at the top of the page.
description	string	no
amount_minor	string	no	Amount in MINOR UNITS, as a string. Never a floating-point number: both lose centimes. The asset's decimal count comes from GET /v1/assets.
asset_id	integer	yes
is_reusable	boolean	no	A reusable link accepts several payments.
max_uses	integer	no	Usage cap for a reusable link.
allowed_platform_ids	integer[]	no	Restricts the payment methods offered.
expires_in_seconds	integer	no

Responses

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

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 (PaymentLink)
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

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.

Request body

Field	Type	Required	Description
is_active	boolean	yes

Responses

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

Schemas

The shapes the operations above return.

PaymentLinkList

Field	Type	Description
data	PaymentLink[]
data[].id	string
data[].url	string
data[].title	string
data[].amount_minor	string
data[].asset_id	integer
data[].is_active	boolean
data[].is_reusable	boolean
data[].max_uses	integer
data[].uses	integer
page	integer
per_page	integer

Error

Field	Type	Description
error	object
error.code	string
error.message	string

PaymentLink

Field	Type	Description
id	string
url	string
title	string
amount_minor	string
asset_id	integer
is_active	boolean
is_reusable	boolean
max_uses	integer
uses	integer