Get crypto withdrawals

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

Paginated list of your crypto withdrawal orders, newest first.

Request query params type:

type QueryParams = {
  page?: number;    // default 1
  limit?: number;   // default 50, max 200
}

Request URL example:

GET /api/v2/merchant-balance/withdrawals?page=1&limit=50

Response type:

type Response = {
  docs: {
    orderId: string;
    status: OrderStatus;
    network: string;
    asset: string;
    address: string;
    currencyCode: string;
    amount: number;
    hash?: string;
    createdAt: Date;
    updatedAt: Date;
  }[];
  totalDocs: number;
  limit: number;
  page: number;
  totalPages: number;
  offset: number;
  hasPrevPage: boolean;
  hasNextPage: boolean;
  prevPage: number | null;
  nextPage: number | null;
}

Response example:

{
  "docs": [
    {
      "orderId": "69281f0aa263ba8d44fad3b2",
      "status": "payout_successful",
      "network": "CELO",
      "asset": "USDC",
      "address": "0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20",
      "currencyCode": "CELO_USDC",
      "amount": 100,
      "hash": "0xe168c39bf7165c0eaa88e4df1e21e987666e44f11f2bea6f9be1c145f382dade",
      "createdAt": "2025-11-27T09:40:10.001Z",
      "updatedAt": "2025-11-27T10:05:18.770Z"
    }
  ],
  "totalDocs": 1,
  "limit": 50,
  "page": 1,
  "totalPages": 1,
  "offset": 0,
  "hasPrevPage": false,
  "hasNextPage": false,
  "prevPage": null,
  "nextPage": null
}