API Reference

Эндпоинт:

https://pay.alfabit.org/

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

GET/api/v1/integration/orders

Query parameters

Header parameters

Response

200400401403500

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

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of OrderListSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2024-07-27T14:23:59.614Z",
      "updatedAt": "2024-07-27T14:23:59.614Z",
      "deletedAt": "2024-07-27T14:23:59.614Z",
      "comment": "Комментарий",
      "publicComment": "Публичный комментарий",
      "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "merchantName": "Тестовый мерчант",
      "type": "invoice",
      "status": "created",
      "invoiceCurrencyCode": "BTC",
      "currencyInCode": "USDT",
      "currencyOutCode": "USD",
      "invoiceAmount": "10.2334",
      "amountInExpected": "43.11",
      "amountInFact": "44",
      "amountOutExpected": "43.11,",
      "amountOutFact": "44",
      "hedgeRate": "44",
      "paymentTiming": "onTime",
      "amountValidity": "valid",
      "isDone": false,
      "apiMode": "ui",
      "risk": "24",
      "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
      "billingTag": "[e-mail]"
    }
  ]
}

Примечание

Параметры 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 - Ожидание проверки оплаты.

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

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

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

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

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

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

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

Path parameters

orderUid*string

Header parameters

Response

200400401403500

Успешное получение информации по ордеру

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/{orderUid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDT",
    "currencyOutCode": "USD",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "billingTag": "[e-mail]",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-07-27T14:23:59.614Z",
    "isImPayed": false
  }
}

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

POST/api/v1/integration/orders/invoice

Header parameters

Body

application/json

currencyInCodestring

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

Example: "BTC"

commentstring

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

Example: "Заказ №234"

publicCommentstring

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

Example: "Заказ №234"

callbackUrlstring

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

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

redirectUrlstring

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

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

isBayerPaysServiceboolean

Включить комиссию сервиса в счет покупателю (по дефолту false)

Example: true

isAwaitRequisitesboolean

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

Example: true

invoiceAssetCode*string

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

Example: "USD"

invoiceAmount*string

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

Example: 5000

Response

200400401403500

Успешное создание инвойса

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/invoice', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invoiceAssetCode": "USD",
      "invoiceAmount": 5000
    }),
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDT",
    "currencyOutCode": "USD",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "billingTag": "[e-mail]",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-07-27T14:23:59.614Z",
    "isImPayed": false
  }
}

Примечание

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/api/v1/integration/orders/withdraw

Header parameters

Body

application/json

amount*string

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

Example: 10

toCurrencyCode*string

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

Example: "USDTMATIC"

recipient*string

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

Example: "0x1111111111111111111111111111"

callbackUrlstring

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

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

commentstring

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

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

detailsobject

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

Example: "{\"method\":\"card\"}"

Response

200400401403500

Успешное создание вывода

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/withdraw', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 10,
      "toCurrencyCode": "USDTMATIC",
      "recipient": "0x1111111111111111111111111111"
    }),
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDT",
    "currencyOutCode": "USD",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "billingTag": "[e-mail]",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-07-27T14:23:59.614Z",
    "isImPayed": false
  }
}

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

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

POST/api/v1/integration/orders/exchange

Header parameters

Body

application/json

assetCodeIn*string

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

Example: "USDT"

amountIn*number

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

Example: 10

assetCodeOut*string

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

Example: "USDT"

amountOut*number

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

Example: 10

commentstring

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

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

Response

200400401403500

Успешное создание обмена

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/exchange', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assetCodeIn": "USDT",
      "amountIn": 10,
      "assetCodeOut": "USDT",
      "amountOut": 10
    }),
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDT",
    "currencyOutCode": "USD",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "billingTag": "[e-mail]",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-07-27T14:23:59.614Z",
    "isImPayed": false
  }
}

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

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

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

Header parameters

Body

application/json

amount*number

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

Example: 10

asssetCode*string

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

Example: "USDT"

recipient*string

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

Example: "uuuuu-xxxx-zzzzz"

commentstring

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

Example: "С Днем Рождения!"

Response

200400401403500

Успешное создание перевода

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/account-transfer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 10,
      "asssetCode": "USDT",
      "recipient": "uuuuu-xxxx-zzzzz"
    }),
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDT",
    "currencyOutCode": "USD",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "billingTag": "[e-mail]",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-07-27T14:23:59.614Z",
    "isImPayed": false
  }
}

Оценка входа

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

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

Header parameters

Body

application/json

toCurrencyCode*string

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

Example: "USDTBEP20"

amountTo*number

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

Example: 10

fromCurrencyCodestring

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

Example: "USDTBEP20"

Response

200400401403500

Успешная оценка входа

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataEstimationSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/estimate-invoice-in', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "toCurrencyCode": "USDTBEP20",
      "amountTo": 10
    }),
});
const data = await response.json();

Response

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

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

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

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

Header parameters

Body

application/json

toCurrencyCode*string

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

Example: "USDTBEP20"

fromCurrencyCode*string

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

Example: "BTC"

amountFrom*number

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

Example: 10

Response

200400401403500

Успешная оценка выхода

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataEstimationSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/estimate-invoice-out', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "toCurrencyCode": "USDTBEP20",
      "fromCurrencyCode": "BTC",
      "amountFrom": 10
    }),
});
const data = await response.json();

Response

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

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

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

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

Header parameters

Body

application/json

currencyInCodestring

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

Example: "BTC"

commentstring

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

Example: "Заказ №234"

publicCommentstring

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

Example: "Заказ №234"

callbackUrlstring

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

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

redirectUrlstring

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

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

isBayerPaysServiceboolean

Включить комиссию сервиса в счет покупателю (по дефолту false)

Example: true

isAwaitRequisitesboolean

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

Example: true

Response

200400401403500

Успешное создание инвойса без суммы

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/orders/invoice/without-amount', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDT",
    "currencyOutCode": "USD",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "billingTag": "[e-mail]",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-07-27T14:23:59.614Z",
    "isImPayed": false
  }
}

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

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

Query parameters

Header parameters

Response

200400401403500

Успешное получение пар обмена мерчанта

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of PairSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/assets/exchange-rate', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GET/api/v1/integration/assets/enabled

Header parameters

Response

200400401403500

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

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of AssetSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/assets/enabled', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": [
    {
      "code": "BNB",
      "type": "COIN",
      "usdPrice": "2000",
      "eurPrice": "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",
          "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
        }
      ]
    }
  ]
}

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

GET/api/v1/integration/assets/settings

Header parameters

Response

200400401403500

Успешное получение настроек ассетов мерчанта

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of AssetSettingsSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/assets/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GET/api/v1/integration/assets/currencies

Header parameters

Response

200400401403500

Успешное получение валют мерчанта

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of CurrencySerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/assets/currencies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": [
    {
      "assetCode": "BNB",
      "fiatCode": "USD",
      "isInternal": false,
      "publicName": "BinanceCoin(BNB) Internal",
      "publicCode": "BNB-INTERNAL",
      "example": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
      "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
    }
  ]
}

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

GET/api/v1/integration/assets

Header parameters

Response

200400401403500

Успешное получение списка доступных ассетов

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of AssetSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/assets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": [
    {
      "code": "BNB",
      "type": "COIN",
      "usdPrice": "2000",
      "eurPrice": "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",
          "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
        }
      ]
    }
  ]
}

Получение комиссий для вывода ассетов

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

Header parameters

Response

200400401403500

Успешное получение комиссий для вывода

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of AssetWithdrawFee (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/assets/withdraw-fee', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GET/api/v1/integration/merchant

Header parameters

Response

200400401403500

Успешное получение информации по мерчанту

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataMerchantSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/merchant', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "name": "MyMerchant.",
    "enabledAssets": [
      "BTC",
      "USDT",
      "BNB"
    ],
    "status": "active",
    "balanceUsd": "43.11",
    "pricing": {
      "name": "testPricing",
      "percentIn": 1,
      "percentOut": 1,
      "percentExchange": 1
    },
    "fiatPricing": {
      "name": "testPricing",
      "percentWitdrawCard": 1,
      "percentWitdrawPhone": 1,
      "percentWitdrawSbp": 1,
      "percentWitdrawWallet": 1
    },
    "merchantInfo": {
      "projectName": "My project name",
      "projectLink": "https://project-site.com",
      "projectDescription": "Платформа продажи кросовок",
      "country": "france",
      "turnover": "$1000000-$10000000",
      "activity": "Маркетплейс",
      "email": "[e-mail]",
      "phone": "[phone]",
      "otherCommunications": "telegram: @serviceName_for_you",
      "comment": "Это комментарий",
      "updatedByUid": "xx"
    },
    "merchantSettings": {
      "callbackUrl": "https://api.myip.com",
      "isBayerPaysService": false,
      "secretKey": "some-secret-value",
      "updatedByUid": "xx"
    },
    "createdByUid": "xx",
    "updatedByUid": "xx"
  }
}

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

GET/api/v1/integration/merchant/pricing

Header parameters

Response

200400401403500

Успешное получение тарифа мерчанта

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataPricingSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/merchant/pricing', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GET/api/v1/integration/merchant/balances

Header parameters

Response

200400401403500

Успешное получение балансов мерчанта

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of BalanceDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/merchant/balances', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

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

Header parameters

Response

200400401403500

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

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataDepositWalletDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/merchant/deposit-wallets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GET/api/v1/integration/merchant/billings

Query parameters

Header parameters

Response

200400401403500

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

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of BillingsSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/merchant/billings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": [
    {
      "id": 1,
      "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
      "createdAt": "2024-07-27T14:23:59.614Z",
      "updatedAt": "2024-07-27T14:23:59.614Z",
      "deletedAt": "2024-07-27T14:23:59.614Z",
      "tag": "[e-mail]",
      "publicName": "Аккаунт BlackGod8675",
      "totalDeposits": [
        {
          "currencyInCode": "USDTERC20",
          "amount": "2.334"
        }
      ],
      "wallets": [
        {
          "currencyCode": "BTC",
          "address": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB"
        }
      ]
    }
  ]
}

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

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

Path parameters

billingTag*string

Header parameters

Body

application/json

publicNamestring

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

Example: "Аккаунт BlackKnight165"

Response

200400401403500

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

Body

application/json

message*string

Сообщение статуса

Example: "ok"

countnumber

Общее кол-во элементов в БД

Example: 1

dataBillingsSerializer (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/integration/merchant/billings/{billingTag}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-07-27T14:23:59.614Z",
    "updatedAt": "2024-07-27T14:23:59.614Z",
    "deletedAt": "2024-07-27T14:23:59.614Z",
    "tag": "[e-mail]",
    "publicName": "Аккаунт BlackGod8675",
    "totalDeposits": [
      {
        "currencyInCode": "USDTERC20",
        "amount": "2.334"
      }
    ],
    "wallets": [
      {
        "currencyCode": "BTC",
        "address": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB"
      }
    ]
  }
}