Deactivate payment request

View as Markdown
## Deactivate payment request Moves the payment request `:id` to the `DEACTIVATED` status (numeric 4), preventing further payments. The request must belong to the store resolved from the API key. ### Authentication Send the merchant API key in `x-api-key`. Requires scope `Merchant.payment_link.update`. Optionally scope with `x-application-account-id`. ### Path parameters - `id` — payment request id. There is **no request body**. Returns the updated payment request shaped by its type. --- **Notas:** Handler: lifecycleService.setActive(user, id, false). Accepts deprecated alias PATCH /v1/payment-links/:id/deactivate. Counterpart of /activate.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the payment request to deactivate.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.