Withdraw Asset

Prerequisites:

Make sure the tokens you intend to accept are enabled and fully configured in the Assets section of your OMY Payments dashboard (https://dashboard.omypayments.com/).

Enabling Tokens

Request:

POST /1.0/merchant/asset-withdrawal

Request Body:

{
  "assetId": "UUID",
  "amount": "5000000"
}

Response (200 OK):

{
  "id": "UUID", // Withdrawal UUID
  "status": "pending", // Withdrawal status
  "subStatus": null, // Withdrawal subStatus
  "address": "0x0000000000000000000000000000000000000000", // Withdrawal target address
  "amount": "0", // Withdrawal amount
  "amountInUsd": "0", // Withdrawal amount in USD
  "asset": { // Withdrawal asset
    "id": "UUID", // Asset UUID
    "balance": "0", // Asset balance
    "balanceInUsd": "0" // Asset balance in USD
    "wallet": "0x0000000000000000000000000000000000000000"
  },
  "crypto": { // Withdrawal crypto
    "id": "uuid", // Crypto UUID
    "title": "Tether USD", // Crypto title
    "symbol": "USDT" // Crypto symbol
    "contractAddress": "0x0000000000000000000000000000000000000000", // Crypto contract address
    "decimals": 6, // Crypto decimals
    "logoURI": "https://..." // Crypto logo URI
  },
  "network": { // Withdrawal network
    "id": "UUID", // Network UUID
    "chainId": "56", // Network chain ID
    "symbol": "BSC", // Network symbol
    "name": "BNB Chain", // Network title
    "networkType": "evm" // Network type
  },
  "createdAt": "2025-01-01 00:00:00" // Withdrawal creation datetime (UTC+0)
}

Error Responses:

  • 400 Bad Request (Validation Error):

    {
        "success": false,
        "message": "Validation error",
        "errors": [
            {
                "field": "assetId",
                "messages": ["Asset not found"]
            }
        ]
    }
  • 500 Internal Server Error:

    {
        "success": false,
        "message": "Internal Server Error",
        "statusCode": 500
    }

Last updated