WITHDRAWAL

Withdrawal is a process of transferring money from your wallet to your customer.

Crypto

Looking for something?

Feel free to contact us if you need some other payment method.

Request

{
  "merchantOrderId": "1697637323",
  "amount": "0.05",
  "currency": "btc",

  "counterparty": {
    "type": "crypto",
    "address": "3Ev6u14rfXGFJ7WhmxVGC18DNpC3qBZjBV",
    "tagOrMemo": null,
  },

  "webhookUrl": "https://example.com/webhook-url/1697637323"
}

With blockchainNetwork specification:

{
  "merchantOrderId": "1697637323",
  "amount": "82.20",
  "currency": "usdt",

  "counterparty": {
    "type": "crypto",
    "address": "TTt5AAkn5RdtBxU8Q3nH9qP9js8GSn9SLF",
    "tagOrMemo": null,

    "blockchainNetwork": "trc20" # erc20
  },

  "webhookUrl": "https://example.com/webhook-url/1697637323"
}
{
  "merchantOrderId": "1697637323",
  "amount": "82.20",
  "currency": "usdt",

  "counterparty": {
    "type": "crypto",
    "address": "TTt5AAkn5RdtBxU8Q3nH9qP9js8GSn9SLF",
    "tagOrMemo": null,

    "blockchainNetwork": "trc20" # erc20
  },

  "webhookUrl": "https://example.com/webhook-url/1697637323"
}

Response

{
  "data": {
    # An identifier of the order on our side
    "id": "d68ed1c2-1cf9-40f5-b997-3b31d1495904",
    # Provided identifier
    "merchantOrderId": "1697637323",
    # Type of order
    "type": "payout",
    "createdAt": "2023-10-18T13:55:25+00:00",
    # Status of order
    "status": "new"
  },
  "error": null
}

Error list

Code	Description
`INVALID_DATA`	Invalid request data. Check json syntax
`VALIDATION`	Validation error. See `error.validationErrors` for details
`METHOD_NOT_FOUND`	Endpoint not found
`INVALID_HTTP_METHOD`	Only POST method allowed
`AUTHENTICATION_FAILED`	Check your api token
`ORDER_ALREADY_EXISTS`	Order with same `merchantOrderId` already exists
`ORDER_NOT_FOUND`	Specified order was not found
`REJECTED_DUE_TO_TECHNICAL_ISSUE`	Rejected due to technical issue
`REQUEST_FROM_UNTRUSTED_SOURCE`	Request from untrusted source (ip not allowed)
`PAYIN_DISABLED`	Payment disabled. Contact us to enable
`PAYOUT_DISABLED`	Withdrawal disabled. Contact support to enable
`WALLET_NOT_FOUND`	Wallet not found. Contact support to enable wallet
`WALLET_INACTIVE`	Wallet inactive. Contact support to enable wallet
`ROUTING_NOT_CONFIGURED`	Routing not configured. Please contact us for details
`POINT_NOT_FOUND`	There is no way to process transaction. If issue is persistent please contact us for additional details
`AMOUNT_GREATER_THAN_ALLOWED`	Operation amount greater than allowed
`AMOUNT_LESS_THAN_ALLOWED`	Operation amount less than allowed
`NOT_ENOUGH_BALANCE`	Operation amount greater than available balance
`OPERATION_NOT_SUPPORTED`	Operation not supported
`REFERER_REQUEST_DOES_NOT_MATCH_ALLOWED_SOURCES`	Referer from request does not match user hosts. Please contact us if you have any questions.
`UNKNOWN`	Unknown error

Order status

Refer to the Status & Webhook section for generic guidance.

The new order status means that the order has not yet been processed.

This status is not final and will change.

{
  "data": {
    "id": "e300df2c-5692-4efd-8c3b-b1f498709a01",
    "merchantOrderId": "1697637323",
    "type": "payout",
    "createdAt": "2023-10-18T12:56:39+00:00",

    # Status of order
    "status": "new",
    "merchantSourceWallet": null,
    "merchantTargetWallet": null,
    "transactions": [
      {
        "type": "payout",
        "id": "de071bb1-60be-4c8c-9b3e-e5c2b5f19483",

        # Status of transaction
        "status": "new",

        # Amount of money that will be withdrawn from merchant
        "merchantWallet": {
          "amount": "100.54",
          "currency": "eur"
        },

        # Amount of money that will be received by customer
        "paidOut": {
          "amount": "100.54",
          "currency": "eur"
        },
        "counterpartyInfo": null,
        "paymentInfo": null,
        "createdAt": "2023-10-18T12:56:39+00:00",
        "completedAt": null,
        "rejectReason": null
      }
    ]
  },
  "error": null
}

Order status processing means that order is waits for its final status.

This status is not final and will change.

{
  "data": {
    "id": "e300df2c-5692-4efd-8c3b-b1f498709a01",
    "merchantOrderId": "1697637323",
    "type": "payout",
    "createdAt": "2023-10-18T12:56:39+00:00",
    # Status of order
    "status": "processing",
    "merchantSourceWallet": null,
    "merchantTargetWallet": null,
    "transactions": [
      {
        "type": "payout",
        "id": "de071bb1-60be-4c8c-9b3e-e5c2b5f19483",

        # Status of transaction
        "status": "processing",

        # Amount of money that will be withdrawn from merchant
        "merchantWallet": {
          "amount": "100.54",
          "currency": "eur"
        },

        # Amount of money that will be received by customer
        "paidOut": {
          "amount": "100.54",
          "currency": "eur"
        },
        "counterpartyInfo": null,
        "paymentInfo": null,
        "createdAt": "2023-10-18T12:56:39+00:00",
        "completedAt": null,
        "rejectReason": null
      }
    ]
  },
  "error": null
}

Order status completed means that order is completely processed.

Money already withdrawn from merchant and sent to customer.

This is final status and will not be changed.

{
  "data": {
    "id": "e300df2c-5692-4efd-8c3b-b1f498709a01",
    "merchantOrderId": "1697637323",
    "type": "payout",
    "createdAt": "2023-10-18T12:56:39+00:00",

    # Status of order
    "status": "completed",

    # Amount of money that was withdrawn from merchant
    "merchantSourceWallet": {
      "amount": "100.54",
      "currency": "eur"
    },
    "merchantTargetWallet": null,
    "transactions": [
      {
        "type": "payout",
        "id": "de071bb1-60be-4c8c-9b3e-e5c2b5f19483",

        # Status of transaction
        "status": "completed",
        "merchantWallet": {
          "amount": "100.54",
          "currency": "eur"
        },
        "paidOut": {
          "amount": "100.54",
          "currency": "eur"
        },
        "counterpartyInfo": null,
        "paymentInfo": null,
        "createdAt": "2023-10-18T12:56:39+00:00",
        "completedAt": "2023-10-18T12:59:10+00:00",
        "rejectReason": null
      }
    ]
  },
  "error": null
}

Order status rejected means that order is faced some problems.

Actual reason can be seen in rejectReason field of transaction.

This is final status and will not be changed.

{
  #... 
  "invoice": {
    "amount": "0.05",
    "currency": "btc"
  }
}
{
  "data": {
    "id": "e300df2c-5692-4efd-8c3b-b1f498709a01",
    "merchantOrderId": "1697637323",
    "type": "payout",
    "createdAt": "2023-10-18T12:56:39+00:00",

    # Status of order
    "status": "rejected",
    "merchantSourceWallet": null,
    "merchantTargetWallet": null,
    "transactions": [
      {
        "type": "payout",
        "id": "de071bb1-60be-4c8c-9b3e-e5c2b5f19483",

        # Status of transaction
        "status": "rejected",
        "merchantWallet": {
          "amount": "100.54",
          "currency": "eur"
        },
        "paidOut": {
          "amount": "100.54",
          "currency": "eur"
        },
        "counterpartyInfo": null,
        "paymentInfo": null,
        "createdAt": "2023-10-18T12:56:39+00:00",
        "completedAt": "2023-10-18T12:59:10+00:00",

        # Reason of failure
        "rejectReason": "REJECTED_BY_THIRD_PARTY"
      }
    ]
  },
  "error": null
}

Are there any inquiries still outstanding?

Our team of experts is available 24/7 to answer all your questions. Feel free to reach out to us at any time, and we will be happy to help you address any inquiries or issues. Your comfort and satisfaction are our priority.