Payment Links

List payment links with context-aware access control

Changed on

List payment links with context-aware access control

get/api/v1/payment-links

Request

Query parameters

pageinteger

Page number (1-based)

Example:1
limitinteger

Number of items per page (max 100)

Example:10
sortstring

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

Example:created_at:desc
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

    • breaking

      for the query request parameter limit, default value was changed from 20 to 25

    • breaking

      response property data/items/first_viewed_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/order_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/transaction_id list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the new optional query request parameter sort

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      endpoint added