Payment Links
Payment links are shareable URLs that render a hosted checkout page. Customers can pay via bank transfer, card, or mobile money without you writing any frontend code.
The payment link object
json
{
"id": "0d2b5aa8-7a8b-4dc4-b347-7f1d899ac256",
"title": "Invoice #INV-2025-001",
"description": "Web design services — January 2025",
"amount": "500000",
"currency": "NGN",
"status": "active",
"slug": "invoice-2025-001-ab3f7c",
"expiresAt": "2025-02-01T00: 00: 00Z",
"createdAt": "2025-01-15T10: 00: 00Z"
}Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique link ID |
title | string | Displayed on the checkout page |
description | string | Optional subtitle on checkout |
amount | string | Fixed amount in minor units, or null for open amounts |
currency | string | ISO 4217 currency code |
status | string | active, inactive, or expired |
expiresAt | string | Optional expiry; null = no expiry |
Checkout URL
https://checkout.payve.io/pay/:idShare this URL with your customer. They will see a branded checkout with your link's title and amount.
Create a payment link
POST/v1/payment-links