Skip to main content

Get Public Payment Link

Public endpoint for getting a Payment Link by ID. It is used by the hosted Payment Link page to render the payment form and does not require an API Key.

info

This endpoint is public and does not expose the processor_id, since the underlying processing infrastructure should never reach the end-user.

This endpoint is rate limited by IP address.

Whenever the Payment Link is active or paid, the response includes a session_token. This token must be sent as the Authorization header when calling the Pay and Download Receipt PDF endpoints for this Payment Link. No session_token is returned for expired or canceled Payment Links.

GET /api/v1/payment-links/{payment_link_id}

Response

CodeDescription
200Success
404Not Found
500Internal Error

Example Usage

getPublic.js
var requestOptions = {
method: 'GET',
redirect: 'follow'
};
const payment_link_id = '';
const url = `https://api.reverepayments.dev/api/v1/payment-links/${payment_link_id}`;
fetch(url, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.log('error', error));

Example Success Response

Before payment

{
"id": "7e44c370-078e-4fa3-9909-bdd8554eb068",
"group_id": "8059f5c6-e1cd-4e46-9196-1d7e47401a3e",
"group_slug": "my-company",
"title": "Consulting session",
"description": "1 hour consulting session",
"amount": 15000,
"currency": "USD",
"card_enabled": true,
"ach_enabled": true,
"status": "active",
"expires_at": "2025-12-18T00:00:00Z",
"redirect_url": "https://example.com/thank-you",
"session_token": "9d3edfce-3029-40ad-bfcc-467a49f2d5ea"
}

After payment

Once paid, the response also contains paid_at and payment_method_response.

{
"id": "7e44c370-078e-4fa3-9909-bdd8554eb068",
"group_id": "8059f5c6-e1cd-4e46-9196-1d7e47401a3e",
"group_slug": "my-company",
"title": "Consulting session",
"description": "1 hour consulting session",
"amount": 15000,
"currency": "USD",
"card_enabled": true,
"ach_enabled": true,
"status": "paid",
"paid_at": "2025-11-18T14:30:41.211348Z",
"payment_method_response": {
"card": {
"first_six": "411111",
"last_four": "1111",
"brand": "visa"
}
},
"redirect_url": "https://example.com/thank-you",
"session_token": "9d3edfce-3029-40ad-bfcc-467a49f2d5ea"
}