Skip to main content
GET
Get a recovery
One recovery, in this credential’s mode.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Path Parameters

recovery_id
string
required

Response

The recovery.

object
enum<string>
required

Always company_wallet_recovery.

Available options:
company_wallet_recovery
id
string
required
status
enum<string>
required

requested and processing while it's under way, then completed or rejected.

Available options:
requested,
processing,
completed,
rejected
user_id
string | null
required

The user the money came from.

amount_cents
integer
required

What's recovered.

livemode
boolean
required

false on a sandbox credential.

created_at
string<date-time>
required
failure_reason
string | null

Why a rejected recovery was rejected.

tx_hash
string | null

The onchain transaction that moved it, once there is one.

completed_at
string | null

When it completed.