Payments
LinkPay Payment Links
Create shareable checkout URLs for invoices, messages, QR codes and manual payment requests.
LinkPayCheckout linkShareable
LinkPay endpoints
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /payment-links | List LinkPay payment links only. |
| POST | /payment-links | Create a shareable LinkPay checkout link. |
| GET | /payment-links/{id} | Retrieve one payment link. |
Create LinkPay link
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | decimal | Yes | Payment amount in major units. |
currency | string | Yes | Currency code. |
details | string | Yes | Product, service or invoice description. |
customer_name | string | Optional | Default customer name when known. |
customer_email | email string | Optional | Default customer email when known. |
success_url | url string | Optional | Redirect after success. |
cancel_url | url string | Optional | Redirect after cancellation. |
ipn_url | url string | Optional | Webhook URL for payment updates. |
'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $secretKey,
'Accept: application/json',
'Content-Type: application/json',
'X-NeroPay-Timestamp: ' . $timestamp,
'X-NeroPay-Signature: ' . $signature,
'Idempotency-Key: ' . bin2hex(random_bytes(16)),
],
CURLOPT_POSTFIELDS => $rawBody,
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $response;
{
"success": true,
"data": {
"id": 194734,
"identifier": "LinkPay_NL-DBVR7405965-72128",
"status": "pending",
"amount": "9.99",
"currency": "GBP",
"payment_link": "https://eu.neropay.app/linkpay/..."
}
}List and retrieve
true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $secretKey,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $response;
{
"success": true,
"data": [
{
"id": 194734,
"identifier": "LinkPay_NL-DBVR7405965-72128",
"status": "pending",
"amount": "9.99",
"currency": "GBP",
"payment_link": "https://eu.neropay.app/linkpay/..."
}
]
}{
"success": false,
"error": {
"code": "resource_not_found",
"message": "Payment link was not found.",
"details": null
}
}