Rescue stranded funds from a payment

POST/payments/{id}/rescue

Recover excess deposits or wrong tokens from a payment contract by transferring the full token balance to a receiver. Requires a signed request (signRescue()); the receiver address is screened before funds move.

Headers

Header	Description	Required
Authorization	Bearer token with your secret API key	yes

Path Parameters

Name	Type	Required	Description
id	string	yes

Request Body

Field	Type	Required
token	string	yes
receiver	string	yes
deadline	integer	yes

Example Request

Request

const response = await fetch('https://checkout-api.exodus-int.com/payments/<id>/rescue', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "token": "string",
    "receiver": "string",
    "deadline": 0
  }),
});

Responses

Status	Description
200	The payment after rescue.
400	Validation error
401	Missing or invalid authentication
404	Resource not found

Response body

Field	Type	Required
id	string	yes
object	enum: payment	yes
status	enum: client_deposit_pending \| client_deposit_detected \| client_deposit_confirmed \| client_deposit_expired \| escrow_confirmed \| settlement_pending \| settled \| failed \| refunded \| cancelled	yes
payment_method	enum: direct \| two_step	yes
detected_token	string \| null	yes
detected_token_address	string \| null	yes
detected_chain	string \| null	yes
token_amount	string \| null	yes
token_amount_decimal	string \| null	yes
deposit_address	string \| null	yes
payer_addresses	string[]	yes
on_chain_id	string \| null	yes
created_at	string · date-time	yes
flagged	boolean	yes

Example Response

{
  "id": "tz4a98xxat96iws9zmbrgj3a",
  "object": "payment",
  "status": "settled",
  "payment_method": "two_step",
  "detected_token": "USDC",
  "detected_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "detected_chain": "eip155:1",
  "token_amount": "50000000",
  "token_amount_decimal": "50",
  "deposit_address": "0x5fbdb2315678afecb367f032d93f642f64180aa3",
  "payer_addresses": [
    "0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21"
  ],
  "on_chain_id": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b",
  "created_at": "2024-01-15T12:30:00Z",
  "flagged": false
}

Error Response

Error (e.g. 400)

{
  "error": {
    "type": "validation_error",
    "message": "amount must be a positive number",
    "param": "amount"
  }
}

Refund a payment Recover an expired payment to the customer