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
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
Path Parameters
id
Payment link ID
Response Body
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
Specifies the merchant account to be used for crediting invoice payments or debiting payout amounts.
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 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.relationships.target
object
This object will contain ID of the child Invoice or Payout generated by the Payment Link.
included
array
Last updated