Skip to main content
GET
/
api
/
recovery
/
status
Get Recovery Status by Idempotency Key
curl --request GET \
  --url https://api.revtain.com/api/recovery/status \
  --header 'X-API-KEY: <api-key>'
{
  "transactionId": "FAILED_API_1773792234011",
  "status": "failed",
  "recovered": false,
  "amount": 5000,
  "currency": "USD",
  "recoveredAt": null,
  "strategyUsed": "all_failed",
  "attemptCount": 2,
  "lastDeclineCode": "do_not_honor",
  "recommendedAction": "retry_later",
  "recommendedActionReason": "The issuer returned a soft decline. A later retry, or a card update, may succeed."
}

Documentation Index

Fetch the complete documentation index at: https://docs.revtain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Your Revtain API key (format: rev_xxx). Provided during onboarding.

Query Parameters

​
idempotencyKey
string
required

The idempotency key you supplied to /api/recovery/execute.

Response

Recovery status

​
transactionId
string
Example:

"01KKZ14FEZK152ZBXEM2XK1B0C"

​
status
enum<string>
Available options:
succeeded,
failed,
blocked,
unknown
Example:

"succeeded"

​
recovered
boolean
Example:

true

​
amount
integer
Example:

5000

​
currency
string
Example:

"USD"

​
recoveredAt
string<date-time> | null
Example:

"2026-03-17T23:15:21.000Z"

​
strategyUsed
string
Example:

"primary"

​
attemptCount
integer

Number of gateway attempts made during the cascade.

Example:

2

​
lastDeclineCode
string | null

The most recent decline code seen for this recovery.

Example:

"do_not_honor"

​
recommendedAction
enum<string>

What to do next. Present only when the recovery did not succeed.

Available options:
request_card_update,
retry_later,
manual_review,
monitor
Example:

"retry_later"

​
recommendedActionReason
string

Human-readable explanation of the recommended action. Present only when the recovery did not succeed.

Example:

"The issuer returned a soft decline. A later retry, or a card update, may succeed."