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

Payment currency to display to end users. Refer to Supported currencies.

data.attributes.accountCurrency

string

Specifies the merchant account to be used for crediting invoice payments or debiting payout amounts.

data.attributes.network

string

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

data.attributes.networkName

string

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

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

Network code. Refer to Supported currencies.

data.attributes.expiresAt

string

Payment link expiry date and time.

data.attributes.createdAt

string

Date and time payment was created at.

data.attributes.paymentType

string

Payment type. Can be either Invoice or Payout.

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

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

Last updated