Skip to main content
POST
POST /payment-link/{id}/cancel deactivates an active link; its status becomes cancelled and the hosted page stops accepting payments.
  • Cancelling a link that is already cancelled is a no-op and returns the link.
  • A link that is already used returns 409 — it can’t be cancelled. Payments already taken are never affected; to return money, refund the payment.

​
Example

Authorizations

​
Authorization
string
header
required

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Path Parameters

​
id
string<uuid>
required

The payment link id.

Body

application/json
​
merchantCode
string

Your merchant account identifier. Required if the key maps to more than one merchant account.

Response

The cancelled link (cancelling an already-cancelled link is a no-op)

​
id
string<uuid>
​
url
string<uri>

The hosted checkout URL to share with the payer.

​
type
enum<string>
Available options:
one-time,
subscription
​
status
enum<string>

used once a single-use link takes its first successful payment, or a reusable link reaches maxUses.

Available options:
active,
used,
expired,
cancelled
​
amountMode
enum<string>
Available options:
fixed,
customer_entered
​
amount
object

Absent on subscription links. For customer_entered links only currency and exponent are set.

​
amountMin
integer<int64>

Minimum payer-entered amount, minor units.

​
amountMax
integer<int64>

Maximum payer-entered amount, minor units.

​
subscriptionPlanId
integer<int64>
​
checkoutConfigId
string<uuid>
​
title
string
​
description
string
​
reference
string
​
customerEmail
string
​
customerName
string
​
returnUrl
string<uri>
​
saveCardEnabled
boolean
​
reusable
boolean
​
maxUses
integer
​
usesCount
integer

Number of successful payments taken through this link.

​
environment
enum<string>
Available options:
production,
sandbox
​
expiresAt
string<date-time>
​
usedAt
string<date-time>
​
createdAt
string<date-time>