WithdrawalApi.md

WithdrawalApi

All URIs are relative to https://api.gateio.ws/api/v4

Method	HTTP request	Description
withdraw	POST /withdrawals	Withdraw
withdrawPushOrder	POST /withdrawals/push	UID transfer
cancelWithdrawal	DELETE /withdrawals/{withdrawal_id}	Cancel withdrawal with specified ID

withdraw

LedgerRecord withdraw(ledgerRecord)

Withdraw

If the recipient's on-chain address is also Gate, no transaction fee will be charged

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.WithdrawalApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
WithdrawalApiapiInstance = newWithdrawalApi(defaultClient);
LedgerRecordledgerRecord = newLedgerRecord(); // LedgerRecord | try {
LedgerRecordresult = apiInstance.withdraw(ledgerRecord);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling WithdrawalApi#withdraw");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
ledgerRecord	LedgerRecord

Return type

LedgerRecord

Authorization

apiv4

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Withdrawal request accepted. Check withdrawal record status for processing result	-

withdrawPushOrder

UidPushWithdrawalResp withdrawPushOrder(uidPushWithdrawal)

UID transfer

Transfers between main spot accounts. Both parties cannot be sub-accounts

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.WithdrawalApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
WithdrawalApiapiInstance = newWithdrawalApi(defaultClient);
UidPushWithdrawaluidPushWithdrawal = newUidPushWithdrawal(); // UidPushWithdrawal | try {
UidPushWithdrawalRespresult = apiInstance.withdrawPushOrder(uidPushWithdrawal);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling WithdrawalApi#withdrawPushOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
uidPushWithdrawal	UidPushWithdrawal

Return type

UidPushWithdrawalResp

Authorization

apiv4

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request accepted. Check withdrawal record status for processing result	-

cancelWithdrawal

WithdrawalsDel cancelWithdrawal(withdrawalId)

Cancel withdrawal with specified ID

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.WithdrawalApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
WithdrawalApiapiInstance = newWithdrawalApi(defaultClient);
StringwithdrawalId = "210496"; // String | try {
WithdrawalsDelresult = apiInstance.cancelWithdrawal(withdrawalId);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling WithdrawalApi#cancelWithdrawal");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
withdrawalId	String

Return type

WithdrawalsDel

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Cancellation request accepted. Check record status for cancellation result	-