Processing

Recover a deposit

Changed on

Returns funds from a failed or rejected deposit.

post/deposits/recover

Request

Headers

x-api-keystring

API key for authentication

Example:your-api-key

Request body

depositIdstring required

Deposit id, as returned by GET /deposits. Identifies the row directly: one transaction can produce several deposits, so a {chain, txHash, account, token} tuple does not.

destinationstring required

Address to receive the recovered tokens on the deposit's source chain. Covered by the signature, so the caller cannot redirect an authorized recovery.

signaturestring required

Signature by the deposit recipient over the RecoverDeposit typed data, in whatever form that account verifies: raw ECDSA (EOA), ERC-1271 (deployed smart account), or ERC-6492-wrapped (undeployed).

Example request

{
  "depositId": "2551",
  "destination": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "signature": "0x1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111"
}

Response

Deposit recovered; funds returned on the source chain

messagestring required
transactionHashstring required
amountstring required

Changes

    • warning

      added the new REFUND_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new REFUND_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new REFUND_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new REFUND_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new REFUND_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SETTLEMENT_UNRESOLVED enum value to the response property for the response status

    • warning

      added the new SETTLEMENT_UNRESOLVED enum value to the response property for the response status

    • warning

      added the new SETTLEMENT_UNRESOLVED enum value to the response property for the response status

    • warning

      added the new SETTLEMENT_UNRESOLVED enum value to the response property for the response status

    • warning

      added the new SETTLEMENT_UNRESOLVED enum value to the response property for the response status

    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      the header request parameter x-api-key became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status