Get crypto deposit

[GET] /api/v2/merchant-balance/deposit

Fetches a single deposit order by id for status polling.

Request query params type:

type QueryParams = {
  orderId: string;   // the deposit order id
}

Request URL example:

GET /api/v2/merchant-balance/deposit?orderId=69281d944a1db009177f0198

Response type:

type Response = {
  orderId: string;
  status: OrderStatus;
  network: string;
  asset: string;
  currencyCode: string;
  address: string;   // where to send the crypto
  amount: number;    // how much to send, in crypto units
  hash?: string;     // set once you have confirmed the deposit
  expiresAt: Date;
  createdAt: Date;
  updatedAt: Date;
}

Response example:

{
  "orderId": "69281d944a1db009177f0198",
  "status": "payout_successful",
  "network": "CELO",
  "asset": "USDC",
  "currencyCode": "CELO_USDC",
  "address": "0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20",
  "amount": 100,
  "hash": "0xe168c39bf7165c0eaa88e4df1e21e987666e44f11f2bea6f9be1c145f382dade",
  "expiresAt": "2025-11-27T10:29:56.167Z",
  "createdAt": "2025-11-27T09:29:56.167Z",
  "updatedAt": "2025-11-27T09:33:40.118Z"
}

The fields are address and amount. Earlier drafts of this page called them depositAddress and expectedAmount; those names appear nowhere in the response.