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

Returns a paginated list of payment links for the authenticated merchant with advanced filtering capabilities.

This endpoint provides comprehensive search functionality using database-driven filtering, allowing you to filter links by status, usage, batch, amount ranges, and date ranges.

The response includes pagination controls with previous and next cursors that can be used to navigate through the payment link history efficiently.

Features:

  • Full-text search: Search across payment link descriptions and UIDs
  • Advanced filtering: Filter by status (active, disabled, expired, paid), usage (single, multiple), and batch ID
  • Range support: Support for amount ranges and date ranges
Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/filter-payment-links HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
page: number?,
terms: string?,
status: string?,
usage: string?,
batch_id: string?,
amount: string?,
created_at: string?,
expires_at: string?,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started. Note that this endpoint returns a paginated response, see the Pagination section of the same guide.
Request arguments
per_page number

Optional. Number of payment links to return per page. Default: 10, Maximum: 100

page number

Optional. Page number for pagination. Default: 1 (first page)

terms string

Optional. Full-text search across payment link descriptions and UIDs. Uses fuzzy matching for partial text matches.

status string

Optional. Filter by status (active, disabled, expired, paid)

Allowed values:
  • ACTIVE
  • DISABLED
  • EXPIRED
  • PAID
usage string

Optional. Filter by link usage. SINGLE matches one-time links; MULTIPLE matches reusable links.

Allowed values:
  • SINGLE
  • MULTIPLE
batch_id string

Optional. Filter by the payment link batch that created the link. Example: bat_1234567890

amount string

Optional. Filter by amount. Supports: exact amount (1000), range (1000..5000), or boundless ranges (1000.. or ..5000). Amounts are in the smallest currency unit (cents for USD).

created_at string

Optional. Filter by creation date. Supports: specific date (YYYY-MM-DD), date range (YYYY-MM-DD..YYYY-MM-DD), or keywords (today, yesterday, this_week, last_week, this_month, last_month)

expires_at string

Optional. Filter by expiration date. Supports: specific date (YYYY-MM-DD), date range (YYYY-MM-DD..YYYY-MM-DD), or keywords.

Response attributes
Attribute Description
previous
object

Nullable. Pagination for the previous page. Contains 'before' (page number) and 'per_page' (page size) parameters. Use these values in the 'page' and 'per_page' parameters of the next request to get the previous page. Returns null if there is no previous page.
page
array<object.payment_link>

Always present. The current page of records, ordered by creation date (newest first). Each record is serialized according to the specified record_serializer option.
next
object

Nullable. Pagination for the next page. Contains 'after' (page number) and 'per_page' (page size) parameters. Use these values in the 'page' and 'per_page' parameters of the next request to get the next page. Returns null if there is no next page.
Payment link attributes
Attribute Description
payment_link_id
string

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

Nullable. The ID of the batch that created this payment link, if any.
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.
send_confirmation_email
boolean

Always present. If true, sends a confirmation email to the customer after each successful payment.
installation
object.installation

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.
Installation attributes
Attribute Description
installation_id
string

Always present. The ID of the installation.
enabled
boolean

Always present. Whether the installation is enabled and active.
name
string

Always present. The name of the installation.
platform
string

Always present. The platform type of the installation (e.g., 'WEB', 'IOS', 'ANDROID', 'TERMINAL').

Possible values:
  • WEB
  • IOS
  • ANDROID
  • TERMINAL
identifier
string

Nullable. The unique identifier for the installation on the platform.
payment_methods
array<object.payment_method>

Always present. List of payment methods supported by this installation.
email_capture
string

Always present. Email capture configuration for this installation. 'disabled' means no email collection, 'optional' means email is collected if provided by customer, 'required' means email is mandatory for all customers.

Possible values:
  • disabled
  • optional
  • required
mobile_capture
string

Always present. Mobile phone capture configuration for this installation. 'disabled' means no mobile number collection, 'optional' means mobile number is collected if provided by customer, 'required' means mobile number is mandatory for all customers.

Possible values:
  • disabled
  • optional
  • required
address_capture
string

Always present. Billing address capture configuration for this installation. 'disabled' means no billing address collection, 'optional' means billing address is collected if provided by customer, 'required' means billing address is mandatory for all customers.

Possible values:
  • disabled
  • optional
  • required
created_at
number

Always present. The timestamp of the key creation as a Unix timestamp.
Payment method attributes
Attribute Description
name
string

Always present. The name of the payment method.
display_name
string

Always present. The display name of the payment method.
flow
string

Always present. The flow of the payment method.
category
string

Always present. The category of the payment method.
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/filter-payment-links" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "amount": "1000..5000"
      }'
Learn how to run these code samples in your terminal by reading our guide.