---
title: "List payment recoveries"
method: GET
path: "/payment_recoveries"
tags: ["Payment Recoveries"]
---

# List payment recoveries

`GET /payment_recoveries`

Returns a paginated list of payment recoveries.

## Query parameters

- `customer_id` string, uuid
- `status` 'recovering' | 'recovered' | 'unrecovered' | 'cancelled'
- `order_id` string
- `offset` integer
- `limit` integer

## Response `200`

List of payment recoveries.

- PaymentRecoveryListPaged
  - `meta` object
    - `count` integer — The number of records returned as part of the response.
    - `offset` integer — The starting record number.
    - `limit` integer — The maximum number of records that can be returned as part of the response.
    - `total` integer — The total number of records contained in the query response.
    - `links` object[]
      - `rel` 'self' | 'first' | 'last' | 'prev' | 'next'
      - `href` string — Link to the resource which should be appended to base URL.
      - `title` string — Description of the link.
  - `data` 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

---

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