Reading payment link

GET /api/public/v1/payment_links/:id

This endpoint returns details of a particular payment link by its ID.

Headers

Name	Value
Content-Type	application/vnd.api+json

Path Parameters

Name	Value
id	Payment link ID

Response Body

Name	Type	Required	Description
data.type	string	Yes	Can only be payment_links.
data.attributes.amount	string	Yes	Payment amount to display to end users.
data.attributes.currency	string	Yes	Payment currency to display to end users. Refer to supported currencies.
data.attributes.accountCurrency	string	No	Specifies the merchant account to be used for crediting invoice payments or debiting payout amounts. Can be EUR, USD, USDT or USDC.
data.attributes.paymentType	string	Yes	Payment type. Can be either Invoice or Payout.
data.attributes.reference	string	No	The custom reference ID to tie the payment to end-user. This can be anything you choose. Must be a unique value for each payment you create.
data.attributes.expires_at	string	Yes	Payment link expiration date and time. Follow the format 2025-01-12T23:00:00.000Z
data.attributes.successRedirectUrl	string	No	Only applicable to Invoices. URL you want your customer to be redirected from our hosted page to if the invoice completes.
data.attributes.unsuccessRedirectUrl	string	No	Only applicable to Invoices. URL you want your customer to be redirected from our hosted page to if the invoice gets expired, cancelled or rejected.

Response

HTTP 200

{
  "data": {
    "id": "3491fbf7-7b78-46ae-a371-c0bb662a9167",
    "type": "paymentLinks",
    "attributes": {
      "amount": "100.00",
      "currency": "USD",
      "accountCurrency": "EUR",
      "network": null,
      "networkName": null,
      "reference": "8d376e43-62c1-4c2e-9801-f7c07874c1ad",
      "hostedPageUrl": "https://integration.txn.pro/redirect?payment_link_id=3491fbf7-7b78-46ae-a371-c0bb662a9167&request_type=payment_link_hosted_page&zone=eu",
      "status": "created",
      "expiresAt": "2025-06-18T23:00:00.000Z",
      "createdAt": "2025-06-18T16:58:28.378Z",
      "paymentType": "Invoice",
      "successRedirectUrl": null,
      "unsuccessRedirectUrl": null
    },
    "relationships": {
      "target": {
        "data": null
      }
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}