Txn.pro - API Documentation
Sandbox LoginChangelogStatus Page
  • Getting setup
    • Environments
    • Creating a Sandbox account
    • Back office user roles
    • Creating your API keys
    • Postman collection
  • API Basics
    • API specification
    • API status
    • Supported currencies
    • Date and time format
    • Authenticating the API
    • Webhooks
      • Verifying webhooks
      • Source IP addresses
      • Retrying schedule
    • Rate limits
  • Hosted pages
  • Accounts
    • Accounts concept
    • Listing accounts
    • Reading account
    • Listing account addresses
    • Creating account address
    • Listing account transactions
    • Reading account transaction
  • Exchange
    • Exchange concept
    • Supported currency pairs
    • Reading exchange rates
    • Exchange webhooks
    • Creating quote
    • Confirming quote
  • Invoices
    • Invoices concept
    • Invoice status flow
    • Invoices in cashier
    • Invoice limitations
    • Listing invoice currency pairs
    • Invoice webhooks
    • Creating invoice
    • Reading invoice
    • Listing invoices
    • Invoice refunds
  • Payouts
    • Payouts concept
    • Payout status flow
    • Payout limitations
    • Listing payout currency pairs
    • Validating addresses
    • Payout webhooks
    • Creating payout
    • Reading payout
    • Listing payouts
  • Mass Payouts
  • PAYMENT LINKS
    • Payment links concept
    • Creating payment link
    • Expiring payment link
    • Reading payment link
    • Listing payment links
  • CHANNELS
    • Channels concept
    • Channels deposit flow
    • Listing channel currency pairs
    • Channel webhooks
    • Creating channel
    • Reading channel
    • Updating channel
    • Listing channels
    • Listing channel deposits
    • Reading channel deposit
  • (BETA) Fiat Settlements
    • Important information
    • Bank withdrawal webhooks
    • Bank deposit webhooks
    • Listing bank accounts
    • Reading bank account
    • Previewing bank withdrawal
    • Creating bank withdrawal
    • Listing bank withdrawals
    • Reading bank withdrawal
    • Listing bank deposits
    • Reading bank deposit
Powered by GitBook
On this page
  1. PAYMENT LINKS

Expiring payment link

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

This endpoint expires payment links. Only payment links with the statuses Created or Pending can be updated to 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

Entity type returned. Always paymentLinks.

data.attributes

object

Set of payment attributes.

data.attributes.amount

string

Payment amount to display to end users.

data.attributes.currency

string

data.attributes.accountCurrency

string

Account currency that the payment should be credited to (Invoice) or debited from (Payout).

data.attributes.network

string

data.attributes.networkName

string

data.attributes.reference

string

The custom reference ID to tie the payment to end-user.

data.attributes.hostedPageUrl

The payment hosted page URL to redirect your end-users to.

data.attributes.status

string

Payment link status context. Can be created, pending, completed, expired.

data.attributes.network

string

data.attributes.expiresAt

string

Payment link expiry date and time.

data.attributes.createdAt

string

Date and time payment was created at.

data.attributes.successRedirectUrl

string

URL you want your customer to be redirected from our hosted page to if the invoice completes.

data.attributes.unsuccessRedirectUrl

string

URL you want your customer to be redirected from our hosted page to if the invoice gets expired, cancelled or rejected.

data.relationships.target

object

This object will contain ID of the child Invoice or Payout generated by the Payment Link.

included

array

PreviousCreating payment linkNextReading payment link

Last updated 2 months ago

Payment currency to display to end users. Refer to .

Payment network code. E.g. trx:usdt. Refer to .

Payment network name. E.g. Tron (TRC20). Refer to .

Network code. Refer to .

This array will contain data about the child Invoice or Payout generated by the Payment Link. For more details refer to and pyaloads.

Supported currencies
Supported currencies
Supported currencies
Supported currencies
Invoice
Payout