API Reference

Retrieve merchant order list with typed search

get
Query parameters
pagenumberOptional

Page

Example: 1
limitnumberOptional

Number of items per page

Example: 10
orderBystringOptional

Sort by field

Example: -uid
merchantsUidsstring[]Optional

Merchant UIDs

Example: ["3422b448-2460-4fd2-9183-8000de6f8343"]
billingTagsstring[]Optional

Billing tag

Example: ["test@example.com"]
assetsstring[]Optional

Assets

Example: ["USDT"]
networksstring[]Optional

Networks

Example: ["ETH"]
createdAtSincestring · date-timeOptional

Creation date (start of period) the string must comply with the ISO8601 format and be in URL-encoded escaped format. Allowed 2025-01-14T21:00:00.000%2b03:00 the "+" sign -> "%2B" or 2025-01-14T21:00:00.000Z. Correct 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
createdAtBeforestring · date-timeOptional

Creation date (end of period) the string must comply with the ISO8601 format and be in URL-encoded escaped format. Allowed 2025-01-14T21:00:00.000%2b03:00 the "+" sign -> "%2B" or 2025-01-14T21:00:00.000Z. Correct 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
searchTypestring · enumOptional

Type of details to search for

Possible values:
searchTextstringOptional

Text to search in the specified type of details

Example: some_text
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant order list

application/json
Responseall of
and
get
/api/v2/integration/orders

Retrieve order information

get
Path parameters
orderUidstringRequired
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved order information

application/json
Responseall of
and
get
/api/v1/integration/orders/{orderUid}

Create invoice

post

Create invoice with specified payment amount. The invoice is generated in the invoiceAssetCode currency. Payment is made in the currency specified by currencyInCode. If left empty, the customer will be offered a list of available payment currencies.

Header parameters
x-api-keystringRequired
Body
currencyInCodestringOptional

Currency selected by the buyer for payment

Example: BTC
invoiceAssetCodestringRequired

Asset in which the invoice is issued to the buyer

Example: USDT
commentstring · min: 5Optional

Order comment. Optional field

Example: Order #234
publicCommentstring · min: 5Optional

Public order comment. Optional field

Example: Order #234
callbackUrlstring · min: 5Optional

Callback URL for sending hooks

Example: https://api.myip.com
redirectUrlstring · min: 5Optional

URL to redirect the buyer after payment

Example: https://marketplace.com/cart
isBayerPaysServicebooleanOptional

Include the service fee in the buyer's invoice (if not specified, taken from merchant settings)

Example: true
isAwaitRequisitesbooleanOptional

Wait for payment requisites in the response (default false)

Example: true
expiryDurationMinutesnumberOptional

Invoice lifetime in minutes (default 20)

Example: 20
invoiceTplobject | nullableOptional

Payment form layout template

invoiceAmountstringRequired

Payment amount in $invoiceAssetCode

Example: 5000
Responses
200

Invoice created successfully

application/json
Responseall of
and
post
/api/v1/integration/orders/invoice

This endpoint allows merchants to create a new invoice (invoiceAssetCode) with a specified amount (invoiceAmount). The customer may pay using a different asset (currencyInCode). If currencyInCode is not provided, the customer will be presented with a list of available currencies for payment.

There are two modes for receiving payment details:

  • Receive payment details in the API response.

  • Receive payment details via webhook.

To switch between these modes, use the parameter isAwaitRequisites (true = wait for webhook, false = return in response).

Create withdrawal

post

Withdrawal to an external address.

Header parameters
x-api-keystringRequired
Body
amountstringRequired

Output amount

Example: 10
toCurrencyCodestringRequired

Receiving currency (with network)

Example: USDTMATIC
recipientstringRequired

Recipient (address)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Memo tag (for XRP, TON, etc.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback URL for sending hooks

Example: https://api.myip.com
commentstringOptional

Transfer comment. Optional field

Example: Server payment for 07.2023
Responses
200

Withdrawal created successfully

application/json
Responseall of
and
post
/api/v1/integration/orders/withdraw

Create fiat withdrawal

post

The endpoint allows creating a request for fiat withdrawal for a merchant. Main withdrawal parameters: currency - currency amount - amount paymentMethod - withdrawal method, providerOutAliasCode - withdrawal bank code code - withdrawal method code To get data on available methods, banks, limits, withdrawal codes, etc., refer to the API method fiat-withdraw-config.

Header parameters
x-api-keystringRequired
Body
currencystring · enumRequired

Currency

Example: CODEPossible values:
paymentMethodstring · enumRequired

Payment method

Example: cardPossible values:
providerOutAliasCodestringRequired

Withdrawal bank code

Example: BANK
codestringRequired

Withdrawal method

Example: CURRENCY_CARD_65
amountstringRequired

Output amount

Example: 10
commentstringOptional

Transfer comment. Optional field

Example: Server payment for 07.2023
recipientstringRequired

Recipient details

Example: CARD NUMBER
callbackUrlstring · min: 5Optional

Callback URL for sending hooks

Example: https://api.myip.com
detailsobjectOptional

Additional fields for withdrawal

Example: {"email":"payer@gmail.com"}
Responses
200

Fiat withdrawal created successfully

application/json
Responseall of
and
post
/api/v1/integration/orders/fiat-withdraw

Note: As of May 2025, the available fiat currencies for withdrawal are: RUB, KZT, KGS, AZN, BYN, and UZS. USD and EUR are currently disabled.

Estimate fiat withdrawal with exchange

post
Path parameters
merchantUidstringRequired
Header parameters
x-api-keystringRequired
Body
settingsCodestringOptional

Withdrawal method code

Example: RUB_CARD_32
amountOutstringRequired

Output amount

Example: 15
Responses
200

Successfully estimated withdrawal

application/json
Responseall of
and
post
/api/v1/integration/orders/{merchantUid}/estimate-fiat-out-with-exchange

Create exchange

post

Conversion of amountIn in assetCodeIn currency to assetCodeOut currency.

Header parameters
x-api-keystringRequired
Body
assetCodeInstringRequired

Input asset for exchange

Example: USDT
amountInnumberRequired

Exchange amount

Example: 10
assetCodeOutstringRequired

Output asset

Example: USDT
amountOutnumberRequired

Expected amount

Example: 10
commentstringOptional

Exchange comment. Optional field

Example: Hedging for 07.2023
exchangePrioritystringOptional

Exchange priority (default "in")

Example: in
Responses
200

Exchange created successfully

application/json
Responseall of
and
post
/api/v1/integration/orders/exchange

Create account transfer

post

Transfer funds to another account within the system.

Header parameters
x-api-keystringRequired
Body
amountnumberRequired

Transfer amount

Example: 10
assetCodestringRequired

Sending asset

Example: USDT
recipientIdnumberRequired

Recipient (merchant ID)

Example: 7647
commentstringOptional

Transfer comment. Optional field

Example: Happy Birthday!
Responses
200

Transfer created successfully

application/json
Responseall of
and
post
/api/v1/integration/orders/account-transfer

Estimate input

post

The method is intended to estimate the amount that needs to be paid in fromCurrencyCode to receive the amountTo in toCurrencyCode (taking into account the exchange rate and commission).

Header parameters
x-api-keystringRequired
Body
fromCurrencyCodestringOptional

Input currency

Example: BTC
toCurrencyCodestringRequired

Output currency

Example: USDTBEP20
amountTonumberRequired

Output amount

Example: 15
Responses
200

Successfully estimated input

application/json
Responseall of
and
post
/api/v1/integration/orders/estimate-in

Estimate output amount

post

This method is designed to estimate the amount that will be received in the toCurrencyCode when paying the amountFrom in the fromCurrencyCode (including exchange rate and fees).

Header parameters
x-api-keystringRequired
Body
toCurrencyCodestringRequired

Output currency

Example: USDT-INTERNAL
fromCurrencyCodestringRequired

Sending currency

Example: BTC-INTERNAL
amountFromnumberRequired

Sending amount

Example: 15
Responses
200

Successful output estimation

application/json
Responseall of
and
post
/api/v1/integration/orders/estimate-out

Create invoice without amount

post

Create an invoice without specifying the payment amount. The invoice is generated in the currency defined by invoiceAssetCode. Payment is made in the currency specified in the currencyInCode parameter. If left empty, the customer will be offered a list of available payment currencies.

Header parameters
x-api-keystringRequired
Body
currencyInCodestringOptional

Currency selected by the buyer for payment

Example: BTC
invoiceAssetCodestringRequired

Asset in which the invoice is issued to the buyer

Example: USDT
commentstring · min: 5Optional

Order comment. Optional field

Example: Order #234
publicCommentstring · min: 5Optional

Public order comment. Optional field

Example: Order #234
callbackUrlstring · min: 5Optional

Callback URL for sending hooks

Example: https://api.myip.com
redirectUrlstring · min: 5Optional

URL to redirect the buyer after payment

Example: https://marketplace.com/cart
isBayerPaysServicebooleanOptional

Include the service fee in the buyer's invoice (if not specified, taken from merchant settings)

Example: true
isAwaitRequisitesbooleanOptional

Wait for payment requisites in the response (default false)

Example: true
expiryDurationMinutesnumberOptional

Invoice lifetime in minutes (default 20)

Example: 20
invoiceTplobject | nullableOptional

Payment form layout template

Responses
200

Successfully created invoice without amount

application/json
Responseall of
and
post
/api/v1/integration/orders/invoice/without-amount

Create Currency -> Currency order (bridge)

post

Request for currency conversion and transfer between different networks. The process includes three stages: Receive -> Exchange -> Withdraw. For example, when transferring USDTERC20 to BNBBEP20: 1. An address is provided to deposit USDTERC20 (fromCurrencyCode) on the Ethereum network 2. The received funds are converted to BNB 3. BNB is withdrawn as BNBBEP20 (toCurrencyCode) to the specified address (recipient) on the Binance Smart Chain

  Important: The transfer amount (amount) is specified in toCurrencyCode.
 
  Tip: To estimate the fromCurrencyCode amount, you can use the "orders/estimate-in" method.
Header parameters
x-api-keystringRequired
Body
amountstringRequired

Output amount

Example: 10
toCurrencyCodestringRequired

Receiving currency (with network)

Example: USDTMATIC
recipientstringRequired

Recipient (address)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Memo tag (for XRP, TON, etc.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback URL for sending hooks

Example: https://api.myip.com
commentstringOptional

Transfer comment. Optional field

Example: Server payment for 07.2023
detailsobjectOptional

Details for fiat withdrawals

Example: {"method":"card"}
fromCurrencyCodestringRequired

Input currency

Example: BTC
Responses
200

Successfully created CTC order

application/json
Responseall of
and
post
/api/v1/integration/orders/currency-to-currency

Create Withdraw with Exchange order

post

Request for withdrawal with conversion. The process includes two stages: Exchange -> Withdraw. For example, when withdrawing USDT to BTC: 1. USDT (fromAssetCode) from the merchant's balance is converted to BTC 2. BTC (toCurrencyCode) is withdrawn to the specified address (recipient) on the Bitcoin network.

  Important: The withdrawal amount (amount) is specified in toCurrencyCode.
 
  Tip: To estimate the currencyInCode amount, you can use the "orders/estimate-in" method.
Header parameters
x-api-keystringRequired
Body
amountstringRequired

Output amount

Example: 10
toCurrencyCodestringRequired

Receiving currency (with network)

Example: USDTMATIC
recipientstringRequired

Recipient (address)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Memo tag (for XRP, TON, etc.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback URL for sending hooks

Example: https://api.myip.com
commentstringOptional

Transfer comment. Optional field

Example: Server payment for 07.2023
fromAssetCodestringRequired

Asset from which conversion is made

Example: BTC
Responses
200

Successfully created withdraw with exchange order

application/json
Responseall of
and
post
/api/v1/integration/orders/withdraw-with-exchange

Get asset filter values

get
Header parameters
x-api-keystringRequired
Responses
200

Returns an array of strings that can be used as a filter for the "assets" query parameter in the endpoint for getting a list of orders

application/json
Responseall of
and
get
/api/v1/integration/orders/filters/assets

Get network filter values

get
Header parameters
x-api-keystringRequired
Responses
200

Returns an array of strings that can be used as a filter for the "networks" query parameter in the endpoint for getting a list of orders

application/json
Responseall of
and
get
/api/v1/integration/orders/filters/networks

Get merchant's available exchange pairs

get
Query parameters
fromstringOptional

Code of the token to receive

Example: QWRUB
tostringOptional

Code of the token to send

Example: ETH
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant's exchange pairs

application/json
Responseall of
and
get
/api/v1/integration/assets/exchange-rate

Get merchant's enabled assets

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant's enabled assets

application/json
Responseall of
and
get
/api/v1/integration/assets/enabled

Get merchant's asset settings

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant's asset settings

application/json
Responseall of
and
get
/api/v1/integration/assets/settings

Get merchant's currencies

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant's currencies

application/json
Responseall of
and
get
/api/v1/integration/assets/currencies

Get list of available assets

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved list of available assets

application/json
Responseall of
and
get
/api/v1/integration/assets

Get asset withdrawal fees

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved withdrawal fees

application/json
Responseall of
and
get
/api/v1/integration/assets/withdraw-fee

Get merchant information

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant information

application/json
Responseall of
and
get
/api/v1/integration/merchant

Get merchant pricing

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant pricing

application/json
Responseall of
and
get
/api/v1/integration/merchant/pricing

Get merchant currencies

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant balances

application/json
Responseall of
and
get
/api/v1/integration/merchant/balances

Get merchant crypto addresses

get
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant crypto addresses

application/json
Responseall of
and
get
/api/v1/integration/merchant/deposit-wallets

Get merchant billings list

get
Query parameters
pagenumberOptional

Page number

Example: 1
limitnumberOptional

Items per page

Example: 10
orderBystringOptional

Sort by field

Example: -uid
searchstringOptional

Search query

Example: test@mail.com
Header parameters
x-api-keystringRequired
Responses
200

Successfully retrieved merchant billings list

application/json
Responseall of
and
get
/api/v1/integration/merchant/billings

Get/create billing

post
Path parameters
billingTagstringRequired
Header parameters
x-api-keystringRequired
Body
publicNamestringOptional

Account public name (shown to the buyer)

Example: Account BlackKnight165
Responses
200

Successfully retrieved merchant billings list

application/json
Responseall of
and
post
/api/v1/integration/merchant/billings/{billingTag}

Get list of fiat deposit and withdrawal methods for all currencies

get
Header parameters
x-api-keystringRequired
Responses
200

Endpoint allows to get available methods for fiat deposits and withdrawals for merchant.

application/json
Responseall of
and
get
/api/v1/integration/merchant/fiat-config

Get list of fiat withdrawal methods

get
Path parameters
currencystringRequired
Header parameters
x-api-keystringRequired
Responses
200

Endpoint allows to get available methods for fiat withdrawals for merchant. This data is required for forming API request for fiat-withdraw method

application/json
Responseall of
and
get
/api/v1/integration/merchant/fiat-withdraw-config/{currency}

Get list of fiat deposit methods

get
Path parameters
currencystringRequired
Header parameters
x-api-keystringRequired
Responses
200

Endpoint allows to get available methods for fiat deposits for merchant. This data is required for forming API request for fiat-deposit method

application/json
Responseall of
and
get
/api/v1/integration/merchant/fiat-deposit-config/{currency}
PreviousIntroduction

Last updated