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

Get a withdrawal

Return the current state of a withdrawal by its ID. Poll this endpoint to track progress, or rely on callbacks to be notified of status changes.

Endpoint GET /1.0/merchant/asset-withdrawal-info

Query parameters

Parameter
Type
Required
Description

id

string

yes

UUID of the withdrawal to retrieve.

cURL

curl "https://api.omypayments.com/1.0/merchant/asset-withdrawal-info?id=85c8d15e-fa47-4219-8d91-175fc91685a2" \
  -H "apiKey: <yourApiKey>"

Response (200 OK)

The response body is identical to the Withdraw an asset response:

{
  "id": "85c8d15e-fa47-4219-8d91-175fc91685a2",              // Withdrawal ID
  "status": "pending",                                       // 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": null,                                            // On-chain transaction hash (null until the withdrawal is sent)
  "createdAt": "2026-07-11 10:28:58"                         // UTC, "Y-m-d H:i:s"
}

A withdrawal starts as pending, then transitions to success (sent on-chain) or failed (declined or reverted).

Errors

  • 404 Not Found — no withdrawal with this ID belongs to your merchant (the response body is empty).

  • 400 Bad Requestid is missing or not a valid UUID (standard validation envelope, see Error format):

  • 401 Unauthorized — missing apiKey header.

  • 403 Forbidden — the API key lacks the withdrawal permission.


Last updated