Create a payment link

Authorization

OAuth2PasswordBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A shareable page that collects a payment. IN-302.

amount_type decides which of the amount fields apply: fixed wants amount_minor and nothing else; open lets the payer choose and takes the optional min_/max_ bounds. Sending a fixed amount alongside bounds is refused rather than silently resolved, because either reading of it would be a guess about what you meant to charge.

title*Title

Shown to the payer as the heading of the page.

Length1 <= length <= 140

Example"August retainer"

currency*Currency

ISO 4217. Fixed for the life of the link.

Length3 <= length <= 3

Example"RWF"

amount_type?LinkAmountType

fixed charges amount_minor. open lets the payer enter an amount, optionally bounded by min_amount_minor and max_amount_minor — use it for donations and part payments.

Default"fixed"

Example"fixed"

Value in

"fixed"
"open"

amount_minor?|

Minor units — 15000000 is 150,000.00 RWF. Required for a fixed-amount link and refused on an open one.

Example15000000

min_amount_minor?|

Open-amount links only. The least the payer may enter.

Example5000000

max_amount_minor?|

Open-amount links only. The most the payer may enter.

Example50000000

usage?LinkUsage

reusable keeps collecting until it expires or you deactivate it. single_use closes itself on the first successful payment — the right choice for one invoice, because a reusable link sent to one customer is a link they can pay twice.

Default"reusable"

Example"reusable"

Value in

"single_use"
"reusable"

expires_at?|

RFC 3339, UTC. After this the page refuses payment. Omit for a link that never expires.

Example"2026-10-31T23:59:59Z"

redirect_url?|

Where the payer is sent after paying. Do not treat arriving here as proof of payment — it is a browser redirect the payer controls. Confirm with the charge.succeeded webhook.

Example"https://example.com/thanks"

description?|

Shown under the title, for whatever the title cannot say.

Example"Covers August 2026."

metadata?|

Arbitrary key/value of your own, returned on the link and on every charge it produces. Deliberately untyped — it is how you tie a payment back to your own records. Never shown to the payer.

Example

{  "invoice": "INV-2026-0042"}

Response Body

`application/json`

curl -X POST "https://example.com/api/b/v1/payment-links" \  -H "Content-Type: application/json" \  -d '{    "title": "August retainer",    "currency": "RWF"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "slug": "string",  "title": "string",  "description": "string",  "amount_type": "string",  "amount_minor": 0,  "min_amount_minor": 0,  "max_amount_minor": 0,  "currency": "string",  "usage": "string",  "state": "active",  "redirect_url": "string",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "payments": 0}

Authorization

Cookie Parameters

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`