Skip to main content
POST
Revoke a payment link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Response

2XX - application/json

The revoked payment link.

id
string<uuid>
required
object
any
required
public_id
string
required
Pattern: ^splink_[a-z0-9]{32}$
url
string<uri>
required
Pattern: ^https://link\.simplepay\.mx/splink_[a-z0-9]{32}$
status
enum<string>
required
Available options:
active,
inactive,
archived,
paid
amount_source
enum<string>
required
Available options:
manual_amount,
catalog_line_item
manual_amount
integer | null
required
currency
string
required
Pattern: ^[a-z]{3}$
catalog_line_item_snapshot
object | null
required
payment_method_types
enum<string>[]
required
Minimum array length: 1
Available options:
card,
oxxo,
spei
installment_options
object[]
required

Canonical installment terms offered by the resource; empty when installments are not offered.

Maximum array length: 6
installment_plan
object | null
required

One SimplePay card-installment term. The merchant offers terms at resource creation; the buyer may only select one offered term at quote/pay.

checkout_session_ref
string | null
required
Pattern: ^spcs_[a-z0-9]{32}$
expires_at
string<date-time> | null
required

UTC expiry timestamp, or null when the link does not expire automatically.

revoked_at
string<date-time> | null
required

UTC merchant-revocation timestamp, or null while the link has not been revoked.

metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
installment_pricing
object

Merchant-owned financing choice applied consistently to every offered term. absorb forbids buyer markup; pass_to_buyer may include a governed markup in basis points.

Last modified on September 1, 2026