Place withdrawal order
curl --request POST \
--url https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"batch_id": "237394559478075350",
"withdraw_list": [
{
"merchant_withdraw_id": "M137394559478075550",
"currency": "USDT",
"amount": "1",
"chain": "ETH",
"address": "0x1234567890abcdef",
"memo": "Payment for services-1",
"fee_type": 1,
"remark": "Employee A"
},
{
"merchant_withdraw_id": "M137394559478075551",
"currency": "USDT",
"amount": "0.001",
"chain": "ETH",
"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"memo": "Payment for services-1",
"fee_type": 0,
"remark": "Employee A"
}
]
}
'import requests
url = "https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts"
payload = {
"batch_id": "237394559478075350",
"withdraw_list": [
{
"merchant_withdraw_id": "M137394559478075550",
"currency": "USDT",
"amount": "1",
"chain": "ETH",
"address": "0x1234567890abcdef",
"memo": "Payment for services-1",
"fee_type": 1,
"remark": "Employee A"
},
{
"merchant_withdraw_id": "M137394559478075551",
"currency": "USDT",
"amount": "0.001",
"chain": "ETH",
"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"memo": "Payment for services-1",
"fee_type": 0,
"remark": "Employee A"
}
]
}
headers = {
"X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
"X-GatePay-Signature": "<x-gatepay-signature>",
"X-GatePay-Timestamp": "<x-gatepay-timestamp>",
"X-GatePay-Nonce": "<x-gatepay-nonce>",
"X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
'X-GatePay-Signature': '<x-gatepay-signature>',
'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
'X-GatePay-Nonce': '<x-gatepay-nonce>',
'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
batch_id: '237394559478075350',
withdraw_list: [
{
merchant_withdraw_id: 'M137394559478075550',
currency: 'USDT',
amount: '1',
chain: 'ETH',
address: '0x1234567890abcdef',
memo: 'Payment for services-1',
fee_type: 1,
remark: 'Employee A'
},
{
merchant_withdraw_id: 'M137394559478075551',
currency: 'USDT',
amount: '0.001',
chain: 'ETH',
address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
memo: 'Payment for services-1',
fee_type: 0,
remark: 'Employee A'
}
]
})
};
fetch('https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'batch_id' => '237394559478075350',
'withdraw_list' => [
[
'merchant_withdraw_id' => 'M137394559478075550',
'currency' => 'USDT',
'amount' => '1',
'chain' => 'ETH',
'address' => '0x1234567890abcdef',
'memo' => 'Payment for services-1',
'fee_type' => 1,
'remark' => 'Employee A'
],
[
'merchant_withdraw_id' => 'M137394559478075551',
'currency' => 'USDT',
'amount' => '0.001',
'chain' => 'ETH',
'address' => '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
'memo' => 'Payment for services-1',
'fee_type' => 0,
'remark' => 'Employee A'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
"X-GatePay-Nonce: <x-gatepay-nonce>",
"X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
"X-GatePay-Signature: <x-gatepay-signature>",
"X-GatePay-Timestamp: <x-gatepay-timestamp>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts")
.header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
.header("X-GatePay-Signature", "<x-gatepay-signature>")
.header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
.header("X-GatePay-Nonce", "<x-gatepay-nonce>")
.header("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
.header("Content-Type", "application/json")
.body("{\n \"batch_id\": \"237394559478075350\",\n \"withdraw_list\": [\n {\n \"merchant_withdraw_id\": \"M137394559478075550\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"chain\": \"ETH\",\n \"address\": \"0x1234567890abcdef\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 1,\n \"remark\": \"Employee A\"\n },\n {\n \"merchant_withdraw_id\": \"M137394559478075551\",\n \"currency\": \"USDT\",\n \"amount\": \"0.001\",\n \"chain\": \"ETH\",\n \"address\": \"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 0,\n \"remark\": \"Employee A\"\n }\n ]\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts"
payload := strings.NewReader("{\n \"batch_id\": \"237394559478075350\",\n \"withdraw_list\": [\n {\n \"merchant_withdraw_id\": \"M137394559478075550\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"chain\": \"ETH\",\n \"address\": \"0x1234567890abcdef\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 1,\n \"remark\": \"Employee A\"\n },\n {\n \"merchant_withdraw_id\": \"M137394559478075551\",\n \"currency\": \"USDT\",\n \"amount\": \"0.001\",\n \"chain\": \"ETH\",\n \"address\": \"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 0,\n \"remark\": \"Employee A\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
req.Header.Add("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"batch_id\": \"237394559478075350\",\n \"withdraw_list\": [\n {\n \"merchant_withdraw_id\": \"M137394559478075550\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"chain\": \"ETH\",\n \"address\": \"0x1234567890abcdef\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 1,\n \"remark\": \"Employee A\"\n },\n {\n \"merchant_withdraw_id\": \"M137394559478075551\",\n \"currency\": \"USDT\",\n \"amount\": \"0.001\",\n \"chain\": \"ETH\",\n \"address\": \"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 0,\n \"remark\": \"Employee A\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"batch_id": "237394559478075550"
}
}Withdraw
Create Withdrawal
Create a batch withdrawal order. The merchant submits one batch ID with multiple withdrawal sub-orders.
POST
/
withdraw
/
open
/
institution
/
v1
/
pay
/
create
/
payouts
Place withdrawal order
curl --request POST \
--url https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"batch_id": "237394559478075350",
"withdraw_list": [
{
"merchant_withdraw_id": "M137394559478075550",
"currency": "USDT",
"amount": "1",
"chain": "ETH",
"address": "0x1234567890abcdef",
"memo": "Payment for services-1",
"fee_type": 1,
"remark": "Employee A"
},
{
"merchant_withdraw_id": "M137394559478075551",
"currency": "USDT",
"amount": "0.001",
"chain": "ETH",
"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"memo": "Payment for services-1",
"fee_type": 0,
"remark": "Employee A"
}
]
}
'import requests
url = "https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts"
payload = {
"batch_id": "237394559478075350",
"withdraw_list": [
{
"merchant_withdraw_id": "M137394559478075550",
"currency": "USDT",
"amount": "1",
"chain": "ETH",
"address": "0x1234567890abcdef",
"memo": "Payment for services-1",
"fee_type": 1,
"remark": "Employee A"
},
{
"merchant_withdraw_id": "M137394559478075551",
"currency": "USDT",
"amount": "0.001",
"chain": "ETH",
"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"memo": "Payment for services-1",
"fee_type": 0,
"remark": "Employee A"
}
]
}
headers = {
"X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
"X-GatePay-Signature": "<x-gatepay-signature>",
"X-GatePay-Timestamp": "<x-gatepay-timestamp>",
"X-GatePay-Nonce": "<x-gatepay-nonce>",
"X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
'X-GatePay-Signature': '<x-gatepay-signature>',
'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
'X-GatePay-Nonce': '<x-gatepay-nonce>',
'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
batch_id: '237394559478075350',
withdraw_list: [
{
merchant_withdraw_id: 'M137394559478075550',
currency: 'USDT',
amount: '1',
chain: 'ETH',
address: '0x1234567890abcdef',
memo: 'Payment for services-1',
fee_type: 1,
remark: 'Employee A'
},
{
merchant_withdraw_id: 'M137394559478075551',
currency: 'USDT',
amount: '0.001',
chain: 'ETH',
address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
memo: 'Payment for services-1',
fee_type: 0,
remark: 'Employee A'
}
]
})
};
fetch('https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'batch_id' => '237394559478075350',
'withdraw_list' => [
[
'merchant_withdraw_id' => 'M137394559478075550',
'currency' => 'USDT',
'amount' => '1',
'chain' => 'ETH',
'address' => '0x1234567890abcdef',
'memo' => 'Payment for services-1',
'fee_type' => 1,
'remark' => 'Employee A'
],
[
'merchant_withdraw_id' => 'M137394559478075551',
'currency' => 'USDT',
'amount' => '0.001',
'chain' => 'ETH',
'address' => '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
'memo' => 'Payment for services-1',
'fee_type' => 0,
'remark' => 'Employee A'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
"X-GatePay-Nonce: <x-gatepay-nonce>",
"X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
"X-GatePay-Signature: <x-gatepay-signature>",
"X-GatePay-Timestamp: <x-gatepay-timestamp>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts")
.header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
.header("X-GatePay-Signature", "<x-gatepay-signature>")
.header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
.header("X-GatePay-Nonce", "<x-gatepay-nonce>")
.header("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
.header("Content-Type", "application/json")
.body("{\n \"batch_id\": \"237394559478075350\",\n \"withdraw_list\": [\n {\n \"merchant_withdraw_id\": \"M137394559478075550\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"chain\": \"ETH\",\n \"address\": \"0x1234567890abcdef\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 1,\n \"remark\": \"Employee A\"\n },\n {\n \"merchant_withdraw_id\": \"M137394559478075551\",\n \"currency\": \"USDT\",\n \"amount\": \"0.001\",\n \"chain\": \"ETH\",\n \"address\": \"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 0,\n \"remark\": \"Employee A\"\n }\n ]\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts"
payload := strings.NewReader("{\n \"batch_id\": \"237394559478075350\",\n \"withdraw_list\": [\n {\n \"merchant_withdraw_id\": \"M137394559478075550\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"chain\": \"ETH\",\n \"address\": \"0x1234567890abcdef\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 1,\n \"remark\": \"Employee A\"\n },\n {\n \"merchant_withdraw_id\": \"M137394559478075551\",\n \"currency\": \"USDT\",\n \"amount\": \"0.001\",\n \"chain\": \"ETH\",\n \"address\": \"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 0,\n \"remark\": \"Employee A\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
req.Header.Add("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/create/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"batch_id\": \"237394559478075350\",\n \"withdraw_list\": [\n {\n \"merchant_withdraw_id\": \"M137394559478075550\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"chain\": \"ETH\",\n \"address\": \"0x1234567890abcdef\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 1,\n \"remark\": \"Employee A\"\n },\n {\n \"merchant_withdraw_id\": \"M137394559478075551\",\n \"currency\": \"USDT\",\n \"amount\": \"0.001\",\n \"chain\": \"ETH\",\n \"address\": \"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa\",\n \"memo\": \"Payment for services-1\",\n \"fee_type\": 0,\n \"remark\": \"Employee A\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"batch_id": "237394559478075550"
}
}Overview
This page documents thePOST /withdraw/open/institution/v1/pay/create/payouts endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This page documents the institution-path variant of the same API.
- Institution requests must include
X-GatePay-On-Behalf-Ofto indicate the initiating account context for the delegated request. - For shared signing rules, see /global/api-reference/version/100/en/common/securityAndSignature.
Institution Notes
- Institutional requests must include
X-GatePay-On-Behalf-Ofto specify the institutional sub-account to operate on.
Headers
The clientId assigned when the merchant registers an application in the Gate merchant console.
Example:
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
Request signature. GatePay uses this signature to verify whether the request is valid.
Millisecond timestamp; the difference from server time must not exceed 30 seconds.
Example:
"1672905655498"
Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.
Example:
"9578"
Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.
Body
application/json
Request body for placing a batch withdrawal order.
A unique ID generated by the merchant, composed of uppercase and lowercase letters, numbers, and underscores, max length 32 characters.
Details of each withdrawal sub-order.
Show child attributes
Show child attributes
Client name.
Remark. Maximum length 200 characters.