v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Payment Recoveries

List payment recoveries

Returns a paginated list of payment recoveries.

get/payment_recoveries

Query parameters

customer_idstring uuid

Filter by customer ID.

status'recovering' | 'recovered' | 'unrecovered' | 'cancelled'

Filter by recovery status.

order_idstring

Filter by the original order ID associated with the recovery.

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

Response

List of payment recoveries.

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "id": "01JE3X4Y5Z6A7B8C9D0E1F2G3H",
      "order_id": "01HNY4G8G8P4E1T4YJ9N8B1Z9M",
      "customer_id": "c3e06b6f-bb52-4b2c-81a3-899860652240",
      "status": "recovering",
      "amount": 19.99,
      "currency": "GBP",
      "recovery_strategy": "example_strategy",
      "next_action_scheduled_date": "2025-11-20T09:00:00Z",
      "payment_retry_attempt_count": 2,
      "links": [
        {
          "rel": "self",
          "href": "/v1/payment_recoveries/01JE3X4Y5Z6A7B8C9D0E1F2G3H",
          "method": "GET"
        }
      ]
    }
  ]
}