Cryptopay API
  • Welcome
  • Guides
    • Introduction
    • Environments
    • Creating a Test Account
    • API Credentials
    • API Basics
      • Responses
      • Date formats
      • Authentication
        • How it works
        • Signature
        • Creating a signature. Code samples
      • Callbacks
    • API Client Libraries
    • API Reference
    • Cryptocurrency Payments
    • Currencies
      • Supported Currencies
      • Currency Icons
    • Confirmations
    • Tools for accepting payments
    • Prebuilt integrations
      • E-commerce payment plugins
      • Payment and software providers
    • Channels
      • Channel payment
      • Payment statuses
      • Channel payment sequence
      • Create a Channel
      • Visual representation at Cashier
      • Channel hosted page
      • Channel payment callbacks
    • Invoices
      • Invoice statuses
      • Invoice payment sequence
      • How to handle unresolved invoices
        • Underpaid
        • Overpaid
        • Paid late
        • Illicit resource
        • Invoice refunds sequence
      • Create an invoice
      • Visual presentation at Cashier
      • Invoice hosted page
      • Online checkout
        • How-to
      • Payment links
      • Invoice callbacks
    • Payouts
      • Payout statuses
      • Payout sequence
      • Payout fees consideration
        • Network fees
      • Create a Coin Withdrawal
        • Possible errors
        • Withdrawals from fiat accounts
        • Withdrawals from cryptocurrency accounts
        • high_risk_address error message
      • Visual representation at Cashier
      • Minimum transaction amount
      • Coin Withdrawal callbacks
      • Travel Rule Compliance
    • Email Billing
      • Create an email billing
      • Email billing callbacks
    • Testing
      • Channels
      • Invoices
      • Payouts
    • Risks
    • Customers
    • Transactions types and Statuses
Powered by GitBook
On this page
  • Insufficient account balance
  • Minimal amount limit
  • Invalid address
  • High-risk destination address
  • Invalid currency
  • Bad precision
  • Limit exceeded
  1. Guides
  2. Payouts
  3. Create a Coin Withdrawal

Possible errors

Insufficient account balance

422 Unprocessable Entity in case you exceed your account balance:

{
  "error": {
    "code": "invalid",
    "message": "invalid",
    "details": [
      {
        "code": "must_be_less_than_or_equal",
        "target": "charged_amount",
        "message": "must be less than or equal to 167.75222297",
        "args": {
          "value": "167.75222297"
        }
      },
      {
        "code": "must_be_less_than_or_equal",
        "target": "received_amount",
        "message": "must be less than or equal to 12500.0",
        "args": {
          "value": "12500.0"
        }
      }
    ]
  },
  "meta": {
    "request_id": "0919053f1c2675f62824bc3aabed3697"
  }
}

Minimal amount limit

422 Unprocessable Entity in case a payout amount is less than 5 EUR:

{
  "error": {
    "code": "invalid",
    "message": "invalid",
    "details": [
      {
        "code": "must_be_greater_than_or_equal",
        "target": "charged_amount_to_send",
        "message": "must be greater than or equal to 5.0",
        "args": {
          "value": "5.0"
        }
      }
    ]
  },
  "meta": {
    "request_id": "6fd8b3b615f1fca80e1b29f7f102e090"
  }
}

Invalid address

422 Unprocessable Entity in case the address format is not valid:

{
  "error": {
    "code": "invalid",
    "message": "invalid",
    "details": [
      {
        "code": "invalid_coin_address",
        "target": "address",
        "message": "must be a valid BTC address",
        "args": {
          "currency": "BTC"
        }
      }
    ]
  },
  "meta": {
    "request_id": "1ea0414b9b9bc9a558f9a31a392e9778"
  }
}

High-risk destination address

422 Unprocessable Entity in case a destination address is evaluated as high-risk:

{
  "error": {
    "code": "high_risk_address",
    "message": "We were unable to process your request as the address of the recipient may be associated with resource primarily used for unlawful activities",
    "details": []
  },
  "meta": {
    "request_id": "e1327567dc4189901aa2463e85b96b93"
  }
}

Invalid currency

422 Unprocessable Entity in case you specified currency that is not valid:

{
  "error": {
    "code": "invalid",
    "message": "invalid",
    "details": [
      {
        "code": "must_be_included_in",
        "target": "charged_currency",
        "message": "must be one of: BTC, LTC, GBP, CNY, TRY, USD, RUB, KRW, NOK, INR, BCH, ETH, JPY, CAD, THB, AUD, HKD, MYR, NZD, TWD, MXN, BRL, COP, SEK, PLN, HUF, IDR, VND, XRP, EUR",
        "args": {
          "list": [
            "BTC",
            "LTC",
            "GBP",
            "CNY",
            "TRY",
            "USD",
            "RUB",
            "KRW",
            "NOK",
            "INR",
            "BCH",
            "ETH",
            "JPY",
            "CAD",
            "THB",
            "AUD",
            "HKD",
            "MYR",
            "NZD",
            "TWD",
            "MXN",
            "BRL",
            "COP",
            "SEK",
            "PLN",
            "HUF",
            "IDR",
            "VND",
            "XRP",
            "EUR"
          ]
        }
      }
    ]
  },
  "meta": {
    "request_id": "1cdd48b0d123f5445991e25eb1ce6f50"
  }
}

Bad precision

422 Unprocessable Entity in case the amount precision does not match currency precision:

{
    "error": {
        "code": "invalid",
        "message": "invalid",
        "args": {},
        "details": [
            {
                "code": "bad_precision",
                "target": "charged_amount",
                "message": "must match EUR precision",
                "args": {
                    "currency": "EUR",
                    "precision": 2
                }
            }
        ]
    },
    "meta": {
        "request_id": "cdeb3d14afbe8419697f75e13608ef58"
    }
}

Limit exceeded

422 Unprocessable Entity in case of exceeding the withdrawal limits:

{
  "error": {
    "code": "out_of_limits",
    "message": "out of limits",
    "args": {},
    "details": []
  },
  "meta": {
    "request_id": "79bf8ca47e313c12bf5fb300095cb6b6"
  }
}
PreviousCreate a Coin WithdrawalNextWithdrawals from fiat accounts

Last updated 1 year ago