---
title: "Cancel a payment link"
method: PATCH
path: "/payment_links/{id}/cancel"
tags: ["Payment links"]
---

# Cancel a payment link

`PATCH /payment_links/{id}/cancel`

Cancels an active payment link. A canceled payment link stops accepting payments and cannot be reactivated. Only payment links matching the `live` or `test` mode of the API key can be canceled.

## Path parameters

- `id` string, required

## Response `200`

The canceled payment link, with `status` set to `canceled`.

- PaymentLink
  - `id` string, required — Unique identifier of the payment link.
  - `object` 'payment_link', required — Type of the object. Always `payment_link`.
  - `amount` integer, required — Amount to collect, in the smallest unit of `currency`. For example, `5000` represents 5000 CLP, since CLP has no minor unit, or 50.00 MXN.
  - `checkout` object, required — Checkout customization. The `description` key holds the text shown next to the buy button, or `null` when you do not set it.
  - `created_at` string, date-time, required — ISO 8601 datetime in UTC of when the payment link was created.
  - `currency` 'CLP' | 'MXN', required — Three-letter ISO 4217 currency code. One of `CLP` (Chilean peso) or `MXN` (Mexican peso).
  - `customer_email` string, nullable, required — Email address of your customer, used for transaction notifications. `null` when not provided on creation.
  - `expires_at` string, date-time, nullable, required — ISO 8601 datetime in UTC of when the payment link expires. `null` when the payment link does not expire.
  - `metadata` object, required — Set of key-value pairs attached to the payment link on creation.
  - `mode` 'test' | 'live', required — Mode of the object. `live` objects use real institution data, `test` objects use fake data for integration testing.
  - `recipient_account` object, nullable, required — Destination bank account for the payments collected with the link. `null` unless your organization sent it on creation.
    - `holder_id` string, required — National identifier of the account holder. In Chile, a RUT (Rol Único Tributario) without dots or hyphen.
    - `institution_id` string, required — Fintoc identifier of the account's institution.
    - `number` string, required — Account number, without hyphens or leading zeros.
    - `type` 'checking_account' | 'savings_account' | 'sight_account' | 'rut_account' | 'line_of_credit' | 'credit_card', required — Type of the destination account.
  - `status` 'active' | 'expired' | 'canceled', required — Status of the payment link. One of `active` (accepts payments), `expired` (the expiration date passed), or `canceled` (you canceled the link).
  - `url` string, required — URL of the page where your customer pays.

## Other responses

- `401` — Invalid or missing API key.
- `403` — The payment link is not active: it already expired, or you already canceled it.
- `404` — The payment link does not exist, belongs to another organization, or belongs to a different mode than the API key.

---

[API](https://skmtc.net/fintoc/apis/fintoc-api.md) · [All operations](https://skmtc.net/fintoc/apis/fintoc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fintoc/fintoc-api/revisions/9dafa63688a3/schema)