Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Payment Recoveries

Mark a payment recovery as recovered

Marks an in-progress payment recovery as recovered (e.g. when payment was settled outside the platform). Transitions the recovery status to recovered with termination reason recovery_settled_externally. Only recoveries in recovering status can be marked recovered.

post/payment_recoveries/{recovery_id}/recovered

Path parameters

recovery_idstring required
Example:01JE3X4Y5Z6A7B8C9D0E1F2G3H

Unique identifier for the payment recovery.

Response

Recovery marked as recovered.

idstring required

Unique ID assigned by Acquired to the payment recovery when it is created.

order_idstring 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_idstring uuid required

ID of the customer whose failed payment triggered this recovery.

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

Current lifecycle status of the recovery.

amountnumber required

The amount being recovered, in major currency units.

currency'GBP' | 'USD' | 'EUR' required

The currency of the amount being recovered.

recovery_strategystring 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_atstring date-time required

When the recovery record was created.

next_action_scheduled_datestring 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_countinteger required

The number of payment retry attempts made so far during this recovery.

Example response

{
  "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"
    }
  ]
}