Skip to main content

Get Payment Link Details (Public)

Retrieve the details of a specific active payment link using its unique slug. This endpoint is typically used publicly by your frontend or customer application to display payment information before initiating a transaction.

GET /api/payment-links/:slug

Path Parameters

ParameterTypeDescription
slugStringThe unique slug of the payment link.

Responses

Success 200 OK

Returns the payment link object, including merchant details.

{
"id": "uuid-link-123",
"slug": "pay-my-product",
"title": "My Product Payment",
"description": "Payment for the latest gadget.",
"amount": 500000, // Amount in kobo (5000 NGN)
"currency": "NGN",
"isActive": true,
"isReusable": false,
"redirectUrl": null,
"createdAt": "2023-10-27T10:00:00.000Z",
"updatedAt": "2023-10-27T10:00:00.000Z",
"merchantId": "uuid-merchant-456",
"merchant": {
"id": "uuid-merchant-456",
"businessName": "Gadget Store Inc.",
// Other relevant public merchant details...
}
}

Error 404 Not Found

Returned if the payment link with the given slug does not exist or is inactive.

{
"message": "Payment link not found or is inactive"
}