All URIs are relative to https://api.gateio.ws/api/v4
| Method | HTTP request | Description |
|---|---|---|
| p2pMerchantAccountGetUserInfo | POST /p2p/merchant/account/get_user_info | Get account information |
| p2pMerchantAccountGetCounterpartyUserInfo | POST /p2p/merchant/account/get_counterparty_user_info | Get counterparty information |
| p2pMerchantAccountGetMyselfPayment | POST /p2p/merchant/account/get_myself_payment | Get payment method list |
| p2pMerchantAccountSetMerchantWorkHours | POST /p2p/merchant/account/set_merchant_work_hours | Set merchant working status and custom working hours |
| p2pMerchantTransactionGetPendingTransactionList | POST /p2p/merchant/transaction/get_pending_transaction_list | Get pending orders |
| p2pMerchantTransactionGetCompletedTransactionList | POST /p2p/merchant/transaction/get_completed_transaction_list | Get all/historical orders |
| p2pMerchantTransactionGetTransactionDetails | POST /p2p/merchant/transaction/get_transaction_details | Query order details |
| p2pMerchantTransactionConfirmPayment | POST /p2p/merchant/transaction/confirm-payment | Confirm payment |
| p2pMerchantTransactionConfirmReceipt | POST /p2p/merchant/transaction/confirm-receipt | Confirm receipt |
| p2pMerchantTransactionCancel | POST /p2p/merchant/transaction/cancel | Cancel order |
| p2pMerchantBooksPlaceBizPushOrder | POST /p2p/merchant/books/place_biz_push_order | Publish ad order |
| p2pMerchantBooksAdsUpdateStatus | POST /p2p/merchant/books/ads_update_status | Update ad status |
| p2pMerchantBooksAdsDetail | POST /p2p/merchant/books/ads_detail | Query ad details |
| p2pMerchantBooksMyAdsList | POST /p2p/merchant/books/my_ads_list | Get my ad list |
| p2pMerchantBooksAdsList | POST /p2p/merchant/books/ads_list | Get Advertisement List |
| p2pMerchantChatGetChatsList | POST /p2p/merchant/chat/get_chats_list | Get chat history |
| p2pMerchantChatSendChatMessage | POST /p2p/merchant/chat/send_chat_message | Send text message |
| p2pMerchantChatUploadChatFile | POST /p2p/merchant/chat/upload_chat_file | Upload chat file |
| p2pMerchantChatPreUploadChatFile | POST /p2p/merchant/chat/pre_upload_chat_file | Pre-upload chat file |
Promise<{ response: http.IncomingMessage; body: P2pMerchantUserInfoResponse; }> p2pMerchantAccountGetUserInfo()
Get account information
To query the spot account balance, use the Spot API `GET /spot/accounts`.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
api.p2pMerchantAccountGetUserInfo()
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));This endpoint does not need any parameter.
Promise<{ response: AxiosResponse; body: P2pMerchantUserInfoResponse; }> P2pMerchantUserInfoResponse
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pCounterpartyUserInfoResponse; }> p2pMerchantAccountGetCounterpartyUserInfo(getCounterpartyUserInfoRequest)
Get counterparty information
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const getCounterpartyUserInfoRequest = new GetCounterpartyUserInfoRequest(); // GetCounterpartyUserInfoRequest |
api.p2pMerchantAccountGetCounterpartyUserInfo(getCounterpartyUserInfoRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| getCounterpartyUserInfoRequest | GetCounterpartyUserInfoRequest |
Promise<{ response: AxiosResponse; body: P2pCounterpartyUserInfoResponse; }> P2pCounterpartyUserInfoResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pPaymentMethodsResponse; }> p2pMerchantAccountGetMyselfPayment(opts)
Get payment method list
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const opts = {
'getMyselfPaymentRequest': new GetMyselfPaymentRequest() // GetMyselfPaymentRequest |
};
api.p2pMerchantAccountGetMyselfPayment(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| getMyselfPaymentRequest | GetMyselfPaymentRequest | [optional] |
Promise<{ response: AxiosResponse; body: P2pPaymentMethodsResponse; }> P2pPaymentMethodsResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pMerchantWorkHoursResponse; }> p2pMerchantAccountSetMerchantWorkHours(setMerchantWorkHoursRequest)
Set merchant working status and custom working hours
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const setMerchantWorkHoursRequest = new SetMerchantWorkHoursRequest(); // SetMerchantWorkHoursRequest |
api.p2pMerchantAccountSetMerchantWorkHours(setMerchantWorkHoursRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| setMerchantWorkHoursRequest | SetMerchantWorkHoursRequest |
Promise<{ response: AxiosResponse; body: P2pMerchantWorkHoursResponse; }> P2pMerchantWorkHoursResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pTransactionListResponse; }> p2pMerchantTransactionGetPendingTransactionList(getPendingTransactionListRequest)
Get pending orders
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const getPendingTransactionListRequest = new GetPendingTransactionListRequest(); // GetPendingTransactionListRequest |
api.p2pMerchantTransactionGetPendingTransactionList(getPendingTransactionListRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| getPendingTransactionListRequest | GetPendingTransactionListRequest |
Promise<{ response: AxiosResponse; body: P2pTransactionListResponse; }> P2pTransactionListResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pTransactionListResponse; }> p2pMerchantTransactionGetCompletedTransactionList(getCompletedTransactionListRequest)
Get all/historical orders
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const getCompletedTransactionListRequest = new GetCompletedTransactionListRequest(); // GetCompletedTransactionListRequest |
api.p2pMerchantTransactionGetCompletedTransactionList(getCompletedTransactionListRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| getCompletedTransactionListRequest | GetCompletedTransactionListRequest |
Promise<{ response: AxiosResponse; body: P2pTransactionListResponse; }> P2pTransactionListResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pTransactionDetailResponse; }> p2pMerchantTransactionGetTransactionDetails(getTransactionDetailsRequest)
Query order details
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const getTransactionDetailsRequest = new GetTransactionDetailsRequest(); // GetTransactionDetailsRequest |
api.p2pMerchantTransactionGetTransactionDetails(getTransactionDetailsRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| getTransactionDetailsRequest | GetTransactionDetailsRequest |
Promise<{ response: AxiosResponse; body: P2pTransactionDetailResponse; }> P2pTransactionDetailResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pTransactionActionResponse; }> p2pMerchantTransactionConfirmPayment(confirmPayment)
Confirm payment
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const confirmPayment = new ConfirmPayment(); // ConfirmPayment |
api.p2pMerchantTransactionConfirmPayment(confirmPayment)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| confirmPayment | ConfirmPayment |
Promise<{ response: AxiosResponse; body: P2pTransactionActionResponse; }> P2pTransactionActionResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pTransactionActionResponse; }> p2pMerchantTransactionConfirmReceipt(confirmReceipt)
Confirm receipt
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const confirmReceipt = new ConfirmReceipt(); // ConfirmReceipt |
api.p2pMerchantTransactionConfirmReceipt(confirmReceipt)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| confirmReceipt | ConfirmReceipt |
Promise<{ response: AxiosResponse; body: P2pTransactionActionResponse; }> P2pTransactionActionResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pTransactionActionResponse; }> p2pMerchantTransactionCancel(cancelOrder)
Cancel order
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const cancelOrder = new CancelOrder(); // CancelOrder |
api.p2pMerchantTransactionCancel(cancelOrder)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| cancelOrder | CancelOrder |
Promise<{ response: AxiosResponse; body: P2pTransactionActionResponse; }> P2pTransactionActionResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pMerchantBooksPlaceBizPushOrderResponse; }> p2pMerchantBooksPlaceBizPushOrder(placeBizPushOrder)
Publish ad order
When publishing or editing an advertisement, trade_tips and auto_reply go through off-platform traffic diversion risk control; when hit, the advertisement is not saved, and code 70305102 with data.risk_event is returned.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const placeBizPushOrder = new PlaceBizPushOrder(); // PlaceBizPushOrder |
api.p2pMerchantBooksPlaceBizPushOrder(placeBizPushOrder)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| placeBizPushOrder | PlaceBizPushOrder |
Promise<{ response: AxiosResponse; body: P2pMerchantBooksPlaceBizPushOrderResponse; }> P2pMerchantBooksPlaceBizPushOrderResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pAdsUpdateStatusResponse; }> p2pMerchantBooksAdsUpdateStatus(adsUpdateStatus)
Update ad status
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const adsUpdateStatus = new AdsUpdateStatus(); // AdsUpdateStatus |
api.p2pMerchantBooksAdsUpdateStatus(adsUpdateStatus)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| adsUpdateStatus | AdsUpdateStatus |
Promise<{ response: AxiosResponse; body: P2pAdsUpdateStatusResponse; }> P2pAdsUpdateStatusResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pAdDetailResponse; }> p2pMerchantBooksAdsDetail(adsDetailRequest)
Query ad details
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const adsDetailRequest = new AdsDetailRequest(); // AdsDetailRequest |
api.p2pMerchantBooksAdsDetail(adsDetailRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| adsDetailRequest | AdsDetailRequest |
Promise<{ response: AxiosResponse; body: P2pAdDetailResponse; }> P2pAdDetailResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pMyAdsListResponse; }> p2pMerchantBooksMyAdsList(opts)
Get my ad list
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const opts = {
'myAdsListRequest': new MyAdsListRequest() // MyAdsListRequest |
};
api.p2pMerchantBooksMyAdsList(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| myAdsListRequest | MyAdsListRequest | [optional] |
Promise<{ response: AxiosResponse; body: P2pMyAdsListResponse; }> P2pMyAdsListResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pAdsListResponse; }> p2pMerchantBooksAdsList(adsListRequest)
Get Advertisement List
Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-11-12 18:14+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const adsListRequest = new AdsListRequest(); // AdsListRequest |
api.p2pMerchantBooksAdsList(adsListRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| adsListRequest | AdsListRequest |
Promise<{ response: AxiosResponse; body: P2pAdsListResponse; }> P2pAdsListResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pChatListResponse; }> p2pMerchantChatGetChatsList(getChatsListRequest)
Get chat history
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const getChatsListRequest = new GetChatsListRequest(); // GetChatsListRequest |
api.p2pMerchantChatGetChatsList(getChatsListRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| getChatsListRequest | GetChatsListRequest |
Promise<{ response: AxiosResponse; body: P2pChatListResponse; }> P2pChatListResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pSendChatMessageResponse; }> p2pMerchantChatSendChatMessage(sendChatMessageRequest)
Send text message
Text messages go through off-platform traffic diversion risk control. When hit, the API still returns code 0, and data contains risk_type=1 and toast_msg.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const sendChatMessageRequest = new SendChatMessageRequest(); // SendChatMessageRequest |
api.p2pMerchantChatSendChatMessage(sendChatMessageRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| sendChatMessageRequest | SendChatMessageRequest |
Promise<{ response: AxiosResponse; body: P2pSendChatMessageResponse; }> P2pSendChatMessageResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pUploadChatFileResponse; }> p2pMerchantChatUploadChatFile(uploadChatFile)
Upload chat file
This endpoint is deprecated. Use Pre-upload chat file to obtain credentials for direct S3 uploads.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const uploadChatFile = new UploadChatFile(); // UploadChatFile |
api.p2pMerchantChatUploadChatFile(uploadChatFile)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| uploadChatFile | UploadChatFile |
Promise<{ response: AxiosResponse; body: P2pUploadChatFileResponse; }> P2pUploadChatFileResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: P2pPreUploadChatFileResponse; }> p2pMerchantChatPreUploadChatFile(preUploadChatFileRequest)
Pre-upload chat file
Get credentials for a direct S3 upload of a chat file. Credentials expire after 45 minutes. The maximum file size is 100 MiB. Upload the file using the returned url and fields, placing the file field last in the form. After S3 returns HTTP 204, call send_chat_message with type=1 and the returned file_key as message.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.P2pApi(client);
const preUploadChatFileRequest = new PreUploadChatFileRequest(); // PreUploadChatFileRequest |
api.p2pMerchantChatPreUploadChatFile(preUploadChatFileRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| preUploadChatFileRequest | PreUploadChatFileRequest |
Promise<{ response: AxiosResponse; body: P2pPreUploadChatFileResponse; }> P2pPreUploadChatFileResponse
- Content-Type: application/json
- Accept: application/json