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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v2/integration/orders

GET /api/v2/integration/orders HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2026-03-21T19:56:06.039Z",
      "updatedAt": "2026-03-21T19:56:06.039Z",
      "deletedAt": "2026-03-21T19:56:06.039Z",
      "serviceCommission": "0.565",
      "netCommission": "0.565",
      "comment": "Comment",
      "publicComment": "Public comment",
      "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "merchantName": "Test merchant",
      "merchantId": 6547,
      "type": "invoice",
      "status": "created",
      "invoiceCurrencyCode": "BTC",
      "currencyInCode": "USDTERC20",
      "currencyOutCode": "USDT",
      "invoiceAmount": "10.2334",
      "amountInExpected": "43.11",
      "amountInFact": "44",
      "amountOutExpected": "43.11,",
      "amountOutFact": "44",
      "hedgeRate": "44",
      "isDone": false,
      "apiMode": "ui",
      "risk": "24",
      "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
      "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
      "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
      "requisitesMemoTag": "80576",
      "requisitesMemoTagIn": "80576",
      "requisitesMemoTagOut": "80576",
      "billingTag": "example@mail.com",
      "requisitesQrCode": "https://example.com/img-name.png",
      "assetInCode": "BTC",
      "assetOutCode": "USDT",
      "networkInCode": "ETH",
      "networkOutCode": "NEAR",
      "balanceAfter": "44",
      "callbackUrl": "https://example/myCallback",
      "invoicePublicUrl": "https://example/myInvoice",
      "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
      "expirationTime": "2026-03-21T19:56:06.039Z",
      "isImPayed": false,
      "isBayerPaysService": false,
      "serviceFeeCurrencyCode": "USDT",
      "netFeeCurrencyCode": "USDT"
    }
  ],
  "count": 1
}

Retrieve order information

get

Path parameters

orderUidstringRequired

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved order information

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/orders/{orderUid}

GET /api/v1/integration/orders/{orderUid} HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/invoice

POST /api/v1/integration/orders/invoice HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "currencyInCode": "BTC",
  "invoiceAssetCode": "USDT",
  "comment": "Order #234",
  "publicComment": "Order #234",
  "callbackUrl": "https://api.myip.com",
  "redirectUrl": "https://marketplace.com/cart",
  "isBayerPaysService": true,
  "isAwaitRequisites": true,
  "expiryDurationMinutes": 20,
  "invoiceTpl": {},
  "invoiceAmount": 5000
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/withdraw

POST /api/v1/integration/orders/withdraw HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "amount": 10,
  "toCurrencyCode": "USDTMATIC",
  "recipient": "0x0000000000000000000000000000000000000000",
  "requisitesMemoTag": "80576",
  "callbackUrl": "https://api.myip.com",
  "comment": "Server payment for 07.2023"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/fiat-withdraw

POST /api/v1/integration/orders/fiat-withdraw HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "currency": "CODE",
  "paymentMethod": "card",
  "providerOutAliasCode": "BANK",
  "code": "CURRENCY_CARD_65",
  "amount": 10,
  "comment": "Server payment for 07.2023",
  "recipient": "CARD NUMBER",
  "callbackUrl": "https://api.myip.com",
  "details": "{\"email\":\"payer@gmail.com\"}"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/{merchantUid}/estimate-fiat-out-with-exchange

POST /api/v1/integration/orders/{merchantUid}/estimate-fiat-out-with-exchange HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "settingsCode": "RUB_CARD_32",
  "amountOut": 15
}

{
  "message": "ok",
  "data": {
    "currencyInCode": "RUB",
    "currencyOutCode": "USD",
    "amountIn": "1000",
    "amountOut": "1000",
    "rate": "0.5",
    "fee": "0.5"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/exchange

POST /api/v1/integration/orders/exchange HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "assetCodeIn": "USDT",
  "amountIn": 10,
  "assetCodeOut": "USDT",
  "amountOut": 10,
  "comment": "Hedging for 07.2023",
  "exchangePriority": "in"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/account-transfer

POST /api/v1/integration/orders/account-transfer HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "amount": 10,
  "assetCode": "USDT",
  "recipientId": 7647,
  "comment": "Happy Birthday!"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authentication required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/estimate-in

POST /api/v1/integration/orders/estimate-in HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "fromCurrencyCode": "BTC",
  "toCurrencyCode": "USDTBEP20",
  "amountTo": 15
}

{
  "message": "ok",
  "data": {
    "currencyCode": "USDTERC20",
    "assetCode": "USDT",
    "amount": "2.334"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/estimate-out

POST /api/v1/integration/orders/estimate-out HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "toCurrencyCode": "USDT-INTERNAL",
  "fromCurrencyCode": "BTC-INTERNAL",
  "amountFrom": 15
}

{
  "message": "ok",
  "data": {
    "currencyCode": "USDTERC20",
    "assetCode": "USDT",
    "amount": "2.334"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/invoice/without-amount

POST /api/v1/integration/orders/invoice/without-amount HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "currencyInCode": "BTC",
  "invoiceAssetCode": "USDT",
  "comment": "Order #234",
  "publicComment": "Order #234",
  "callbackUrl": "https://api.myip.com",
  "redirectUrl": "https://marketplace.com/cart",
  "isBayerPaysService": true,
  "isAwaitRequisites": true,
  "expiryDurationMinutes": 20,
  "invoiceTpl": {}
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/currency-to-currency

POST /api/v1/integration/orders/currency-to-currency HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "amount": 10,
  "toCurrencyCode": "USDTMATIC",
  "recipient": "0x0000000000000000000000000000000000000000",
  "requisitesMemoTag": "80576",
  "callbackUrl": "https://api.myip.com",
  "comment": "Server payment for 07.2023",
  "details": "{\"method\":\"card\"}",
  "fromCurrencyCode": "BTC"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/orders/withdraw-with-exchange

POST /api/v1/integration/orders/withdraw-with-exchange HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "amount": 10,
  "toCurrencyCode": "USDTMATIC",
  "recipient": "0x0000000000000000000000000000000000000000",
  "requisitesMemoTag": "80576",
  "callbackUrl": "https://api.myip.com",
  "comment": "Server payment for 07.2023",
  "fromAssetCode": "BTC"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Comment",
    "publicComment": "Public comment",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Test merchant",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesIn": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesOut": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "requisitesMemoTagIn": "80576",
    "requisitesMemoTagOut": "80576",
    "billingTag": "example@mail.com",
    "requisitesQrCode": "https://example.com/img-name.png",
    "assetInCode": "BTC",
    "assetOutCode": "USDT",
    "networkInCode": "ETH",
    "networkOutCode": "NEAR",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2026-03-21T19:56:06.039Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

datastring[]Optional

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/orders/filters/assets

GET /api/v1/integration/orders/filters/assets HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    "text"
  ],
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

datastring[]Optional

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/orders/filters/networks

GET /api/v1/integration/orders/filters/networks HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    "text"
  ],
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/assets/exchange-rate

GET /api/v1/integration/assets/exchange-rate HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "pairCode": "BTC/BNB",
      "fromAssetCode": "BTC",
      "toAssetCode": "BNB",
      "fromCurrencyType": "COIN",
      "toCurrencyType": "COIN",
      "minIn": 1,
      "minOut": 0.000001,
      "rate": 123.70237506185059,
      "isTurnRate": false
    }
  ],
  "count": 1
}

Get merchant's enabled assets

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant's enabled assets

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/assets/enabled

GET /api/v1/integration/assets/enabled HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "code": "BNB",
      "type": "COIN",
      "usdPrice": "2000",
      "eurPrice": "2000",
      "rubPrice": "2000",
      "exponent": 5,
      "name": "Bitcoin",
      "minDeposit": 1,
      "maxDeposit": 1000,
      "minWithdraw": 1,
      "maxWithdraw": 1000,
      "currencies": [
        {
          "assetCode": "BNB",
          "fiatCode": "USD",
          "isInternal": false,
          "publicName": "BinanceCoin(BNB) Internal",
          "publicCode": "BNB-INTERNAL",
          "example": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
          "isUseMemoTag": false,
          "storageProviderCode": "BSC",
          "publicStorageProviderName": "Binance SC",
          "depositFee": 0,
          "withdrawFee": 1,
          "exponent": 5,
          "re": "xxx",
          "currencyType": "COIN",
          "minDeposit": 1,
          "maxDeposit": 1000,
          "minWithdraw": 1,
          "maxWithdraw": 1000,
          "expiryDurationMinutes": 30
        }
      ]
    }
  ],
  "count": 1
}

Get merchant's asset settings

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant's asset settings

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/assets/settings

GET /api/v1/integration/assets/settings HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "code": "BTC",
      "invoiceHedge": true,
      "invoiceHedgeToAsset": "USDT",
      "autoWithdraw": true,
      "autoWithdrawToAddress": "1N4Qbzg6LSXUXyXu2MDuGfzxwMA7do8AyL",
      "autoWithdrawCurrencyCode": "USDT",
      "createdByUid": "xx"
    }
  ],
  "count": 1
}

Get merchant's currencies

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant's currencies

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/assets/currencies

GET /api/v1/integration/assets/currencies HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "assetCode": "BNB",
      "fiatCode": "USD",
      "isInternal": false,
      "publicName": "BinanceCoin(BNB) Internal",
      "publicCode": "BNB-INTERNAL",
      "example": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
      "isUseMemoTag": false,
      "storageProviderCode": "BSC",
      "publicStorageProviderName": "Binance SC",
      "depositFee": 0,
      "withdrawFee": 1,
      "exponent": 5,
      "re": "xxx",
      "currencyType": "COIN",
      "minDeposit": 1,
      "maxDeposit": 1000,
      "minWithdraw": 1,
      "maxWithdraw": 1000,
      "expiryDurationMinutes": 30
    }
  ],
  "count": 1
}

Get list of available assets

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved list of available assets

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/assets

GET /api/v1/integration/assets HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "code": "BNB",
      "type": "COIN",
      "usdPrice": "2000",
      "eurPrice": "2000",
      "rubPrice": "2000",
      "exponent": 5,
      "name": "Bitcoin",
      "minDeposit": 1,
      "maxDeposit": 1000,
      "minWithdraw": 1,
      "maxWithdraw": 1000,
      "currencies": [
        {
          "assetCode": "BNB",
          "fiatCode": "USD",
          "isInternal": false,
          "publicName": "BinanceCoin(BNB) Internal",
          "publicCode": "BNB-INTERNAL",
          "example": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
          "isUseMemoTag": false,
          "storageProviderCode": "BSC",
          "publicStorageProviderName": "Binance SC",
          "depositFee": 0,
          "withdrawFee": 1,
          "exponent": 5,
          "re": "xxx",
          "currencyType": "COIN",
          "minDeposit": 1,
          "maxDeposit": 1000,
          "minWithdraw": 1,
          "maxWithdraw": 1000,
          "expiryDurationMinutes": 30
        }
      ]
    }
  ],
  "count": 1
}

Get asset withdrawal fees

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved withdrawal fees

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/assets/withdraw-fee

GET /api/v1/integration/assets/withdraw-fee HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "toAssetCode": "BNB",
      "toCurrencyCode": "BNBINTERNAL",
      "toCurrencyName": "BinanceCoin(BNB) Internal",
      "fixFee": 0,
      "rate": 123.70237506185059,
      "isTurnRate": false,
      "minOut": 0.000001,
      "maxOut": 1
    }
  ],
  "count": 1
}

Get merchant information

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant information

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant

GET /api/v1/integration/merchant HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "name": "MyMerchant.",
    "enabledAssets": [
      "BTC",
      "USDT",
      "BNB"
    ],
    "status": "active",
    "balanceUsd": "43.11",
    "equal": "187",
    "pricing": {
      "name": "testPricing",
      "percentIn": 1,
      "percentOut": 1,
      "percentExchange": 1
    },
    "merchantInfo": {
      "projectName": "My project name",
      "projectLink": "https://project-site.com",
      "projectDescription": "Sneaker sales platform",
      "country": "france",
      "turnover": "$1000000-$10000000",
      "activity": "Marketplace",
      "email": "serviceName@mail.com",
      "phone": "+7(999)123-23-34",
      "otherCommunications": "telegram: @serviceName_for_you",
      "comment": "This is a comment",
      "updatedByUid": "xx"
    },
    "merchantSettings": {
      "callbackUrl": "https://api.myip.com",
      "isBayerPaysService": true,
      "secretKey": "some-secret-value",
      "updatedByUid": "xx"
    },
    "createdByUid": "xx",
    "updatedByUid": "xx"
  },
  "count": 1
}

Get merchant pricing

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant pricing

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/pricing

GET /api/v1/integration/merchant/pricing HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": {
    "name": "testPricing",
    "percentIn": 1,
    "percentOut": 1,
    "percentExchange": 1
  },
  "count": 1
}

Get merchant currencies

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant balances

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/balances

GET /api/v1/integration/merchant/balances HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "code": "BNB",
      "rate": "99.99",
      "equal": "100",
      "balance": "100",
      "pendingWds": "100",
      "pendingIn": "100"
    }
  ],
  "count": 1
}

Get merchant crypto addresses

get

Header parameters

x-api-keystringRequired

Responses

200

Successfully retrieved merchant crypto addresses

application/json

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/deposit-wallets

GET /api/v1/integration/merchant/deposit-wallets HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": {
    "assetCode": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB"
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/billings

GET /api/v1/integration/merchant/billings HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2026-03-21T19:56:06.039Z",
      "updatedAt": "2026-03-21T19:56:06.039Z",
      "deletedAt": "2026-03-21T19:56:06.039Z",
      "tag": "test@example.com",
      "publicName": "Account BlackGod8675",
      "totalDeposits": [
        {
          "currencyInCode": "USDTERC20",
          "amount": "2.334"
        }
      ],
      "wallets": [
        {
          "currencyCode": "USDTERC20",
          "address": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
          "assetCode": "USDT"
        }
      ]
    }
  ],
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

post

/api/v1/integration/merchant/billings/{billingTag}

POST /api/v1/integration/merchant/billings/{billingTag} HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "publicName": "Account BlackKnight165"
}

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2026-03-21T19:56:06.039Z",
    "updatedAt": "2026-03-21T19:56:06.039Z",
    "deletedAt": "2026-03-21T19:56:06.039Z",
    "tag": "test@example.com",
    "publicName": "Account BlackGod8675",
    "totalDeposits": [
      {
        "currencyInCode": "USDTERC20",
        "amount": "2.334"
      }
    ],
    "wallets": [
      {
        "currencyCode": "USDTERC20",
        "address": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
        "assetCode": "USDT"
      }
    ]
  },
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/fiat-config

GET /api/v1/integration/merchant/fiat-config HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "name": "All cards",
      "code": "RUB_CARD_32",
      "paymentMethod": "card",
      "currency": "RUB",
      "currencyOutCode": "USD",
      "paymentType": "deposit",
      "providersOut": [
        {
          "name": "Sberbank",
          "code": "111000011",
          "aliasCode": "sber"
        }
      ],
      "amountMin": "10.00",
      "amountMax": "1000.00",
      "feePercent": "1.5"
    }
  ],
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/fiat-withdraw-config/{currency}

GET /api/v1/integration/merchant/fiat-withdraw-config/{currency} HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "name": "All cards",
      "code": "RUB_CARD_32",
      "paymentMethod": "card",
      "currency": "RUB",
      "currencyOutCode": "USD",
      "paymentType": "deposit",
      "providersOut": [
        {
          "name": "Sberbank",
          "code": "111000011",
          "aliasCode": "sber"
        }
      ],
      "amountMin": "10.00",
      "amountMax": "1000.00",
      "feePercent": "1.5"
    }
  ],
  "count": 1
}

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

messagestringRequired

Status message

Example: ok

countnumberOptional

Total number of items in the database

Example: 1

400

Invalid request

application/json

401

Authorization required

application/json

403

Insufficient permissions

application/json

500

System error

application/json

get

/api/v1/integration/merchant/fiat-deposit-config/{currency}

GET /api/v1/integration/merchant/fiat-deposit-config/{currency} HTTP/1.1
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "name": "All cards",
      "code": "RUB_CARD_32",
      "paymentMethod": "card",
      "currency": "RUB",
      "currencyOutCode": "USD",
      "paymentType": "deposit",
      "providersOut": [
        {
          "name": "Sberbank",
          "code": "111000011",
          "aliasCode": "sber"
        }
      ],
      "amountMin": "10.00",
      "amountMax": "1000.00",
      "feePercent": "1.5"
    }
  ],
  "count": 1
}

PreviousIntroduction

Last updated 10 months ago

hashtagRetrieve merchant order list with typed search

hashtagRetrieve order information

hashtagCreate invoice

hashtagCreate withdrawal

hashtagCreate fiat withdrawal

hashtagEstimate fiat withdrawal with exchange

hashtagCreate exchange

hashtagCreate account transfer

hashtagEstimate input

hashtagEstimate output amount

hashtagCreate invoice without amount

hashtagCreate Currency -> Currency order (bridge)

hashtagCreate Withdraw with Exchange order

hashtagGet asset filter values

hashtagGet network filter values

hashtagGet merchant's available exchange pairs

hashtagGet merchant's enabled assets

hashtagGet merchant's asset settings

hashtagGet merchant's currencies

hashtagGet list of available assets

hashtagGet asset withdrawal fees

hashtagGet merchant information

hashtagGet merchant pricing

hashtagGet merchant currencies

hashtagGet merchant crypto addresses

hashtagGet merchant billings list

hashtagGet/create billing

hashtagGet list of fiat deposit and withdrawal methods for all currencies

hashtagGet list of fiat withdrawal methods

hashtagGet list of fiat deposit methods

Retrieve merchant order list with typed search

Retrieve order information

Create invoice

Create withdrawal

Create fiat withdrawal

Estimate fiat withdrawal with exchange

Create exchange

Create account transfer

Estimate input

Estimate output amount

Create invoice without amount

Create Currency -> Currency order (bridge)

Create Withdraw with Exchange order

Get asset filter values

Get network filter values

Get merchant's available exchange pairs

Get merchant's enabled assets

Get merchant's asset settings

Get merchant's currencies

Get list of available assets

Get asset withdrawal fees

Get merchant information

Get merchant pricing

Get merchant currencies

Get merchant crypto addresses

Get merchant billings list

Get/create billing

Get list of fiat deposit and withdrawal methods for all currencies

Get list of fiat withdrawal methods

Get list of fiat deposit methods