Listing payment links

GET /api/public/v1/payment_links

Returns a paginated list of payment links, ordered by creation time by default.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

URL Parameters

Name	Type	Description
order	string	Field to sort by. Supported value: created_at.
order_type	string	Sort direction. asc or desc.
page	number	Page number to return.
per_page	number	Number of results per page.
reference	string	Filter by payment link reference.
created_at_from	string	Return payment links created at or after this ISO 8601 timestamp, e.g. 2024-06-18T15:49:02.031Z.
created_at_to	string	Return payment links created at or before this ISO 8601 timestamp, e.g. 2024-06-18T15:49:02.031Z.

Response Body

Name	Type	Description
data[].id	string	Payment link ID.
data[].type	string	Always paymentLinks.
data[].attributes.amount	string	Payment amount displayed to the end user.
data[].attributes.currency	string	Currency of the payment amount.
data[].attributes.accountCurrency	string	Merchant account currency used for settlement or funding.
data[].attributes.network	string	Network code selected by the end user. null until a selection is made.
data[].attributes.networkName	string	Human-readable network name. null until the end user selects a network.
data[].attributes.reference	string	Your internal correlation key, as set at creation.
data[].attributes.hostedPageUrl	string	URL of the Txn-hosted page to redirect your end user to.
data[].attributes.status	string	Payment link status. See Payment Links Concept.
data[].attributes.approvalStatus	string	Approval workflow status for payout payment links subject to an approval rule. null otherwise.
data[].attributes.expiresAt	string	ISO 8601 timestamp of when the payment link expires.
data[].attributes.createdAt	string	ISO 8601 timestamp of when the payment link was created.
data[].attributes.paymentType	string	Invoice or Payout.
data[].attributes.paymentMethods[]	array	Payment methods available on the hosted page.
data[].attributes.successRedirectUrl	string	Success redirect URL. null if not set.
data[].attributes.unsuccessRedirectUrl	string	Unsuccessful redirect URL. null if not set.
data[].relationships.target.data	object	ID and type of the child invoice or payout. null until the end user selects a cryptocurrency on the hosted page.
meta.page	number	Current page number.
meta.per_page	number	Number of results per page.
meta.total	number	Total number of payment links matching the query.

Response

HTTP 200

{
  "data": [
    {
      "id": "46df1a5c-a478-427f-a988-a2dacb235d6b",
      "type": "paymentLinks",
      "attributes": {
        "amount": "100.00",
        "currency": "EUR",
        "accountCurrency": "EUR",
        "network": null,
        "networkName": null,
        "reference": "8c40d8b6-ccdf-4861-a6d6-6c3125ce3f31",
        "hostedPageUrl": "https://sandbox.txn.io/redirect?payment_link_id=46df1a5c-a478-427f-a988-a2dacb235d6b&request_type=payment_link_hosted_page&zone=eu",
        "status": "created",
        "approvalStatus": null,
        "expiresAt": "2026-06-01T23:00:00.000Z",
        "createdAt": "2026-05-17T10:07:24.199Z",
        "paymentType": "Invoice",
        "successRedirectUrl": "https://example.com/success",
        "unsuccessRedirectUrl": "https://example.com/fail",
        "paymentMethods": [
          "on_chain"
        ]
      },
      "relationships": {
        "target": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total": 264
  },
  "jsonapi": {
    "version": "1.0"
  }
}