P2pApi

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
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

p2pMerchantAccountGetUserInfo

Promise<{ response: http.IncomingMessage; body: P2pMerchantUserInfoResponse; }> p2pMerchantAccountGetUserInfo()

Get account information

Example

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));

Parameters

This endpoint does not need any parameter.

Return type

Promise<{ response: AxiosResponse; body: P2pMerchantUserInfoResponse; }> P2pMerchantUserInfoResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

p2pMerchantAccountGetCounterpartyUserInfo

Promise<{ response: http.IncomingMessage; body: P2pCounterpartyUserInfoResponse; }> p2pMerchantAccountGetCounterpartyUserInfo(getCounterpartyUserInfoRequest)

Get counterparty information

Example

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));

Parameters

Name	Type	Description	Notes
getCounterpartyUserInfoRequest	GetCounterpartyUserInfoRequest

Return type

Promise<{ response: AxiosResponse; body: P2pCounterpartyUserInfoResponse; }> P2pCounterpartyUserInfoResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantAccountGetMyselfPayment

Promise<{ response: http.IncomingMessage; body: P2pPaymentMethodsResponse; }> p2pMerchantAccountGetMyselfPayment(opts)

Get payment method list

Example

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));

Parameters

Name	Type	Description	Notes
getMyselfPaymentRequest	GetMyselfPaymentRequest		[optional]

Return type

Promise<{ response: AxiosResponse; body: P2pPaymentMethodsResponse; }> P2pPaymentMethodsResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantTransactionGetPendingTransactionList

Promise<{ response: http.IncomingMessage; body: P2pTransactionListResponse; }> p2pMerchantTransactionGetPendingTransactionList(getPendingTransactionListRequest)

Get pending orders

Example

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));

Parameters

Name	Type	Description	Notes
getPendingTransactionListRequest	GetPendingTransactionListRequest

Return type

Promise<{ response: AxiosResponse; body: P2pTransactionListResponse; }> P2pTransactionListResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantTransactionGetCompletedTransactionList

Promise<{ response: http.IncomingMessage; body: P2pTransactionListResponse; }> p2pMerchantTransactionGetCompletedTransactionList(getCompletedTransactionListRequest)

Get all/historical orders

Example

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));

Parameters

Name	Type	Description	Notes
getCompletedTransactionListRequest	GetCompletedTransactionListRequest

Return type

Promise<{ response: AxiosResponse; body: P2pTransactionListResponse; }> P2pTransactionListResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantTransactionGetTransactionDetails

Promise<{ response: http.IncomingMessage; body: P2pTransactionDetailResponse; }> p2pMerchantTransactionGetTransactionDetails(getTransactionDetailsRequest)

Query order details

Example

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));

Parameters

Name	Type	Description	Notes
getTransactionDetailsRequest	GetTransactionDetailsRequest

Return type

Promise<{ response: AxiosResponse; body: P2pTransactionDetailResponse; }> P2pTransactionDetailResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantTransactionConfirmPayment

Promise<{ response: http.IncomingMessage; body: P2pTransactionActionResponse; }> p2pMerchantTransactionConfirmPayment(confirmPayment)

Confirm payment

Example

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));

Parameters

Name	Type	Description	Notes
confirmPayment	ConfirmPayment

Return type

Promise<{ response: AxiosResponse; body: P2pTransactionActionResponse; }> P2pTransactionActionResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantTransactionConfirmReceipt

Promise<{ response: http.IncomingMessage; body: P2pTransactionActionResponse; }> p2pMerchantTransactionConfirmReceipt(confirmReceipt)

Confirm receipt

Example

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));

Parameters

Name	Type	Description	Notes
confirmReceipt	ConfirmReceipt

Return type

Promise<{ response: AxiosResponse; body: P2pTransactionActionResponse; }> P2pTransactionActionResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantTransactionCancel

Promise<{ response: http.IncomingMessage; body: P2pTransactionActionResponse; }> p2pMerchantTransactionCancel(cancelOrder)

Cancel order

Example

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));

Parameters

Name	Type	Description	Notes
cancelOrder	CancelOrder

Return type

Promise<{ response: AxiosResponse; body: P2pTransactionActionResponse; }> P2pTransactionActionResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantBooksPlaceBizPushOrder

Promise<{ response: http.IncomingMessage; body: P2pMerchantBooksPlaceBizPushOrderResponse; }> p2pMerchantBooksPlaceBizPushOrder(placeBizPushOrder)

Publish ad order

Example

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));

Parameters

Name	Type	Description	Notes
placeBizPushOrder	PlaceBizPushOrder

Return type

Promise<{ response: AxiosResponse; body: P2pMerchantBooksPlaceBizPushOrderResponse; }> P2pMerchantBooksPlaceBizPushOrderResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantBooksAdsUpdateStatus

Promise<{ response: http.IncomingMessage; body: P2pAdsUpdateStatusResponse; }> p2pMerchantBooksAdsUpdateStatus(adsUpdateStatus)

Update ad status

Example

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));

Parameters

Name	Type	Description	Notes
adsUpdateStatus	AdsUpdateStatus

Return type

Promise<{ response: AxiosResponse; body: P2pAdsUpdateStatusResponse; }> P2pAdsUpdateStatusResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantBooksAdsDetail

Promise<{ response: http.IncomingMessage; body: P2pAdDetailResponse; }> p2pMerchantBooksAdsDetail(adsDetailRequest)

Query ad details

Example

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));

Parameters

Name	Type	Description	Notes
adsDetailRequest	AdsDetailRequest

Return type

Promise<{ response: AxiosResponse; body: P2pAdDetailResponse; }> P2pAdDetailResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantBooksMyAdsList

Promise<{ response: http.IncomingMessage; body: P2pMyAdsListResponse; }> p2pMerchantBooksMyAdsList(opts)

Get my ad list

Example

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));

Parameters

Name	Type	Description	Notes
myAdsListRequest	MyAdsListRequest		[optional]

Return type

Promise<{ response: AxiosResponse; body: P2pMyAdsListResponse; }> P2pMyAdsListResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantBooksAdsList

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

Example

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));

Parameters

Name	Type	Description	Notes
adsListRequest	AdsListRequest

Return type

Promise<{ response: AxiosResponse; body: P2pAdsListResponse; }> P2pAdsListResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantChatGetChatsList

Promise<{ response: http.IncomingMessage; body: P2pChatListResponse; }> p2pMerchantChatGetChatsList(getChatsListRequest)

Get chat history

Example

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));

Parameters

Name	Type	Description	Notes
getChatsListRequest	GetChatsListRequest

Return type

Promise<{ response: AxiosResponse; body: P2pChatListResponse; }> P2pChatListResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantChatSendChatMessage

Promise<{ response: http.IncomingMessage; body: P2pSendChatMessageResponse; }> p2pMerchantChatSendChatMessage(sendChatMessageRequest)

Send text message

Example

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));

Parameters

Name	Type	Description	Notes
sendChatMessageRequest	SendChatMessageRequest

Return type

Promise<{ response: AxiosResponse; body: P2pSendChatMessageResponse; }> P2pSendChatMessageResponse

Authorization

apiv4

HTTP request headers

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

p2pMerchantChatUploadChatFile

Promise<{ response: http.IncomingMessage; body: P2pUploadChatFileResponse; }> p2pMerchantChatUploadChatFile(uploadChatFile)

Upload chat file

Example

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));

Parameters

Name	Type	Description	Notes
uploadChatFile	UploadChatFile

Return type

Promise<{ response: AxiosResponse; body: P2pUploadChatFileResponse; }> P2pUploadChatFileResponse

Authorization

apiv4

HTTP request headers

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

FilesExpand file tree

P2pApi.md

Latest commit

History

P2pApi.md

File metadata and controls

P2pApi

p2pMerchantAccountGetUserInfo

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantAccountGetCounterpartyUserInfo

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantAccountGetMyselfPayment

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantTransactionGetPendingTransactionList

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantTransactionGetCompletedTransactionList

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantTransactionGetTransactionDetails

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantTransactionConfirmPayment

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantTransactionConfirmReceipt

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantTransactionCancel

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantBooksPlaceBizPushOrder

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantBooksAdsUpdateStatus

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantBooksAdsDetail

Example

Parameters

Return type

Authorization

HTTP request headers

p2pMerchantBooksMyAdsList