API Reference

https://pay.alfabit.org/

Получение списка ордеров мерчанта

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
merchantsUidsstring[]Optional

Uid мерчантов

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

Биллинг тэг

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

Активы

Example: ["USDT"]
networksstring[]Optional

Сети

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

Дата создания (начало периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

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

Дата создания (конец периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
showProtectedMerchantsOrdersbooleanOptional

Показать ордера защищаемых (внутренних) мерчантов

Example: false
searchstringOptional

Поиск заявки по комментарию, id транзакции, UID заявки, имени мерчанта

Example: test@mail.com
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение списка ордеров мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/orders HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2025-06-30T16:25:29.195Z",
      "updatedAt": "2025-06-30T16:25:29.195Z",
      "deletedAt": "2025-06-30T16:25:29.195Z",
      "serviceCommission": "0.565",
      "netCommission": "0.565",
      "comment": "Комментарий",
      "publicComment": "Публичный комментарий",
      "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "merchantName": "Тестовый мерчант",
      "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": "2025-06-30T16:25:29.195Z",
      "isImPayed": false,
      "isBayerPaysService": false,
      "serviceFeeCurrencyCode": "USDT",
      "netFeeCurrencyCode": "USDT",
      "requisitesInUrl": "https://example.com/requisites",
      "orderCurrencyType": "crypto",
      "paymentMethod": "sbp",
      "providerCode": "123123123123",
      "providerAliasCode": "text",
      "providerName": "text",
      "paymentTiming": "onTime",
      "amountValidity": "valid"
    }
  ],
  "count": 1
}

Получение списка ордеров мерчанта с типизированным поиском

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
merchantsUidsstring[]Optional

Uid мерчантов

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

Биллинг тэг

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

Активы

Example: ["USDT"]
networksstring[]Optional

Сети

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

Дата создания (начало периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

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

Дата создания (конец периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
showProtectedMerchantsOrdersbooleanOptional

Показать ордера защищаемых (внутренних) мерчантов

Example: false
searchTypestring · enumOptional

Тип реквизитов для поиска

Possible values:
searchTextstringOptional

Текст для поиска в реквизитах указанного типа

Example: some_text
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение списка ордеров мерчанта
application/json
Responseall of
and
get
GET /api/v2/integration/orders HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2025-06-30T16:25:29.195Z",
      "updatedAt": "2025-06-30T16:25:29.195Z",
      "deletedAt": "2025-06-30T16:25:29.195Z",
      "serviceCommission": "0.565",
      "netCommission": "0.565",
      "comment": "Комментарий",
      "publicComment": "Публичный комментарий",
      "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "merchantName": "Тестовый мерчант",
      "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": "2025-06-30T16:25:29.195Z",
      "isImPayed": false,
      "isBayerPaysService": false,
      "serviceFeeCurrencyCode": "USDT",
      "netFeeCurrencyCode": "USDT",
      "requisitesInUrl": "https://example.com/requisites",
      "orderCurrencyType": "crypto",
      "paymentMethod": "sbp",
      "providerCode": "123123123123",
      "providerAliasCode": "text",
      "providerName": "text"
    }
  ],
  "count": 1
}
Примечание

Для получения данных по всем ордерам рекомендуется использовать версию /api/v2/integration/orders Параметры statuses, types, merchantsUids, billingTags и assets метода /client/v1/api/orders фактически являются массивами строк. Пример использования:

curl -X 'GET' 'https://gateway.tst.alfacore.net/client/v1/api/orders?statuses=failed&types=invoice&types=invoice-without-amount&assets=BTC&assets=BNB'

Примеры и схему ответов можно посмотреть в соответствующем подразделе метода. Описания статусов заявок:

  • created - Заявка успешно создана.

  • success - Заявка успешно выполнена.

  • failed - Выполнение заявки завершилось неудачей.

  • inProgress - Заявка находится в процессе выполнения.

  • invoiceWaitCreate - Ожидание создания счета.

  • invoiceNotCreated - Счет не был создан.

  • invoiceWaitRequisites - Ожидание предоставления реквизитов для создания счета.

  • invoiceWaitPay - Ожидание оплаты по счету.

  • invoiceWaitCheck - Ожидание проверки оплаты.

  • invoiceWaitConfirms - Транзакция в сети, ожидаем подтверждения.

  • invoiceNotPayed - Оплата по счету не произведена.

  • invoiceCheckBlocked - Проверка оплаты заблокирована.

  • transferBlocked - Перевод заблокирован.

  • exchangeBlocked - Обмен заблокирован.

  • withdrawBlocked - Вывод средств заблокирован.

Жизненный цикл статусов заявок:

  • Не было выбрано чем платить

created -> invoiceWaitCreate -> invoiceNotCreated

  • Выбрано чем платить, но не оплачено

created -> invoiceWaitCreate -> invoiceWaitRequisites -> invoiceWaitPay -> invoiceNotPayed

  • Был оплачен, но блок AML

created -> invoiceWaitCreate-> invoiceWaitRequisites -> invoiceWaitPay -> invoiceWaitCheck -> invoiceCheckBlocked

  • Был оплачен, транзакция появилась в сети и ждёт подтверждений (для активов, которые не проверяются на AML)

created -> invoiceWaitCreate-> invoiceWaitRequisites -> invoiceWaitPay -> invoiceWaitConfirms

  • Успешно завершен (inProgress = принято и позитивный AML, началось хеджирование и т.д., можно отгружать товар)

created -> invoiceWaitCreate -> invoiceWaitRequisites-> invoiceWaitPay -> invoiceWaitCheck -> inProgress -> success

Получение информации по ордеру

get
Path parameters
orderUidstringRequired
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение информации по ордеру
application/json
Responseall of
and
get
GET /api/v1/integration/orders/{orderUid} HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание инвойса

post

Создание инвойса с указанием суммы оплаты. Инвойс формируется в валюте invoiceAssetCode. Платеж производится в валюте, указанной в параметре currencyInCode. Если не заполнено - покупателю будет предложен список доступных для оплаты валют.

Header parameters
x-api-keystringRequired
Body
currencyInCodestringOptional

Валюта, выбранная для оплаты покупателем

Example: BTC
invoiceAssetCodestringRequired

Ассет, в котором выстален счет покупателю

Example: USDT
commentstring · min: 5Optional

Комментарий к ордеру. Опциональное поле

Example: Заказ №234
publicCommentstring · min: 5Optional

Публичный комментарий к ордеру. Опциональное поле

Example: Заказ №234
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Url для перенаправления покупателя после оплаты

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

Включить комиссию сервиса в счет покупателю (если не указано, то берется из настроек мерчанта)

Example: true
isAwaitRequisitesbooleanOptional

Ожидать реквизиты для оплаты в респонсе (по дефолту false)

Example: true
expiryDurationMinutesnumberOptional

Время жизни инвойса, в минутах (по дефолту 20)

Example: 20
invoiceTplall of | nullableOptional

Шаблон макета формы оплаты

invoiceAmountstringRequired

Сумма для оплаты в $invoiceAssetCode

Example: 5000
Responses
200
Успешное создание инвойса
application/json
Responseall of
and
post
POST /api/v1/integration/orders/invoice HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "currencyInCode": "BTC",
  "invoiceAssetCode": "USDT",
  "comment": "Заказ №234",
  "publicComment": "Заказ №234",
  "callbackUrl": "https://api.myip.com",
  "redirectUrl": "https://marketplace.com/cart",
  "isBayerPaysService": true,
  "isAwaitRequisites": true,
  "expiryDurationMinutes": 20,
  "invoiceTpl": {
    "locales": [
      "en",
      "ru"
    ]
  },
  "invoiceAmount": 5000
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}
Примечание

  1. Инвойс (счет на оплату) должен быть сформирован в валюте, указанной в параметре invoiceAssetCode. Однако платеж может быть произведен в другой валюте, указанной в параметре currencyInCode. Если параметр currencyInCode не заполнен, покупателю будет предложен список доступных для оплаты валют.

  2. При обращении к методу существует 2 формата получения реквизитов -Получение реквизитов в ответе -Получение реквизитов в вебхуке Для переключения между режимами необходимо использовать параметр isAwaitRequisites (boolean)

// Some code

{
  "currencyInCode": "BTC",
  "comment": "Заказ №234",
  "publicComment": "Заказ №234",
  "callbackUrl": "https://api.myip.com",
  "redirectUrl": "https://marketplace.com/cart",
  "isBayerPaysService": true,
  "isAwaitRequisites": true,
  "invoiceAssetCode": "USD",
  "invoiceAmount": 5000
}

Создание вывода

post

Вывод средств на внешний адрес.

Header parameters
x-api-keystringRequired
Body
amountstringRequired

Сумма выхода

Example: 10
toCurrencyCodestringRequired

Валюта получения (с сетью)

Example: USDTMATIC
recipientstringRequired

Реципиент (адрес)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Мемо тег (для XRP, TON и т.д.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
Responses
200
Успешное создание вывода
application/json
Responseall of
and
post
POST /api/v1/integration/orders/withdraw HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "amount": 10,
  "toCurrencyCode": "USDTMATIC",
  "recipient": "0x0000000000000000000000000000000000000000",
  "requisitesMemoTag": "80576",
  "callbackUrl": "https://api.myip.com",
  "comment": "Оплата сервера за 07.2023"
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание фиатного вывода

post

Эндпоинт позволяет создать заявку на вывод фиатных средств для мерчанта. Основные параметры вывода: currency - валюта amount - сумма paymentMethod - метод вывода, providerOutAliasCode - код банка вывода code - код способа вывода Для получения данных по доступным способам, банкам, лимитам, кодам вывода и тд. обратитесь к API методу fiat-withdraw-config.

Header parameters
x-api-keystringRequired
Body
currencystring · enumRequired

Валюта

Example: CODEPossible values:
paymentMethodstring · enumRequired

Платежный метод

Example: cardPossible values:
providerOutAliasCodestringRequired

Код банка вывода

Example: BANK
codestringRequired

Способ вывода

Example: CURRENCY_CARD_65
amountstringRequired

Сумма выхода

Example: 10
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
recipientstringRequired

Реквизиты реципиента

Example: CARD NUMBER
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Доп поля для вывода

Example: {"email":"payer@gmail.com"}
Responses
200
Успешное создание фиатного вывода
application/json
Responseall of
and
post
POST /api/v1/integration/orders/fiat-withdraw HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "currency": "CODE",
  "paymentMethod": "card",
  "providerOutAliasCode": "BANK",
  "code": "CURRENCY_CARD_65",
  "amount": 10,
  "comment": "Оплата сервера за 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": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание фиатного инвойса

post

Эндпоинт позволяет создать заявку на оплату фиатного инвойса. Основные параметры инвойса: invoiceAssetCode - валюта invoiceAmount - сумма providerInAliasCode - код банка приема платежа code - код способа оплаты Для получения данных по доступным способам, банкам, лимитам, кодам оплаты и тд. обратитесь к API методу fiat-deposit-config.

Header parameters
x-api-keystringRequired
Body
invoiceAssetCodestringRequired

Ассет, в котором выстален счет покупателю

Example: USDT
commentstring · min: 5Optional

Комментарий к ордеру. Опциональное поле

Example: Заказ №234
publicCommentstring · min: 5Optional

Публичный комментарий к ордеру. Опциональное поле

Example: Заказ №234
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Url для перенаправления покупателя после оплаты

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

Включить комиссию сервиса в счет покупателю (если не указано, то берется из настроек мерчанта)

Example: true
isAwaitRequisitesbooleanOptional

Ожидать реквизиты для оплаты в респонсе (по дефолту false)

Example: true
expiryDurationMinutesnumberOptional

Время жизни инвойса, в минутах (по дефолту 20)

Example: 20
invoiceTplall of | nullableOptional

Шаблон макета формы оплаты

codestringOptional

Способ вывода

Example: CURRENCY_CARD_65
providerInAliasCodestringOptional

Банк приема платежа

Example: BANK
invoiceAmountstringRequired

Сумма для оплаты в $invoiceAssetCode

Example: 5000
Responses
200
Успешное создание фиатного инвойса
application/json
Responseall of
and
post
POST /api/v1/integration/orders/fiat-invoice HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "invoiceAssetCode": "USDT",
  "comment": "Заказ №234",
  "publicComment": "Заказ №234",
  "callbackUrl": "https://api.myip.com",
  "redirectUrl": "https://marketplace.com/cart",
  "isBayerPaysService": true,
  "isAwaitRequisites": true,
  "expiryDurationMinutes": 20,
  "invoiceTpl": {
    "locales": [
      "en",
      "ru"
    ]
  },
  "code": "CURRENCY_CARD_65",
  "providerInAliasCode": "BANK",
  "invoiceAmount": 5000
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание обмена

post

Конвертация на сумму amountIn в валюте assetCodeIn в валюту assetCodeOut.

Header parameters
x-api-keystringRequired
Body
assetCodeInstringRequired

Ассет на входе в обмен

Example: USDT
amountInnumberRequired

Обмениваемая сумма

Example: 10
assetCodeOutstringRequired

Ассет на выходе

Example: USDT
amountOutnumberRequired

Ожидаемая сумма

Example: 10
commentstringOptional

Комментарий к обмену. Опциональное поле

Example: Хеджирование за 07.2023
exchangePrioritystringOptional

Приоритет обмена (по дефолту "in")

Example: in
Responses
200
Успешное создание обмена
application/json
Responseall of
and
post
POST /api/v1/integration/orders/exchange HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "assetCodeIn": "USDT",
  "amountIn": 10,
  "assetCodeOut": "USDT",
  "amountOut": 10,
  "comment": "Хеджирование за 07.2023",
  "exchangePriority": "in"
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание перевода между аккаунтами

post

Перевод средств на другой аккаунт внутри системы.

Header parameters
x-api-keystringRequired
Body
amountnumberRequired

Сумма для перевода

Example: 10
assetCodestringRequired

Отправляемый ассет

Example: USDT
recipientIdnumberRequired

Реципиент (ID мерчанта)

Example: 7647
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: С Днем Рождения!
Responses
200
Успешное создание перевода
application/json
Responseall of
and
post
POST /api/v1/integration/orders/account-transfer HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "amount": 10,
  "assetCode": "USDT",
  "recipientId": 7647,
  "comment": "С Днем Рождения!"
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Оценка входа

post

Метод предназначен для оценки суммы, которую необходимо заплатить в валюте fromCurrencyCode для получения суммы amountTo в валюте toCurrencyCode (с учетом курса обмена и комиссии).

Header parameters
x-api-keystringRequired
Body
fromCurrencyCodestringOptional

Валюта на входе

Example: BTC
toCurrencyCodestringRequired

Валюта на выходе

Example: USDTBEP20
amountTonumberRequired

Сумма на выходе

Example: 15
Responses
200
Успешная оценка входа
application/json
Responseall of
and
post
POST /api/v1/integration/orders/estimate-in HTTP/1.1
Host: 
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
}

Оценка выхода

post

Метод предназначен для оценки суммы, которая будет получена в валюте toCurrencyCode при оплате суммы amountFrom в валюте fromCurrencyCode (с учетом курса обмена и комиссии).

Header parameters
x-api-keystringRequired
Body
toCurrencyCodestringRequired

Выходная валюта

Example: USDT-INTERNAL
fromCurrencyCodestringRequired

Отдаваемая валюта

Example: BTC-INTERNAL
amountFromnumberRequired

Отдаваемая сумма

Example: 15
Responses
200
Успешная оценка выхода
application/json
Responseall of
and
post
POST /api/v1/integration/orders/estimate-out HTTP/1.1
Host: 
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
}

Создание инвойса без суммы

post

Создание инвойса без указания суммы оплаты. Инвойс формируется в валюте invoiceAssetCode. Платеж производится в валюте, указанной в параметре currencyInCode. Если не заполнено - покупателю будет предложен список доступных для оплаты валют.

Header parameters
x-api-keystringRequired
Body
currencyInCodestringOptional

Валюта, выбранная для оплаты покупателем

Example: BTC
invoiceAssetCodestringRequired

Ассет, в котором выстален счет покупателю

Example: USDT
commentstring · min: 5Optional

Комментарий к ордеру. Опциональное поле

Example: Заказ №234
publicCommentstring · min: 5Optional

Публичный комментарий к ордеру. Опциональное поле

Example: Заказ №234
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Url для перенаправления покупателя после оплаты

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

Включить комиссию сервиса в счет покупателю (если не указано, то берется из настроек мерчанта)

Example: true
isAwaitRequisitesbooleanOptional

Ожидать реквизиты для оплаты в респонсе (по дефолту false)

Example: true
expiryDurationMinutesnumberOptional

Время жизни инвойса, в минутах (по дефолту 20)

Example: 20
invoiceTplall of | nullableOptional

Шаблон макета формы оплаты

Responses
200
Успешное создание инвойса без суммы
application/json
Responseall of
and
post
POST /api/v1/integration/orders/invoice/without-amount HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "currencyInCode": "BTC",
  "invoiceAssetCode": "USDT",
  "comment": "Заказ №234",
  "publicComment": "Заказ №234",
  "callbackUrl": "https://api.myip.com",
  "redirectUrl": "https://marketplace.com/cart",
  "isBayerPaysService": true,
  "isAwaitRequisites": true,
  "expiryDurationMinutes": 20,
  "invoiceTpl": {
    "locales": [
      "en",
      "ru"
    ]
  }
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание заявки на Валюта -> Валюта (мост)

post

Заявка на конвертацию и перевод средств между различными сетями. Процесс включает три этапа: Получение -> Обмен -> Вывод. Например, при переводе USDTERC20 в BNBBEP20: 1. Предоставляется адрес для внесения USDTERC20 (fromCurrencyCode) в сети Ethereum 2. Полученные средства конвертируются в BNB 3. BNB выводятся как BNBBEP20 (toCurrencyCode) на указанный адрес (recipient) в сети Binance Smart Chain

  Важно: Сумма перевода (amount) указывается в toCurrencyCode.
 
  Совет: Для оценки суммы fromCurrencyCode можно воспользоваться методом "orders/estimate-in".
Header parameters
x-api-keystringRequired
Body
amountstringRequired

Сумма выхода

Example: 10
toCurrencyCodestringRequired

Валюта получения (с сетью)

Example: USDTMATIC
recipientstringRequired

Реципиент (адрес)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Мемо тег (для XRP, TON и т.д.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
detailsobjectOptional

Детали для фиатных выводов

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

Входная валюта

Example: BTC
Responses
200
Успешное создание СТС заявки
application/json
Responseall of
and
post
POST /api/v1/integration/orders/currency-to-currency HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "amount": 10,
  "toCurrencyCode": "USDTMATIC",
  "recipient": "0x0000000000000000000000000000000000000000",
  "requisitesMemoTag": "80576",
  "callbackUrl": "https://api.myip.com",
  "comment": "Оплата сервера за 07.2023",
  "details": "{\"method\":\"card\"}",
  "fromCurrencyCode": "BTC"
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Создание заявки Вывод с обменом

post

Заявка на вывод с конвертацией. Процесс включает два этапа: Обмен -> Вывод. Например, при выводе USDT в BTC: 1. USDT (fromAssetCode) с баланса мерчанта конвертируются в BTC 2. BTC (toCurrencyCode) выводятся на указанный адрес (recipient) в сети Bitcoin.

  Важно:Сумма вывода (amount) указывается в toCurrencyCode.
 
  Совет: Для оценки суммы currencyInCode можно воспользоваться методом "orders/estimate-in".
Header parameters
x-api-keystringRequired
Body
amountstringRequired

Сумма выхода

Example: 10
toCurrencyCodestringRequired

Валюта получения (с сетью)

Example: USDTMATIC
recipientstringRequired

Реципиент (адрес)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Мемо тег (для XRP, TON и т.д.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

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

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
fromAssetCodestringRequired

Ассет из которого конвертируется

Example: BTC
Responses
200
Успешное создание заявки на вывод с обменом
application/json
Responseall of
and
post
POST /api/v1/integration/orders/withdraw-with-exchange HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "amount": 10,
  "toCurrencyCode": "USDTMATIC",
  "recipient": "0x0000000000000000000000000000000000000000",
  "requisitesMemoTag": "80576",
  "callbackUrl": "https://api.myip.com",
  "comment": "Оплата сервера за 07.2023",
  "fromAssetCode": "BTC"
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "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": "2025-06-30T16:25:29.195Z",
    "isImPayed": false,
    "isBayerPaysService": false,
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "requisitesInUrl": "https://example.com/requisites",
    "orderCurrencyType": "crypto",
    "paymentMethod": "sbp",
    "providerCode": "123123123123",
    "providerAliasCode": "text",
    "providerName": "text",
    "paymentTiming": "onTime",
    "amountValidity": "valid"
  },
  "count": 1
}

Получить значения для фильтра ассетов

get
Header parameters
x-api-keystringRequired
Responses
200
Возвращает массив строк, которые возможно использовать как фильтр для query-параметра "assets" в эндпоинте получения списка ордеров
application/json
Responseall of
and
get
GET /api/v1/integration/orders/filters/assets HTTP/1.1
Host: 
x-api-key: text
Accept: */*

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

Получить значения для фильтра сетей

get
Header parameters
x-api-keystringRequired
Responses
200
Возвращает массив строк, которые возможно использовать как фильтр для query-параметра "networks" в эндпоинте получения списка ордеров
application/json
Responseall of
and
get
GET /api/v1/integration/orders/filters/networks HTTP/1.1
Host: 
x-api-key: text
Accept: */*

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

Получение доступных пар обмена мерчанта

get
Query parameters
fromstringOptional

Код получаемого токена

Example: QWRUB
tostringOptional

Код отдаваемого токена

Example: ETH
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение пар обмена мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/assets/exchange-rate HTTP/1.1
Host: 
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": "45.096",
      "isTurnRate": false
    }
  ],
  "count": 1
}

Получение включенных ассетов мерчанта

get
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение включенных ассетов мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/assets/enabled HTTP/1.1
Host: 
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
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение настроек ассетов мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/assets/settings HTTP/1.1
Host: 
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
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение валют мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/assets/currencies HTTP/1.1
Host: 
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
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение списка доступных ассетов
application/json
Responseall of
and
get
GET /api/v1/integration/assets HTTP/1.1
Host: 
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
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение комиссий для вывода
application/json
Responseall of
and
get
GET /api/v1/integration/assets/withdraw-fee HTTP/1.1
Host: 
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
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение информации по мерчанту
application/json
Responseall of
and
get
GET /api/v1/integration/merchant HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "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": "Платформа продажи кросовок",
      "country": "france",
      "turnover": "$1000000-$10000000",
      "activity": "Маркетплейс",
      "email": "serviceName@mail.com",
      "phone": "+7(999)123-23-34",
      "otherCommunications": "telegram: @serviceName_for_you",
      "comment": "Это комментарий",
      "updatedByUid": "xx"
    },
    "merchantSettings": {
      "callbackUrl": "https://api.myip.com",
      "isBayerPaysService": true,
      "secretKey": "some-secret-value",
      "updatedByUid": "xx"
    },
    "createdByUid": "xx",
    "updatedByUid": "xx"
  },
  "count": 1
}

Получение тарифа мерчанта

get
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение тарифа мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/merchant/pricing HTTP/1.1
Host: 
x-api-key: text
Accept: */*

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

Получение валют мерчанта

get
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение балансов мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/merchant/balances HTTP/1.1
Host: 
x-api-key: text
Accept: */*

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

Получить крипто адреса мерчанта

get
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение крипто адресов мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/merchant/deposit-wallets HTTP/1.1
Host: 
x-api-key: text
Accept: */*

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

Получить список биллингов мерчанта

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
searchstringOptional

Поиск

Example: test@mail.com
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение списка биллингов мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/merchant/billings HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2025-06-30T16:25:29.195Z",
      "updatedAt": "2025-06-30T16:25:29.195Z",
      "deletedAt": "2025-06-30T16:25:29.195Z",
      "tag": "test@example.com",
      "publicName": "Аккаунт BlackGod8675",
      "totalDeposits": [
        {
          "currencyInCode": "USDTERC20",
          "amount": "2.334"
        }
      ],
      "wallets": [
        {
          "currencyCode": "USDTERC20",
          "address": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
          "assetCode": "USDT"
        }
      ]
    }
  ],
  "count": 1
}

Получить/создать биллинг

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

Публичное имя счета (показывается покупателю)

Example: Аккаунт BlackKnight165
Responses
200
Успешное получение списка биллингов мерчанта
application/json
Responseall of
and
post
POST /api/v1/integration/merchant/billings/{billingTag} HTTP/1.1
Host: 
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "publicName": "Аккаунт BlackKnight165"
}
{
  "message": "ok",
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2025-06-30T16:25:29.195Z",
    "updatedAt": "2025-06-30T16:25:29.195Z",
    "deletedAt": "2025-06-30T16:25:29.195Z",
    "tag": "test@example.com",
    "publicName": "Аккаунт BlackGod8675",
    "totalDeposits": [
      {
        "currencyInCode": "USDTERC20",
        "amount": "2.334"
      }
    ],
    "wallets": [
      {
        "currencyCode": "USDTERC20",
        "address": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
        "assetCode": "USDT"
      }
    ]
  },
  "count": 1
}

Получить список фиатных способов вывода

get
Path parameters
currencystringRequired
Header parameters
x-api-keystringRequired
Responses
200
Эндпоинт позволяет получить список доступных способов для вывода фиатных средств для мерчанта. Эти данные необходимы для формирования запроса API метода fiat-withdraw
application/json
Responseall of
and
get
GET /api/v1/integration/merchant/fiat-withdraw-config/{currency} HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "name": "Все карты",
      "code": "RUB_CARD_32",
      "paymentMethod": "card",
      "currency": "RUB",
      "currencyOutCode": "USD",
      "paymentType": "deposit",
      "providersOut": [
        {
          "name": "Сбербанк",
          "code": "111000011",
          "aliasCode": "sber"
        }
      ],
      "amountMin": "10.00",
      "amountMax": "1000.00",
      "feePercent": "1.5"
    }
  ],
  "count": 1
}

Получить список фиатных способов пополнения

get
Path parameters
currencystringRequired
Header parameters
x-api-keystringRequired
Responses
200
Эндпоинт позволяет получить список доступных способов для приема фиатных средств для мерчанта. Эти данные необходимы для формирования запроса API метода fiat-deposit
application/json
Responseall of
and
get
GET /api/v1/integration/merchant/fiat-deposit-config/{currency} HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "name": "Все карты",
      "code": "RUB_CARD_32",
      "paymentMethod": "card",
      "currency": "RUB",
      "currencyOutCode": "USD",
      "paymentType": "deposit",
      "providersOut": [
        {
          "name": "Сбербанк",
          "code": "111000011",
          "aliasCode": "sber"
        }
      ],
      "amountMin": "10.00",
      "amountMax": "1000.00",
      "feePercent": "1.5"
    }
  ],
  "count": 1
}

Получение списка ордеров мерчанта

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
merchantsUidsstring[]Optional

Uid мерчантов

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

Биллинг тэг

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

Активы

Example: ["USDT"]
networksstring[]Optional

Сети

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

Дата создания (начало периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

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

Дата создания (конец периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
showProtectedMerchantsOrdersbooleanOptional

Показать ордера защищаемых (внутренних) мерчантов

Example: false
searchstringOptional

Поиск заявки по комментарию, id транзакции, UID заявки, имени мерчанта

Example: test@mail.com
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение списка ордеров мерчанта
application/json
Responseall of
and
get
GET /api/v1/integration/orders HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2025-06-30T16:25:29.195Z",
      "updatedAt": "2025-06-30T16:25:29.195Z",
      "deletedAt": "2025-06-30T16:25:29.195Z",
      "serviceCommission": "0.565",
      "netCommission": "0.565",
      "comment": "Комментарий",
      "publicComment": "Публичный комментарий",
      "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "merchantName": "Тестовый мерчант",
      "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": "2025-06-30T16:25:29.195Z",
      "isImPayed": false,
      "isBayerPaysService": false,
      "serviceFeeCurrencyCode": "USDT",
      "netFeeCurrencyCode": "USDT",
      "requisitesInUrl": "https://example.com/requisites",
      "orderCurrencyType": "crypto",
      "paymentMethod": "sbp",
      "providerCode": "123123123123",
      "providerAliasCode": "text",
      "providerName": "text",
      "paymentTiming": "onTime",
      "amountValidity": "valid"
    }
  ],
  "count": 1
}

Получение списка ордеров мерчанта с типизированным поиском

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
merchantsUidsstring[]Optional

Uid мерчантов

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

Биллинг тэг

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

Активы

Example: ["USDT"]
networksstring[]Optional

Сети

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

Дата создания (начало периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

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

Дата создания (конец периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
showProtectedMerchantsOrdersbooleanOptional

Показать ордера защищаемых (внутренних) мерчантов

Example: false
searchTypestring · enumOptional

Тип реквизитов для поиска

Possible values:
searchTextstringOptional

Текст для поиска в реквизитах указанного типа

Example: some_text
Header parameters
x-api-keystringRequired
Responses
200
Успешное получение списка ордеров мерчанта
application/json
Responseall of
and
get
GET /api/v2/integration/orders HTTP/1.1
Host: 
x-api-key: text
Accept: */*

{
  "message": "ok",
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2025-06-30T16:25:29.195Z",
      "updatedAt": "2025-06-30T16:25:29.195Z",
      "deletedAt": "2025-06-30T16:25:29.195Z",
      "serviceCommission": "0.565",
      "netCommission": "0.565",
      "comment": "Комментарий",
      "publicComment": "Публичный комментарий",
      "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "merchantName": "Тестовый мерчант",
      "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": "2025-06-30T16:25:29.195Z",
      "isImPayed": false,
      "isBayerPaysService": false,
      "serviceFeeCurrencyCode": "USDT",
      "netFeeCurrencyCode": "USDT",
      "requisitesInUrl": "https://example.com/requisites",
      "orderCurrencyType": "crypto",
      "paymentMethod": "sbp",
      "providerCode": "123123123123",
      "providerAliasCode": "text",
      "providerName": "text"
    }
  ],
  "count": 1
}

PreviousПриём фиатаNextErrors

Last updated