Payment Links
Hosted, shareable URLs that accept payments without requiring a checkout page on your side.
Overview
Payment Links are stateless: creating one returns a hosted URL you can share by email, SMS, or QR. Each visit creates a fresh Payment in your account.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/links | Create a new payment link. |
| GET | /v1/links/{id} | Retrieve a link. |
| GET | /v1/links | List links with cursor pagination. |
| POST | /v1/links/{id}/disable | Disable an active link. |
| DELETE | /v1/links/{id} | Permanently delete a link and its history. |
POST /v1/links
POST/v1/links
Create a new payment link.
| Field | Type | Description |
|---|---|---|
amountreq | int | Amount in the minor unit. |
currencyreq | 'HTG' | 'USD' | ISO-4217 code. |
description | string | Shown on the hosted page and receipt. |
reusable | boolean | If false, the link expires after one payment. |
expires_at | unix ts | Auto-disable time. |
{
"id": "link_01HT3PA…",
"url": "https://korvenone.com/pay/8Ks9",
"amount": 250000,
"currency": "HTG",
"reusable": true,
"created": 1794902400
}GET /v1/links/{id}
GET/v1/links/{id}
Retrieve a link.
GET /v1/links
GET/v1/links
List links with cursor pagination.
POST /v1/links/{id}/disable
POST/v1/links/{id}/disable
Disable an active link.
DELETE /v1/links/{id}
DELETE/v1/links/{id}
Permanently delete a link and its history.