Skip to main content
POST
/
v1
/
links
Create payment link
curl --request POST \
  --url https://api.platnova.com/v1/links \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "title": "Invoice #1001",
  "description": "Payment for services",
  "amount": 50000,
  "currency": "NGN",
  "expires_at": "2026-02-28T23:59:59Z",
  "customer": {
    "can_set_price": false
  },
  "payment": {
    "limit": 1,
    "payment_methods": [
      {
        "id": "bank_transfer",
        "value": "058"
      }
    ]
  }
}
'
{
  "status": true,
  "data": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "amount": 123,
    "url": "<string>",
    "status": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}

Overview

Create a payment link that can be shared with customers to collect payments. Payment links allow you to generate shareable URLs that customers can use to make payments without requiring them to have an account.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Body

application/json
title
string
required

Link title

currency
string
required

Currency code (e.g. NGN, USD)

payment
object
required
description
string

Optional description

amount
number

Fixed amount; required when customer.can_set_price is false

expires_at
string<date-time>

Optional expiry (ISO 8601)

customer
object

Response

Payment link created successfully

status
boolean
data
object
error
any[]
message
string