API references
Search documentation... ⌘K
Open merchant dashboard
Merchant API
All our references

Retrieve details about a specific payment link in your merchant account.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/find-payment-link HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
payment_link_id: string,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
payment_link_id string

Required. The unique identifier of the payment link to retrieve.

Response attributes
Attribute Description
payment_link_id
string

Always present. The ID of the payment link.
payment_link_url
string

Always present. The URL of the payment link.
status
string

Always present. The current status of the payment link.

Possible values:
  • active
  • disabled
  • expired
  • paid
amount
number

Always present. The amount of the payment link in subunits.
currency
string

Always present. The 3-letter ISO currency code.
description
string

Always present. The description of the payment link.
external_id
string

Nullable. The merchant's internal reference for this link.
expires_at
number

Nullable. When the link becomes invalid (Unix timestamp).
single_use
boolean

Always present. If true, the link expires after one successful payment.
installation
object

Always present. The installation associated with this payment link.
created_at
number

Always present. The creation timestamp (Unix timestamp).
deletable
boolean

Always present. If true, the payment link has no associated payments and can be removed.
Errors specific to this endpoint
NOT_FOUND

This error occurs when no payment link with the provided ID exists in your merchant account. Double check that you're using the correct payment link ID.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/find-payment-link" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "payment_link_id": "CFV8FVPD"
      }'
Learn how to run these code samples in your terminal by reading our guide.