Links

Retrieve Links

Get a paginated list of payment links with optional status filtering. Returns links ordered by creation date (newest first).

get/api/v1/links

Query parameters

takeinteger

Number of links to retrieve per page (default: 10)

skipinteger

Number of links to skip for pagination (default: 0)

statusesstring[]

Filter by payment status. Can provide multiple values. Valid statuses: Created, Pending, Processing, Complete, Delivered, Cancelled, Rejected, Returned

[
  "Pending"
]

Response

A list of links

messagestring

Response message

Example response

{
  "data": [
    {
      "linkExpiresIn": "1h"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.