Get Deposit Status

Check the status of a manual deposit

GET /v1/execute/deposit/status

Check Near Intents deposit/swap status

cURL

curl --request GET \
  --url https://api.hypermid.io/v1/execute/deposit/status \
  --header 'X-API-Key: <api-key>'

200 Completed

{
  "data": {
    "depositId": "dep_abc123def456",
    "status": "DONE",
    "subStatus": "COMPLETED",
    "depositAddress": "0xDepositAddress",
    "depositAmount": "1000000000000000000",
    "depositTxHash": "0xDepositTxHash",
    "depositChainId": 1,
    "destinationAddress": "rRecipientXRPAddress",
    "destinationAmount": "3240000000",
    "destinationTxHash": "txDestinationHash",
    "destinationChainId": 900000004,
    "createdAt": 1711234576,
    "updatedAt": 1711234666
  },
  "error": null,
  "meta": {
    "requestId": "o5d6e7f8-a9b0-1234-8901-345678901234",
    "timestamp": 1711234670,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1985,
      "reset": 1711234727
    }
  }
}

Returns the current status of a manual deposit and its associated swap. Use this endpoint for deposit-based swap routes instead of /v1/status.

depositId · string · required

The deposit ID returned from the /v1/execute endpoint.

200 Completed

{
  "data": {
    "depositId": "dep_abc123def456",
    "status": "DONE",
    "subStatus": "COMPLETED",
    "depositAddress": "0xDepositAddress",
    "depositAmount": "1000000000000000000",
    "depositTxHash": "0xDepositTxHash",
    "depositChainId": 1,
    "destinationAddress": "rRecipientXRPAddress",
    "destinationAmount": "3240000000",
    "destinationTxHash": "txDestinationHash",
    "destinationChainId": 900000004,
    "createdAt": 1711234576,
    "updatedAt": 1711234666
  },
  "error": null,
  "meta": {
    "requestId": "o5d6e7f8-a9b0-1234-8901-345678901234",
    "timestamp": 1711234670,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1985,
      "reset": 1711234727
    }
  }
}

Status Values

Status	Description
PENDING	Waiting for the user’s deposit
DEPOSIT_RECEIVED	Deposit confirmed, swap in progress
DONE	Swap completed successfully
FAILED	Swap failed
EXPIRED	Deposit address expired before funds were received

Sub-Status Values

Sub-Status	Description
WAITING_FOR_DEPOSIT	Waiting for the user to send funds
CONFIRMING_DEPOSIT	Deposit detected, waiting for confirmations
PROCESSING_SWAP	Swap is being executed
COMPLETED	Swap finished successfully
DEPOSIT_EXPIRED	Deposit window has expired

TypeScript

const status = await client.getDepositStatus({
  depositId: "dep_abc123def456",
});

console.log("Status:", status.data.status);
console.log("Sub-status:", status.data.subStatus);

if (status.data.status === "DONE") {
  console.log("Destination tx:", status.data.destinationTxHash);
  console.log("Amount received:", status.data.destinationAmount);
}

Authorizations

X-API-Key · string · header · required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Query Parameters

depositAddress · string · required

The deposit address to check

depositMemo · string

Deposit memo (if applicable)

Response

200

application/json

Deposit/swap status

data · object · required

Response payload (null on error)

Show child attributes

error · object · required

Show child attributes

meta · object · required

Show child attributes