Expiring payment link

POST /api/public/v1/payment_links/:id/expiration

Immediately expires a payment link, transitioning its status to expired. Only payment links with status created or pending can be expired.

Headers

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

Path Parameters

Name	Value
id	Payment link ID.

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 if not yet selected.
data.attributes.networkName	string	Human-readable network name. null if not yet selected.
data.attributes.reference	string	Your internal correlation key, as set at creation.
data.attributes.hostedPageUrl	string	URL of the Txn-hosted page.
data.attributes.status	string	Always expired after a successful call.
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 expired.
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 that were 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 if none was triggered before expiry.

Response

HTTP 200

{
  "data": {
    "id": "e33e1727-1eba-4581-bfd5-ded60713a5b8",
    "type": "paymentLinks",
    "attributes": {
      "amount": "50.00",
      "currency": "EUR",
      "accountCurrency": "EUR",
      "network": null,
      "networkName": null,
      "reference": "docs-example-pl-payout-001",
      "hostedPageUrl": "https://sandbox.txn.io/redirect?payment_link_id=e33e1727-1eba-4581-bfd5-ded60713a5b8&request_type=payment_link_hosted_page&zone=eu",
      "status": "expired",
      "approvalStatus": null,
      "expiresAt": "2026-05-17T10:07:53.269Z",
      "createdAt": "2026-05-17T10:07:43.353Z",
      "paymentType": "Payout",
      "successRedirectUrl": null,
      "unsuccessRedirectUrl": null,
      "paymentMethods": [
        "on_chain"
      ]
    },
    "relationships": {
      "target": {
        "data": null
      }
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}