For the complete documentation index, see llms.txt. This page is also available as Markdown.

List withdrawals

Return a paginated list of your merchant’s withdrawals, newest first. Use it to reconcile withdrawals or to poll recent activity; for a single withdrawal use Get a withdrawal.

Endpoint GET /1.0/merchant/asset-withdrawals

Query parameters

Parameter
Type
Required
Description

page

integer

no

Page number, starting at 1. Defaults to 1.

perPage

integer

no

Items per page. Defaults to 10.

cURL

curl "https://api.omypayments.com/1.0/merchant/asset-withdrawals?page=1&perPage=10" \
  -H "apiKey: <yourApiKey>"

Response (200 OK)

{
  "totalCount": 42,        // Total number of withdrawals for your merchant
  "page": 1,               // Current page
  "perPage": 10,           // Items per page
  "data": [                // Withdrawals on this page
    {
      "id": "85c8d15e-fa47-4219-8d91-175fc91685a2",              // Withdrawal ID
      "status": "success",                                       // pending | success | failed
      "address": "0x1111111111111111111111111111111111111111",  // Destination address
      "amount": "60000000000000000000",                          // Requested amount in base units
      "amountInUsd": "60.00",                                    // Requested amount in USD
      "payer": "sender",                                         // Fee payer (always "sender" for API withdrawals)
      "isPrivate": false,                                        // Whether this is a private withdrawal
      "asset": {
        "id": "87d68a49-4b0c-4b4c-ad07-4f39aa4a39ab",            // Merchant asset ID
        "balance": "99880000000000000000000",                    // Asset available balance (base units)
        "balanceInUsd": "99880",                                 // Asset available balance in USD
        "wallet": "0x89B177488596b79520ab581a427AE42f6A1B49E9"   // Asset default wallet (or null)
      },
      "crypto": {
        "id": "1fa107f9-3832-4286-9c72-493eaf675da5",            // Cryptocurrency ID
        "title": "Binance Pegged USDT",
        "symbol": "USDT",
        "contractAddress": "0x55d398326f99059fF775485246999027B3197955", // null for native coins
        "decimals": 18,
        "logoURI": "https://.../usdt.svg"
      },
      "network": {
        "id": "e130ce89-1d4d-4951-beaf-465ec43cf399",            // Network ID
        "title": "BNB Chain",
        "symbol": "BSC",
        "chainId": "56",                                         // External chain id (string)
        "networkType": "evm"
      },
      "fee": {
        "network": null,
        "service": {
          "amount": "1050000000000000000",
          "amountFormatted": "1.05",
          "currency": "USDT",
          "cryptoId": "{cryptoId}",
          "networkId": "{networkId}",
          "amountInUsd": "1.05",
          "isChargedToMerchant": true
        },
        "exchange": null,
        "totalInUsd": "1.05"
      },
      "txHash": "0xabc123...",                                   // On-chain transaction hash (null until the withdrawal is sent)
      "createdAt": "2026-07-11 10:28:58"                         // UTC, "Y-m-d H:i:s"
    }
  ]
}

Each item in data has the same shape as the Withdraw an asset response.

Errors

  • 401 Unauthorized — missing apiKey header.

  • 403 Forbidden — the API key lacks both the withdrawal and the invoice permission.


Last updated