---
title: "Cancel a payment recovery"
method: POST
path: "/payment_recoveries/{recovery_id}/cancel"
tags: ["Payment Recoveries"]
---

# Cancel a payment recovery

`POST /payment_recoveries/{recovery_id}/cancel`

Cancels an in-progress payment recovery. Transitions the recovery status to `unrecovered` with termination reason `recovery_cancelled`. Only recoveries in `recovering` status can be cancelled.

## Path parameters

- `recovery_id` string, required

## Response `200`

Recovery cancelled.

- PaymentRecovery
  - `id` string, required — Unique ID assigned by Acquired to the payment recovery when it is created.
  - `order_id` string, required — The order ID of the original failed payment this recovery relates to. For a recovery created from a subscription bill, this is the bill's ID, and each failed bill produces at most one recovery.
  - `customer_id` string, uuid, required — ID of the customer whose failed payment triggered this recovery.
  - `status` 'recovering' | 'recovered' | 'unrecovered' | 'cancelled', required — Current lifecycle status of the recovery.
  - `amount` number, required — The amount being recovered, in major currency units.
  - `currency` 'GBP' | 'USD' | 'EUR', required — The currency of the amount being recovered.
  - `recovery_strategy` string, nullable — The name of the recovery strategy in use for this recovery. The set of available strategies is provided to you as part of onboarding.
  - `termination_reason` 'payment_successful' | 'end_of_strategy' | 'max_retries_exceeded' | 'retry_limit_reached' | 'payment_too_old' | 'recovery_cancelled' | 'recovery_settled_externally' | 'internal_error' | 'advice_do_not_retry', nullable — The reason a terminated recovery ended. Null while the recovery is still in progress.
  - `created_at` string, date-time, required — When the recovery record was created.
  - `next_action_scheduled_date` string, date-time, nullable — When the next recovery action (e.g. the next payment retry) is scheduled to run. Null when the recovery is not in the `recovering` state or no action is currently scheduled.
  - `payment_retry_attempt_count` integer, required — The number of payment retry attempts made so far during this recovery.
  - `links` object[], required
    - `rel` 'self'
    - `href` string — Link to the resource which should be appended to base URL.
    - `method` string — The HTTP method to use with the link.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/acquired/apis/acquired-api.md) · [All operations](https://skmtc.net/acquired/apis/acquired-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/acquired/acquired-api/versions/7ae178a046f2/schema)