Processing

Refund a deposit

Changed on

Returns deposit funds to a specified address on the source chain.

post/deposits/{id}/refund

Request

Path parameters

idstring required

Deposit id. Returned by GET /deposits.

Example:12345

Headers

x-api-keystring

API key for authentication

Example:your-api-key

Request body

recipientstring required

Address to receive the refunded tokens (EVM address or Solana public key). Must not be the address the deposit is already held at.

Example request

{
  "recipient": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
}

Response

Deposit refunded successfully

messagestring required
transactionHashstring required
amountstring required

Changes

    • 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 non-success response with the status

    • info

      added the non-success response with the status