Account Information10

Admin13

Agreement2

Auth4

Bank Predictions1

Banks9

Branding14

Command Palette2

Countries3

CrossBorder5

Customer Bank Accounts4

Customers3

Dashboard1

Default Rates3

Embedded8

Evidence1

Go Live2

Invoice10

Legal1

Legal Entities11

Merchant Bank Account Payment Schemes1

Merchant Bank Accounts6

Merchant Documents2

Merchant Invitations4

Merchant Rates3

Merchants16

Onboarding3

Partner Invitations4

Partners6

Payment1

Payment Links6

Payment Schemes1

Payments8

Payout6

Post-Processor Logs2

Provider Configuration4

Refund Resolution Links4

Refunds1

Seeds2

Shareholder Documents2

Shareholder Invitations7

Shopify Orders3

Transaction Updates (Token)3

Transactions14

User Invitations2

Users10

Webhook3

Webhooks5

Payment Links

List payment links with context-aware access control

get/api/v1/payment-links

Query parameters

pageinteger

Page number (1-based)

Example:1

Page number (1-based)

limitinteger

Number of items per page (max 100)

Example:10

Number of items per page (max 100)

sortstring

Sort field and direction (e.g., "created_at:desc", "amount:asc")

Example:created_at:desc

Sort field and direction (e.g., "created_at:desc", "amount:asc")

status'active' | 'used' | 'expired' | 'cancelled'

Payment link status

merchant_idstring uuid

Filter by merchant ID (admin/partner only)

searchstring

Search by payment reference or order ID

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 25,
    "totalPages": 6,
    "hasNextPage": true
  }
}

Changes

Changed in 3 of the 8 revisions of this API.521

Jun 16, 2026b372e7d5563d420See the full diff
- ▲
  for the query request parameter limit, default value was changed from 20 to 25
  request-parameter-default-value-changed
- ▲
  response property data/items/first_viewed_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property data/items/order_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property data/items/transaction_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  added the new optional query request parameter sort
  new-optional-request-parameter
- ○
  the response property data/items/amount became required for the status 200
  response-property-became-required
- ○
  the response property data/items/created_at became required for the status 200
  response-property-became-required
- ○
  the response property data/items/currency became required for the status 200
  response-property-became-required
- ○
  the response property data/items/expires_at became required for the status 200
  response-property-became-required
- ○
  the response property data/items/first_viewed_at became required for the status 200
  response-property-became-required
- ○
  the response property data/items/id became required for the status 200
  response-property-became-required
- ○
  the response property data/items/link_type became required for the status 200
  response-property-became-required
- ○
  the response property data/items/merchant became required for the status 200
  response-property-became-required
- ○
  the response property data/items/order_id became required for the status 200
  response-property-became-required
- ○
  the response property data/items/payment_reference became required for the status 200
  response-property-became-required
- ○
  the response property data/items/status became required for the status 200
  response-property-became-required
- ○
  the response property data/items/transaction_id became required for the status 200
  response-property-became-required
- ○
  the response property data/items/views_count became required for the status 200
  response-property-became-required
- ○
  the response property pagination/limit became required for the status 200
  response-property-became-required
- ○
  the response property pagination/page became required for the status 200
  response-property-became-required
- ○
  the response property pagination/total became required for the status 200
  response-property-became-required
- ○
  the response property pagination/totalPages became required for the status 200
  response-property-became-required
- ○
  added the required property pagination/hasNextPage to the response with the 200 status
  response-required-property-added
- ○
  added the required property pagination/hasPreviousPage to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 28, 2026ecd256fe01061See the full diff
- ○
  endpoint added
  endpoint-added
Nov 2, 2025919eb7a392aa1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history