gate_api.OTCApi

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

Method	HTTP request	Description
create_otc_quote	POST /otc/quote	Fiat and stablecoin quote
create_otc_order	POST /otc/order/create	Create fiat order
create_stable_coin_order	POST /otc/stable_coin/order/create	Create stablecoin order
get_bank_list_inner_path	GET /otc/bank/list	Get user bank card list
create_otc_bank	POST /otc/bank/create	Create bank card
delete_otc_bank	POST /otc/bank/delete	Delete bank card
set_default_otc_bank	POST /otc/bank/set_default	Set default bank card
get_otc_bank_supplement_checklist	GET /otc/bank/bank_supplement_checklist	Query the checklist of materials to supplement for a bank card
submit_otc_bank_personal_supplement	POST /otc/bank/personal/bank_supplement	Submit Bank Card Supplement Materials (Personal)
submit_otc_bank_enterprise_supplement	POST /otc/bank/enterprise/bank_supplement	Submit Bank Card Supplement Materials (Enterprise)
mark_otc_order_paid	POST /otc/order/paid	Mark fiat order as paid (deposit confirmation)
cancel_otc_order	POST /otc/order/cancel	Fiat order cancellation
list_otc_orders	GET /otc/order/list	Fiat order list
list_stable_coin_orders	GET /otc/stable_coin/order/list	Stablecoin order list
get_otc_order_detail	GET /otc/order/detail	Fiat order details

create_otc_quote

OtcQuoteResponse create_otc_quote(otc_quote_request)

Fiat and stablecoin quote

Create fiat and stablecoin quotes, supporting both PAY and GET directions

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
otc_quote_request = gate_api.OtcQuoteRequest() # OtcQuoteRequest | 

try:
    # Fiat and stablecoin quote
    api_response = api_instance.create_otc_quote(otc_quote_request)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->create_otc_quote: %s\n" % e)

Parameters

Name	Type	Description	Notes
otc_quote_request	OtcQuoteRequest

Return type

OtcQuoteResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Quote retrieved successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_otc_order

OtcActionResponse create_otc_order(otc_order_request)

Create fiat order

Create a fiat order, supporting BUY for on-ramp and SELL for off-ramp

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
otc_order_request = gate_api.OtcOrderRequest() # OtcOrderRequest | 

try:
    # Create fiat order
    api_response = api_instance.create_otc_order(otc_order_request)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->create_otc_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
otc_order_request	OtcOrderRequest

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Order created successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_stable_coin_order

OtcStableCoinOrderCreateResponse create_stable_coin_order(otc_stable_coin_order_request)

Create stablecoin order

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
otc_stable_coin_order_request = gate_api.OtcStableCoinOrderRequest() # OtcStableCoinOrderRequest | 

try:
    # Create stablecoin order
    api_response = api_instance.create_stable_coin_order(otc_stable_coin_order_request)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->create_stable_coin_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
otc_stable_coin_order_request	OtcStableCoinOrderRequest

Return type

OtcStableCoinOrderCreateResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Stablecoin order created successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_bank_list_inner_path

OtcBankListResponse get_bank_list_inner_path()

Get user bank card list

Retrieve the user's bank card list, used to select a bank card when placing an order. Default card: refer to the list item field is_default (1=default); there is no need to call the deprecated standalone "default bank card" endpoint. Corresponding Inner: GET /bank_list or GET /bank/list.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)

try:
    # Get user bank card list
    api_response = api_instance.get_bank_list_inner_path()
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->get_bank_list_inner_path: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

OtcBankListResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Query successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_otc_bank

OtcBankCreateResponse create_otc_bank(bank_account_name, bank_name, bank_country, bank_address, iban, swift, documentation_file, remittance_line_number=remittance_line_number, agent_bank_name=agent_bank_name, agent_bank_swift=agent_bank_swift)

Create bank card

Bind a bank card. Under the Global entity, an account with a non-matching name may enter manual review (status pending) and require subsequent supplementary materials. Corresponding Inner: POST /bank/create. Fields and protocol are subject to the production form/gateway; in some environments bank_account_name is passed Base64-encoded, see the integration notes for details.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
bank_account_name = 'bank_account_name_example' # str | 
bank_name = 'bank_name_example' # str | 
bank_country = 'bank_country_example' # str | 
bank_address = 'bank_address_example' # str | 
iban = 'iban_example' # str | 
swift = 'swift_example' # str | 
documentation_file = 'documentation_file_example' # str | 开户证明文件内容（multipart 文件字段，二进制/Base64；jpg/jpeg/png/pdf 等，单文件≤4MB 以现网为准）
remittance_line_number = 'remittance_line_number_example' # str |  (optional)
agent_bank_name = 'agent_bank_name_example' # str |  (optional)
agent_bank_swift = 'agent_bank_swift_example' # str |  (optional)

try:
    # Create bank card
    api_response = api_instance.create_otc_bank(bank_account_name, bank_name, bank_country, bank_address, iban, swift, documentation_file, remittance_line_number=remittance_line_number, agent_bank_name=agent_bank_name, agent_bank_swift=agent_bank_swift)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->create_otc_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_account_name	str
bank_name	str
bank_country	str
bank_address	str
iban	str
swift	str
documentation_file	str	开户证明文件内容（multipart 文件字段，二进制/Base64；jpg/jpeg/png/pdf 等，单文件≤4MB 以现网为准）
remittance_line_number	str		[optional]
agent_bank_name	str		[optional]
agent_bank_swift	str		[optional]

Return type

OtcBankCreateResponse

Authorization

apiv4

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Accepted successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_otc_bank

OtcActionResponse delete_otc_bank(otc_bank_id_request)

Delete bank card

Delete the specified bank card. Corresponds to Inner: POST /bank/delete.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
otc_bank_id_request = gate_api.OtcBankIdRequest() # OtcBankIdRequest | 

try:
    # Delete bank card
    api_response = api_instance.delete_otc_bank(otc_bank_id_request)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->delete_otc_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
otc_bank_id_request	OtcBankIdRequest

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Deleted successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_default_otc_bank

OtcActionResponse set_default_otc_bank(otc_bank_id_request)

Set default bank card

Set the specified bank card as default. Corresponds to Inner: POST /bank/set_default.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
otc_bank_id_request = gate_api.OtcBankIdRequest() # OtcBankIdRequest | 

try:
    # Set default bank card
    api_response = api_instance.set_default_otc_bank(otc_bank_id_request)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->set_default_otc_bank: %s\n" % e)

Parameters

Name	Type	Description	Notes
otc_bank_id_request	OtcBankIdRequest

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Set successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_otc_bank_supplement_checklist

OtcBankSupplementChecklistResponse get_otc_bank_supplement_checklist(bank_id)

Query the checklist of materials to supplement for a bank card

① bank_id must be specified: after verifying that the card belongs to the current user and its status allows supplementation, returns the items to be supplemented and whether each sub-item is required, based on the user's passed professional verification type (personal/enterprise). Corresponding Inner: GET /bank/bank_supplement_checklist.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
bank_id = 'bank_id_example' # str | Bank card ID (otc_rds / the id returned by the list endpoint).

try:
    # Query the checklist of materials to supplement for a bank card
    api_response = api_instance.get_otc_bank_supplement_checklist(bank_id)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->get_otc_bank_supplement_checklist: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str	Bank card ID (otc_rds / the id returned by the list endpoint).

Return type

OtcBankSupplementChecklistResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Query successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submit_otc_bank_personal_supplement

OtcActionResponse submit_otc_bank_personal_supplement(bank_id, id_document_front, id_document_back, address_proof)

Submit Bank Card Supplement Materials (Personal)

Personal professional verification (type=1) users submit non-same-person/supplementary materials. Must match user_type=personal returned by GET /otc/bank/bank_supplement_checklist?bank_id=, otherwise the request is rejected. multipart/form-data is recommended: each material item is a separate file field, with field names matching the checklist code (id_document_front, id_document_back, address_proof).

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
bank_id = 'bank_id_example' # str | 
id_document_front = 'id_document_front_example' # str | ID document front-side file content (multipart file field, binary/Base64)
id_document_back = 'id_document_back_example' # str | ID document back-side file content (multipart file field, binary/Base64)
address_proof = 'address_proof_example' # str | Proof-of-address file content (multipart file field, binary/Base64)

try:
    # Submit Bank Card Supplement Materials (Personal)
    api_response = api_instance.submit_otc_bank_personal_supplement(bank_id, id_document_front, id_document_back, address_proof)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->submit_otc_bank_personal_supplement: %s\n" % e)

Parameters

Name	Type	Description
bank_id	str
id_document_front	str	ID document front-side file content (multipart file field, binary/Base64)
id_document_back	str	ID document back-side file content (multipart file field, binary/Base64)
address_proof	str	Proof-of-address file content (multipart file field, binary/Base64)

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Accepted successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submit_otc_bank_enterprise_supplement

OtcActionResponse submit_otc_bank_enterprise_supplement(bank_id, certificate, share_holders, passport, share_holding_structure, uid=uid, funds_statement=funds_statement, additional=additional)

Submit Bank Card Supplement Materials (Enterprise)

Enterprise professional verification (type=2) users submit supplementary materials. Must match user_type=enterprise returned by the checklist. multipart file field names: certificate, share_holders, passport, share_holding_structure.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
bank_id = 'bank_id_example' # str | 
certificate = 'certificate_example' # str | Business license / registration certificate file content (multipart file field, binary/Base64)
share_holders = 'share_holders_example' # str | Register of shareholders file content (multipart file field, binary/Base64)
passport = 'passport_example' # str | Legal representative / shareholder passport file content (multipart file field, binary/Base64)
share_holding_structure = 'share_holding_structure_example' # str | Ownership structure chart file content (multipart file field, binary/Base64)
uid = 'uid_example' # str |  (optional)
funds_statement = 'funds_statement_example' # str | Proof-of-funds file content (multipart file field, binary/Base64, optional) (optional)
additional = 'additional_example' # str | Other supplementary material file content (multipart file field, binary/Base64, optional) (optional)

try:
    # Submit Bank Card Supplement Materials (Enterprise)
    api_response = api_instance.submit_otc_bank_enterprise_supplement(bank_id, certificate, share_holders, passport, share_holding_structure, uid=uid, funds_statement=funds_statement, additional=additional)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->submit_otc_bank_enterprise_supplement: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str
certificate	str	Business license / registration certificate file content (multipart file field, binary/Base64)
share_holders	str	Register of shareholders file content (multipart file field, binary/Base64)
passport	str	Legal representative / shareholder passport file content (multipart file field, binary/Base64)
share_holding_structure	str	Ownership structure chart file content (multipart file field, binary/Base64)
uid	str		[optional]
funds_statement	str	Proof-of-funds file content (multipart file field, binary/Base64, optional)	[optional]
additional	str	Other supplementary material file content (multipart file field, binary/Base64, optional)	[optional]

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Accepted successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mark_otc_order_paid

OtcActionResponse mark_otc_order_paid(otc_mark_order_paid_request)

Mark fiat order as paid (deposit confirmation)

Mark a fiat buy order as paid (deposit confirmation). The user's payment receipt must be uploaded: payment_receipt_file_key is required; file format jpg / jpeg / png / pdf, single file no larger than 4MB (jointly validated by the server and gateway). The compatible field name payment_receipt is subject to the gateway/production environment. For the persisted field, see otc_trade_record.payment_receipt_file_key. The Pay Inner path is POST .../pay/order_set_paid (orders are usually associated via client_order_id); this OpenAPI path maps to Inner POST /order/paid and still uses order_id as the primary key—if the gateway unifies it to the merchant order number, the gateway documentation prevails.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
otc_mark_order_paid_request = gate_api.OtcMarkOrderPaidRequest() # OtcMarkOrderPaidRequest | 

try:
    # Mark fiat order as paid (deposit confirmation)
    api_response = api_instance.mark_otc_order_paid(otc_mark_order_paid_request)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->mark_otc_order_paid: %s\n" % e)

Parameters

Name	Type	Description	Notes
otc_mark_order_paid_request	OtcMarkOrderPaidRequest

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The order has been marked as paid	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_otc_order

OtcActionResponse cancel_otc_order(order_id)

Fiat order cancellation

Cancel fiat order

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
order_id = 'order_id_example' # str | Order ID

try:
    # Fiat order cancellation
    api_response = api_instance.cancel_otc_order(order_id)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->cancel_otc_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	str	Order ID

Return type

OtcActionResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Order cancelled successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_otc_orders

OtcOrderListResponse list_otc_orders(type=type, fiat_currency=fiat_currency, crypto_currency=crypto_currency, start_time=start_time, end_time=end_time, status=status, pn=pn, ps=ps)

Fiat order list

Query the fiat order list with filters such as type, currency, time range, and status

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
type = 'type_example' # str | BUY for on-ramp, SELL for off-ramp (optional)
fiat_currency = 'fiat_currency_example' # str | Fiat currency (optional)
crypto_currency = 'crypto_currency_example' # str | Digital currency (optional)
start_time = 'start_time_example' # str | starttime   for example : 2025-09-09 (optional)
end_time = 'end_time_example' # str | endtime  for example :2025-09-09 (optional)
status = 'status_example' # str | DONE: Completed CANCEL: Canceled PROCESSING: In Progress (optional)
pn = 'pn_example' # str | Page number (optional)
ps = 'ps_example' # str | Number of items per page (optional)

try:
    # Fiat order list
    api_response = api_instance.list_otc_orders(type=type, fiat_currency=fiat_currency, crypto_currency=crypto_currency, start_time=start_time, end_time=end_time, status=status, pn=pn, ps=ps)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->list_otc_orders: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	str	BUY for on-ramp, SELL for off-ramp	[optional]
fiat_currency	str	Fiat currency	[optional]
crypto_currency	str	Digital currency	[optional]
start_time	str	starttime for example : 2025-09-09	[optional]
end_time	str	endtime for example :2025-09-09	[optional]
status	str	DONE: Completed CANCEL: Canceled PROCESSING: In Progress	[optional]
pn	str	Page number	[optional]
ps	str	Number of items per page	[optional]

Return type

OtcOrderListResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Query successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_stable_coin_orders

OtcStableCoinOrderListResponse list_stable_coin_orders(page_size=page_size, page_number=page_number, coin_name=coin_name, start_time=start_time, end_time=end_time, status=status)

Stablecoin order list

Query stablecoin order list with filtering by currency, time range, status, etc.

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
page_size = '10' # str | Number of records per page (optional)
page_number = '1' # str | Page number (optional)
coin_name = 'USDT' # str | ordercurrency (optional)
start_time = 'start_time_example' # str | Start Time (optional)
end_time = 'end_time_example' # str | End time (optional)
status = 'status_example' # str | Status: PROCESSING: in progress / DONE：completed / FAILED: failed (optional)

try:
    # Stablecoin order list
    api_response = api_instance.list_stable_coin_orders(page_size=page_size, page_number=page_number, coin_name=coin_name, start_time=start_time, end_time=end_time, status=status)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->list_stable_coin_orders: %s\n" % e)

Parameters

Name	Type	Description	Notes
page_size	str	Number of records per page	[optional]
page_number	str	Page number	[optional]
coin_name	str	ordercurrency	[optional]
start_time	str	Start Time	[optional]
end_time	str	End time	[optional]
status	str	Status: PROCESSING: in progress / DONE：completed / FAILED: failed	[optional]

Return type

OtcStableCoinOrderListResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Query successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_otc_order_detail

OtcOrderDetailResponse get_otc_order_detail(order_id)

Fiat order details

Query fiat order details

Example

Api Key Authentication (apiv4):

from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure APIv4 key authorization
configuration = gate_api.Configuration(
    host = "https://api.gateio.ws/api/v4",
    key = "YOU_API_KEY",
    secret = "YOUR_API_SECRET"
)

api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OTCApi(api_client)
order_id = 'order_id_example' # str | Order ID

try:
    # Fiat order details
    api_response = api_instance.get_otc_order_detail(order_id)
    print(api_response)
except GateApiException as ex:
    print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
    print("Exception when calling OTCApi->get_otc_order_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	str	Order ID

Return type

OtcOrderDetailResponse

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Query successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

OTCApi.md

Latest commit

History

OTCApi.md

File metadata and controls

gate_api.OTCApi

create_otc_quote

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_otc_order

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_stable_coin_order

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_bank_list_inner_path

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_otc_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_otc_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_default_otc_bank

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_otc_bank_supplement_checklist

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submit_otc_bank_personal_supplement

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submit_otc_bank_enterprise_supplement

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mark_otc_order_paid

Example