Create Withdrawal

Dive into the specifics of each API endpoint by checking out our complete documentation.

The process of creating withdrawals is a little more complex than payments. The reason for this is to ensure that you enter all your requests correctly during the API request to avoid confusion and loss of funds when you withdraw. First of all, fiat_currency and fiat_amount values ​​represent the actual currency (USD, EUR, TRY) you want to withdraw from. Fiat amount reflects the amount you want to create from this currency. The amount of cryptocurrency cannot be entered in this endpoint. To enter the amount of cryptocurrency, you must use the coin Withdraw endpoint.

The second important issue is the choice of coin and network. At the endpoint of the coin list, the supported coins and whether withdrawal can be made are indicated. Additionally, each coin has its own network list. You must enter these coin and network values ​​with the SHORT values ​​of the coin and network objects.

Creating Withdraw Request

POST /withdraw

This endpoint allows you to create withdrawal request.

This endpoint allows you to create withdraw.

post
/withdraw
Authorizations
AuthorizationstringRequired
Body
merchant_idstringRequired
transaction_idstring · int64Required
fiat_currencystringRequiredExample: USD
fiat_amountinteger · floatRequiredExample: 100
addressstringRequired
tagstringOptional
coinstringRequiredExample: BTC
networkstringRequiredExample: BSC
descriptionstringOptional
Responses
200

successful operation

application/json
post
/withdraw
POST /api/merchant/withdraw HTTP/1.1
Host: kriptopay.com
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 166

"merchant_id='text'&transaction_id='text'&fiat_currency='USD'&fiat_amount=100&address='text'&tag='text'&coin='BTC'&network='BSC'&description='text'"
{
  "withdraw_id": 1,
  "transaction_id": "text",
  "fiat_currency": "USD",
  "fiat_amount": 100,
  "address": "text",
  "tag": "text",
  "description": "text",
  "coin": "BTC",
  "network": "BSC",
  "amount": 1,
  "status": "COMPLETE"
}

Request Body

Name
Type
Description

merchant_id

string

Your merchant id

transaction_id

string

Custom transaction id generated by you

coin

string

Crypto currency Short name

network

string

Crypto network Short name associated by selected coin

fiat_currency

string

Fiat currency short name (USD, EUR, GBP)

fiat_amount

float

Fiat amount for choosen fiat currency

address

string

Recipient crypto currency address

tag

string

Tag/MEMO if network needs required_tag

description

string

Information that identifies the withdraw. UserID, productID etc.

Response

{
    "success": true,
    "data": {
        "withdraw_id": "tjLX6SgrnJ6k",
        "transaction_id": "test",
        "fiat_currency": "USD",
        "fiat_amount": "100.00",
        "address": "test",
        "currency": "Bitcoin",
        "tag": null,
        "description": null,
        "status": "PENDING",
        "amount": "0.00004579",
        "network": "Bitcoin"
    }
}

After created withdraw request, if everything is OK, the withdrawal process is processed by us. After the process is completed, a callback containing tx_id will be sent to you.

Last updated