`\
Пример: вы создали счет на оплату 75 USD и указали `insurancePercent` равным 5. При выборе монеты оплаты, например, USDT (условно примем, что курс USDT/USD 1=1), плательщику будет предложено оплатить 78.75 USDT (5% от 75 = 3.75)
Так же вы можете указать чтобы плательщик оплачивал комиссию сети указав параметр `includeFee: true`.\
В таком случае к конечной сумме оплаты будет добавлена комиссия, выбраной плательщиком, сети
Есть возможность указать процент проскальзывания цены (поле `slippagePercent`).\
Если оно будет указанно, то если плательщик при оплате отправит сумму больше или меньше суммы оплаты на указанный процент, то счет будет считаться закрытым.\
Пример: плательщику надо оплатить 100 USDT, вы указали процент проскальзывания 0.5%.\
В таком случае если плательщик отправит сумму 99.99 USDT (от 99.5 и до 100.5) счет будет считаться исполненным
## Схема взаимодействия с API
{% @mermaid/diagram content="sequenceDiagram
Client ->> Merchant: Запрос оплаты
Merchant ->> Apollopayment: Создание инвойса
Apollopayment ->> Merchant: Инвойс
Merchant ->> Client: Ссылка на оплату
```
Note over Client: Выбирает монету/сеть оплаты
Note over Client: Отправляет монеты
Apollopayment -->> Merchant: Вебхук о поступлении платежа" %}
```
## Возможные статусы
| Статус | Описание |
| ----------- | ------------------------------------------------------------------------ |
| `INIT` | Пользователь перешел к оплате |
| `ERROR` | Ошибка в процессе создания или обработки |
| `PROCESSED` | Исполнен |
| `PENDING` | Ожидаение полной суммы или ожидание подтверждений транзакции в блокчейне |
| `EXPIRED` | Скрок действия инвойса истек |
| `PARTIAL` | Частичная оплата |
| `OVERPAID` | Счет был оплачен сверх указанной суммы |
| `REJECTED` | Инвойс отклонен, свяжитесь с поддержкой для уточнения |
При изменении статуса или поступлении новой транзакции вам будет отправлен вебхук на указанный при создании ордера URL.
Подробнее о вебхуке можно узнать в разделе **Webhooks**
## Срок жизни счета
Указанный срок жизни счета распространяется на промежут от *создания счета* и до *выбора плательщиком монет и сети для оплаты*
После выбора монеты и сети плательщиком будет создан ордер с максимальным временем жизни доступным выбранной сети.
Подробнее можно узнать в разделе ордеров.
# Создание счета на оплату
Метод позволяет создать счет на оплату без строгого указания монеты и сети, вы можете указать оплату 30 USD и список доступных к оплате монет/сетей, пользователь сам выберет в чем ему удобнее оплатить. Сумма автоматически пересчитается в выбранную монету для оплаты
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/make-invoice" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Запрос получения информации об инвойсе
Метод позволяет получить информацию об инвойсе
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/get-invoice" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение списка счетов
Метод позволяет получить список счетов
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/get-invoices" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Авто обмены
Функционал авто-обменов позволит вам делать выводы клиентам во всех доступных монетах и сетях.
Для начала работы вам необходимо создать PAY\_OUT адрес и выбрать его в качестве адреса для авто-обменов.\
Все операции будут расходовать средства с этого адреса для обмена в конечную монету и отправку клиенту.
Для создания авто-обмена вам достаточно указать какую монету и сеть хотите получить на выходе и адрес для отправки.
Для обмена вы можете указать как исходящую сумму, которую хотите потратить с адреса, так и конечную сумму, которую хотите получить.
* Если указываете исходящую сумму, то с адреса будет списана указанная сумма, но конечная сумма может измениться в результате обмена
* Если указываете конечную сумму, то на адресе будет заблокирована рассчетная сумма списания +5%, которая будет откорректирована в результате обмена
## Схема взаимодействия с API
{% @mermaid/diagram content="sequenceDiagram
Merchant ->> Apollopayment: Создание обмена
Apollopayment ->> Merchant: Тело обмена
```
Note over Apollopayment: Совершение обмена
Apollopayment -->> Merchant: Вебхук с результатом обмена" %}
```
# Создание авто-обмена
Метод создает запрос на авто-обмен
На создание распространяются лимиты сумм:
* сумма должна быть **больше $20 в эквиваленте**
* сумма должна быть **в два раза больше комиссии сети конечной монеты/сети** (*см. метод получения доступных монет*)
## Описание параметров запроса
| Параметр | Тип | Обязательно | Описание |
| ------------- | --------- | ----------- | -------------------------------------------------- |
| `address` | `string` | yes | Адрес назначения |
| `currency` | `string` | yes | Монета к получению |
| `network` | `string` | yes | Сеть к получению |
| `amountFrom` | `string` | no | Сумма, которую хотите поменять и отправить |
| `amountTo` | `string` | no | Сумма, которую хотите получить |
| `feeInAmount` | `boolean` | no | Закладывать комиссию сети в сумму обмена |
| `webhookUrl` | `string` | no | URL для отправки уведомлений при изменении статуса |
> Обязательно надо отправить один из параметров: `amountFrom` или `amountTo`\
> При указании двух параметров приоритет будет иметь `amountFrom`
### Закладывать комиссию сети в сумму обмена
Указывая параметр `feeInAmount` в значении `true` с адреса будет списана **указанная сумма + комиссия сети**
* Если указывате `amountFrom` - возможно проскальзывание конечной суммы `amountTo` (может отличаться от указаной после запроса создания)
* Если указываете `amountTo` - будет заблокирована расчетная сумма списания с адреса + процент для покрытия страховки проскальзывания.\
После завершения обмена сумма будет откорректирована, до той, которая была израсходована для проведения обмена.\
*Возможно небольшое проскальзывание (≈ 0.1%) конечной суммы из-за наложения фильтров обмена на сумму к получению*
## Описание параметров ответа
| Параметр | Тип | Описание |
| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
| `id` | `string` | Идентификатор авто-обмена |
| `organizationId` | `string` | Идентификатор организации |
| `status` | `enum` | Статус |
| `currencyFrom` | `string` | Исходящая монета адреса выбранного для проведения авто-обменов |
| `networkFrom` | `string` | Исходящая сеть адреса выбранного для проведения авто-обменов |
| `currencyTo` | `string` | Конечная монета, которая будет отправлена клиенту |
| `networkTo` | `string` | Конечная сеть, которая будет отправлена клиенту |
| `amountFrom` | `string` | Сумма потраченная для проведения операции |
| `amountFromUSD` | `string` | Сумма потраченная для проведения операции в пересчете к USD |
| `amountTo` | `string` | Конечная сумма после обмена |
| `amountToUSD` | `string` | Конечная сумма после обмена в пересчете к USD |
| `amountToReceive` | `string` | Сумма, которую получит клиент |
| `rate` | `string` | Курс обмена |
| `blockchainFeeFrom` | `string` | Комиссия сети за отправку монет провайдеру для совершения обмена |
| `blockchainFeeFromUSD` | `string` | Комиссия сети за отправку монет провайдеру для совершения обмена в пересчете к USD |
| `blockchainFeeTo` | `string` | Комиссия сети за отправку монет от провайдера на адрес клиента |
| `blockchainFeeToUSD` | `string` | Комиссия сети за отправку монет от провайдера на адрес клиента в пересчете к USD |
| `serviceFee` | `string` | Комиссия сервиса за проведение операции |
| `webhookUrl` | `string` | URL для отправки уведомления об изменении статуса |
| `createdAt` | `string` | Дата создания авто-обмена |
| `updatedAt` | `string` | Дата последнего обновления изменения |
Статусы:
| Статус | Описание |
| ------------- | ----------------------------------- |
| `PENDING` | В обработке |
| `WITHDRAWING` | Ожидание отправки на конечный адрес |
| `PROCESSED` | Успешно |
| `REJECTED` | Отклонен |
| `ERROR` | Ошибка при обработке |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/auto-swaps/create" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Поиск авто-обмена по ID
Получение данных авто-обмена по его ID
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/auto-swaps/get" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Выплаты 2.0
Выплаты 2.0 позволяют производить выводы с **выплатных** и **головных** адресов.
Возможности:
* прямой вывод
* вывод между сетями
* вывод с конвертацией монет
## Схема взаимодействия с API
{% @mermaid/diagram content="sequenceDiagram
Merchant ->> Apollopayment: Создание вывода
Apollopayment ->> Merchant: Тело вывода
```
Note over Apollopayment: Обработка операции
Apollopayment -->> Merchant: Вебхук с результатом вывода" %}
```
### Подбор адреса
Для проведения операции подбирается наиболее подходящий адрес
Пример подбора адреса:
У вас есть несколько адресов
| Монета | Сеть | Баланс | Эквивалент |
| ------ | -------- | ------ | ---------- |
| USDT | tron | 100 | .. |
| USDT | ethereum | 100 | .. |
| BNB | bsc | 100 | .. |
* Вы хотите вывести **10 USDT tron**
* Прямой вывод. Будет взят адрес **USDT tron** так как у вас уже есть адрес с этом монетой и в этой сети, и на нем достаточно средств
* Вы хотите вывести **10 BNB bsc**
* Прямой вывод. Будет взят адрес **BNB bsc** так как у вас уже есть адрес с этом монетой и в этой сети, и на нем достаточно средств
* Вы хотите вывести **10 USDT bsc**
* Вывод между сетями. Будет взят адрес **USDT tron** так как подходящего адреса у вас нет
* Вы хотите вывести **1 BTC bitcoin**
* Вывод с конвертацией монет. Будет взят адрес **USDT tron** так как подходящего адреса у вас нет
> Обратите внимание
>
> Операции *вывод между сетями* и *вывод с конвертацией монет* работают только с адресами токенов (USDT, USDC)\
> Адреса нативных монет будут браться только для *прямого вывода*
Адрес берется среди всех **PAY\_OUT** (выплатные) и **COLLECT** (головные) адресов.\
Ищется адрес с балансом покрывающим запрошенную сумму и с наиболее низкой комиссией сети.\
Приоритет операций: вывод, вывод между сетями, вывод с конвертацией монет.
### Комиссии
При проведении операции будет взят тариф в зависимости от типа операции
| Тип операции | Тариф |
| -------------------------- | -------------------------- |
| Прямой вывод | Вывод с выплатного баланса |
| Вывод между сетями | Блокчейн мост API |
| Вывод с конвертацией монет | Обмен API |
> Операции **вывод между сетями**, **вывод с конвертацией монет** проводятся через\
> провайдера услуг, комиссия сети за отправку монет провайдеру компенсируется сервисом
>
> Комиссия сервиса за операцию всегда берется с авансового баланса
>
> Комиссия сети за отправку от провайдера взимается **из суммы если исходящая нативная монета**,**с авансового баланса если исходящая монета является токеном**
### Параметр `feeInAmount`
Параметр позволяет указать, что комиссия сети за отправку монет от провайдера на конечный адрес\
будет взята из суммы (пользователь получит сумму меньше указанной на размер комиссии сети)
> Если исходящая монета нативная, и указан параметр `feeInAmount=false`, то комиссия сети будет\
> добавлена к сумме, чтобы пользователь получил указанную сумму
### Описание полей
В ответ на запрос придет тело со следующими полями
| Имя | Тип | Описание |
| ----------------------- | -------------------------------------------------------- | --------------------------------------------------------------------------- |
| `id` | `string` | Идентификатор операции |
| `organizationId` | `string` | Идентификатор организации |
| `type` | `enum(WITHDRAWAL, BRIDGE, SWAP)` | Тип |
| `status` | `enum(PENDING, WITHDRAWING, PROCESSED, REJECTED, ERROR)` | Статус |
| `message` | `string or null` | Сообщение при отклонении |
| `addressRiskLevel` | `enum(Low, Medium, High, Severe) or null` | Уровень риска конечного адреса |
| `addressFromId` | `string` | Идентификатор исходящего адреса |
| `addressFrom` | `string` | Исходящий адрес |
| `addressTo` | `string` | Конечный адрес |
| `amountFrom` | `string` | Исходящая сумма |
| `amountFromUSD` | `string` | Исходящая сумма в USD |
| `amountTo` | `string` | Сумма после операции |
| `amountToUSD` | `string` | Сумма после операции в USD |
| `amountToReceive` | `string` | Сумма, которая придет на конечный адрес |
| `amountToReceiveUSD` | `string` | Сумма, которая придет на конечный адрес в USD |
| `rate` | `string` | Курс обмена |
| `blockchainFeeFrom` | `string` | Комиссия сети за отправку провайдеру |
| `blockchainFeeFromUSD` | `string` | Комиссия сети за отправку провайдеру в USD |
| `blockchainFeeToSource` | `enum(ADVANCED, AMOUNT)` | Источник списания комиссии сети за отправку от провайдера на конечный адрес |
| `blockchainFeeTo` | `string` | Комиссии сети за отправку от провайдера на конечный адрес |
| `blockchainFeeToUSD` | `string` | Комиссии сети за отправку от провайдера на конечный адрес в USD |
| `serviceFee` | `string` | Комиссия сервиса за проведение операции |
| `webhookUrl` | `string or null` | URL для отправки вебхука |
| `txId` | `string or null` | Хэш транзакции отправки монет на конечный адрес |
| `createdAt` | `string (Date in ISO 8601)` | Дата создания |
| `updatedAt` | `string (Date in ISO 8601)` | Дата последнего обновления |
***
Поле `type`
| Имя | Описание |
| ------------ | -------------------------- |
| `WITHDRAWAL` | Обмен |
| `BRIDGE` | Обмен между сетями |
| `SWAP` | Обмен с конвертацией монет |
***
Поле `status`
| Имя | Описание |
| ------------- | ------------------------------------- |
| `PENDING` | В процессе обработки |
| `WITHDRAWING` | В процессе отправки на конечный адрес |
| `PROCESSED` | Завершен с успехом |
| `REJECTED` | Отклонен системой |
| `ERROR` | Ошибка при обработке |
***
Поле `blockchainFeeToSource`
| Имя | Описание |
| ---------- | ---------------- |
| `ADVANCED` | Авансовый баланс |
| `AMOUNT` | Сумма |
***
Пример тела ответа
```json
{
"success": true,
"response": {
"id": "31a3b86b-e350-4906-9d3e-cc2fca054821",
"organizationId": "1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39",
"userId": null,
"type": "WITHDRAWAL",
"status": "PENDING",
"message": null,
"addressRiskLevel": "Low",
"addressFromId": "25a8de42-a359-47f1-bb82-bc9f6c20f1b9",
"addressFrom": "0xD65D24ABCd85165a243C33Cf8133ffBaaa98255D",
"addressTo": "0x22aECc7ff5b435E38be5457C8538256918783F67",
"amountFrom": "3",
"amountFromUSD": "3.00",
"amountTo": "3",
"amountToUSD": "3.00",
"amountToReceive": "3",
"amountToReceiveUSD": "3.00",
"rate": "0",
"blockchainFeeFrom": "0",
"blockchainFeeFromUSD": "0",
"blockchainFeeToSource": "ADVANCED",
"blockchainFeeTo": "0.12",
"blockchainFeeToUSD": "0.12",
"serviceFee": "0.09",
"webhookUrl": "https://example.com/webhook-url",
"txId": null,
"createdAt": "2024-09-09T15:43:32.986Z",
"updatedAt": "2024-09-09T15:43:34.073Z"
}
}
```
### Webhook
При смене статуса операции будет отправлен вебхук на указанный URL
Пример тела вебхука
```json
{
"id": "31a3b86b-e350-4906-9d3e-cc2fca054821",
"organizationId": "1f07eb01-5fd8-4e05-89b5-bebcd1d1fc39",
"userId": null,
"type": "WITHDRAWAL",
"status": "PENDING",
"message": null,
"addressRiskLevel": "Low",
"addressFromId": "25a8de42-a359-47f1-bb82-bc9f6c20f1b9",
"addressFrom": "0xD65D24ABCd85165a243C33Cf8133ffBaaa98255D",
"addressTo": "0x22aECc7ff5b435E38be5457C8538256918783F67",
"amountFrom": "3",
"amountFromUSD": "3.00",
"amountTo": "3",
"amountToUSD": "3.00",
"amountToReceive": "3",
"amountToReceiveUSD": "3.00",
"rate": "0",
"blockchainFeeFrom": "0",
"blockchainFeeFromUSD": "0",
"blockchainFeeToSource": "ADVANCED",
"blockchainFeeTo": "0.12",
"blockchainFeeToUSD": "0.12",
"serviceFee": "0.09",
"webhookUrl": "https://example.com/webhook-url",
"txId": null,
"createdAt": "2024-09-09T15:43:32.986Z",
"updatedAt": "2024-09-09T15:43:34.073Z"
}
```
# Создание авто-вывода
Метод создает запрос на авто-вывод
На создание распространяются лимиты сумм:
* сумма должна быть **больше $20 в эквиваленте**
* сумма должна быть **в два раза больше комиссии сети конечной монеты/сети** (*см. метод получения доступных монет*)
## Описание параметров запроса
| Параметр | Тип | Обязательно | Описание |
| ------------- | --------- | ----------- | -------------------------------------------------- |
| `address` | `string` | yes | Адрес назначения |
| `currency` | `string` | yes | Монета к получению |
| `network` | `string` | yes | Сеть к получению |
| `amountFrom` | `string` | no | Сумма, которую хотите поменять и отправить |
| `amountTo` | `string` | no | Сумма, которую хотите получить |
| `feeInAmount` | `boolean` | no | Закладывать комиссию сети в сумму обмена |
| `webhookUrl` | `string` | no | URL для отправки уведомлений при изменении статуса |
> Обязательно надо отправить один из параметров: `amountFrom` или `amountTo`\
> При указании двух параметров приоритет будет иметь `amountFrom`
### Закладывать комиссию сети в сумму обмена
Указывая параметр `feeInAmount` в значении `true` с адреса будет списана **указанная сумма + комиссия сети**
* Если указывате `amountFrom` - возможно проскальзывание конечной суммы `amountTo` (может отличаться от указаной после запроса создания)
* Если указываете `amountTo` - будет заблокирована расчетная сумма списания с адреса + процент для покрытия страховки проскальзывания.\
После завершения обмена сумма будет откорректирована, до той, которая была израсходована для проведения обмена.\
*Возможно небольшое проскальзывание (≈ 0.1%) конечной суммы из-за наложения фильтров обмена на сумму к получению*
### Дополнительное подтверждение
При создании вывода из виджета приема оплат будет отправлен вебхук на URL указанный для потверждения вывода при создании виджета.
В теле вебхука будет указан пользователь запросивший вывод, запрошенная сумма, запрошенная монет и пересчет к выбранной для вывода монете.\
Вы можете подтвердить или отклонить вывод отправил соответствующее значение в запросе
Дополнительные поля в теле ответа:
| Имя | Описание |
| --------------------------------- | --------------------------------------------------------------------- |
| `approveUrl` | Урл отправки вебхука для подтверждения |
| `approveResult` | Данные о подтверждении |
| `approveResult.apiKey` | Данные об API-ключе |
| `approveResult.apiKey.public` | Публичная часть API-ключа, с которого пришло подтверждение |
| `approveResult.request` | Данные о запросе |
| `approveResult.request.ip` | IP адрес, с которого пришел запрос |
| `approveResult.request.userAgent` | User-Agent, с которого пришел запрос |
| `approveResult.approve` | Подтвержден или отклонен |
| `approveResult.time` | Время запроса |
| `requestedClientId` | Идентификатор пользователя в системе мерчанта, который запросил вывод |
| `requestedCurrency` | Запрошенная монета при создании вывода |
| `requestedAmount` | Запрошенная сумма при создании вывода |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/auto-withdrawals/create" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Поиск авто-вывода по ID
Получение данных авто-вывода по его ID
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/auto-withdrawals/get" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Дополнительное подтверждение вывода
При создании вывода из виджета приема оплат будет отправлен вебхук на URL указанный для подтверждения вывода при создании виджета.
В теле вебхука будет указан пользователь, запросивший вывод, запрошенная сумма, запрошенная монет и пересчет к выбранной для вывода монете.\
Вы можете подтвердить или отклонить вывод отправил соответствующее значение в запросе
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/auto-withdrawals/approve" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Мост
Кроссчейн мост - это обмен актива между сетями. Например у вас есть **USDT** в сети **Ethereum**, а вы хотите чтоб они были в сети **Tron**.
Для проведения обмена актива между сетями необходимо убедить что эта услуга доступна в выбранных вами сетях. Для этого запросите [список доступных монет](#95445bae-0a11-4a88-8c6c-84323c840424), найдите нужную вам монету, у нее будет список сетей `networks`, убедитесь что у нужных вам сетей флаг `allowCrosschainBridge` раняется `true`
Узнайте [допустимый лимит](#8c4e1ce5-7060-4204-99e7-efb5c1ed441e) для суммы операции. Обратите внимание, что суммы лимитов указаны в **USD**, курсы таких стейблкойнов как **USDT**, **BUSD** etc не значительно отличаются от курса **USD**, а если вы хотите обменять другую монету, то вам надо будет получить курс к **USD** чтоб убедиться что ваша сумма удовлетворяет указанным лимитам.
Запросите [превью комиссии](#fd67b275-4134-45fa-b55c-6b5e194c2bb2) чтобы получить `token`, его надо будет указать при [запросе создания операции](#ba429068-ddd5-4e4f-a296-0b9bb27da935) как `feeToken`.
Операция не исполняется сразу после запроса, необходимо подождать 1-3 минуты. Вы можете самостоятельно [узнать статус исполнения операции](#9ce98d0a-6568-43b2-aab5-7345cbe19a9d), а можете указать URL для получения [вебхука](#webhooks) в поле `webhookUrl` при создании.
Доступные статусы
| **Статус** | **Описание** |
| ---------- | ---------------------------- |
| CREATED | Запрос зарегистрирован |
| PENDING | Обрабатывается |
| ERROR | Ошибка в процессе исполнения |
| REJECTED | Запрос отклонен |
| PROCESSED | Успех |
## Схема взаимодействия с API
{% @mermaid/diagram content="sequenceDiagram
Merchant ->> Apollopayment: Запрос токена комиссии
Apollopayment ->> Merchant: Токен комиссии
Merchant ->> Apollopayment: Создание операции
Apollopayment ->> Merchant: Тело операции
```
Note over Apollopayment: Обработка операции
Apollopayment -->> Merchant: Вебхук с результатом операции" %}
```
# Получение лимиов для кроссчейн перевода
Метод позволяет получить лимиты для суммы блокчейн перевода
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/bridge/limit" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение информации о кроссчейн переводе
Метод позволяет получить информацию по ранее созданному кроссчейн переводу
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/bridge/get" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Формирование токена комисси
Метод позволяет получить токен комиссии для проведения кроссчейн перевода
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/bridge/fee-token" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание кроссчейн перевода
Метод позволяет создать кроссчейн перевод. Кроссчейн перевод позволяет перевести свои активы из одной сети в другую
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/bridge/create" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Обмены
Кроссчейн обмен - это обмен одного актива на другой.
Для проведения обмена актива необходимо убедить что эта услуга доступна в выбранных вами сетях. Для этого запросите [список доступных монет](#95445bae-0a11-4a88-8c6c-84323c840424), найдите нужную вам монету, у нее будет список сетей `networks`, убедитесь что у сети актива, который вы хотите обменять флаг `allowCrosschainSwapFrom` раняется `true`, а у сети актива, который хотите получить `allowCrosschainSwapTo` равняется `true`.
Например:\
У вас есть **ETH** в сети **Ethereum**, в списте доступных монет вы должны найти монету **ETH**, далее у нее в списке `networks` найти сеть `ethereum` у нее должно быть `"allowCrosschainSwapFrom": true`
```json
{
"success": true,
"response": [
...
{
"currency": "ETH",
...
"networks": [
...
{
"name": "ethereum",
...
"allowCrosschainSwapFrom": true,
...
}
...
]
},
...
]
}
```
Вы хотети обменять его в **USDT** в сети **Tron**, в списте доступных монет вы должны найти монету **USDT**, далее у нее в списке `networks` найти сеть `tron` у нее должно быть `"allowCrosschainSwapTo": true`
```json
{
"success": true,
"response": [
...
{
"currency": "USDT",
...
"networks": [
...
{
"name": "tron",
...
"allowCrosschainSwapTo": true,
...
}
...
]
},
...
]
}
```
Узнайте [допустимый лимит](#8a0a5146-91bc-46f3-9b23-4afe6cbeca07) для суммы операции. Обратите внимание, что суммы лимитов указаны в **USD**, курсы таких стейблкойнов как **USDT**, **BUSD** etc не значительно отличаются от курса **USD**, а если вы хотите обменять другую монету, то вам надо будет получить курс к **USD** чтоб убедиться что ваша сумма удовлетворяет указанным лимитам.
Запросите [превью комиссии](#a620e864-114e-4a45-9a44-3a0522a6d7dc) чтобы получить `token`, его надо будет указать при [запросе создания операции](#b017e259-d4e7-41f7-ad60-d536fac2f14f) как `feeToken`.
Операция не исполняется сразу после запроса, необходимо подождать 1-3 минуты. Вы можете самостоятельно [узнать статус исполнения операции](#1566d2f4-6218-4235-9d15-29c0de888e55), а можете указать URL для получения [вебхука](#webhooks) в поле `webhookUrl` при создании.
Доступные статусы
| **Статус** | **Описание** |
| ---------- | ---------------------------- |
| CREATED | Запрос зарегистрирован |
| PENDING | Обрабатывается |
| ERROR | Ошибка в процессе исполнения |
| REJECTED | Запрос отклонен |
| PROCESSED | Успех |
## Схема взаимодействия с API
{% @mermaid/diagram content="sequenceDiagram
Merchant ->> Apollopayment: Запрос токена комиссии
Apollopayment ->> Merchant: Токен комиссии
Merchant ->> Apollopayment: Создание операции
Apollopayment ->> Merchant: Тело операции
```
Note over Apollopayment: Обработка операции
Apollopayment -->> Merchant: Вебхук с результатом операции" %}
```
# Получение лимитов для кроссчейн обмена
Метод позволяет получить лимиты для суммы блокчейн обмена
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/swaps/limit" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение информации о кроссчейн обмене
Метод позволяет получить информацию по ранее созданному кроссчейн обмена
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/swaps/get" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Формирование токена комисси
Метод позволяет получить токен комиссии для проведения кроссчейн обмена
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/swaps/fee-token" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание кроссчейн обмена
Метод позволяет создать кроссчейн обмен. Кроссчейн обмен позволяет обменять один актив на другой
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/swaps/create" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Рекуррентные платежи
Алгоритм взаимодействия с методами из раздела "Рекурренты" и подключения подписчиков к сервису.
1. В личном кабинете, в разделе "Рекурренты" необходимо создать мерчанта
2. На страничке мерчанта будет доступен его идентификатор. Далее в методах API он должен передаваться в обязательном порядке в поле `merchantId`
3. Вызывается метод создания ссылки для привязки платежного метода (create-subscriber-billing-link)
4. Полученную в ответе ссылку необходимо отправить пользователю
5. Пользователь переходит по ссылке и с помощью подключения своего кошелька (web3) привязывает к сервису свой адрес с определенной сетью и токеном
6. После успешного создания платежной связки на указанный `webhookUrl` придет информация о созданной связке
Затем платежную связку можно использовать двумя способами:
* Создать подписку (назначить периодическое списание) - списание фиксированной суммы в указанный период
* Вызывать метод свободного списания - по запросу списать указанную сумму с адреса пользователя
## Схема взаимодействия с API
### Подключение пользователя
{% @mermaid/diagram content="sequenceDiagram
Client ->> Merchant: Запрос платежа
Merchant ->> Apollopayment: Запрос создание платежной связки
Apollopayment ->> Merchant: Ссылка для создания платежной связки
Merchant ->> Client: Ссылка для создания платежной связки
```
Note over Client: Переходит по ссылке
Note over Client: Привязывает свой кошелек
Apollopayment -->> Merchant: Вебхук с данными о платежной связке
Note over Merchant: Сохранить ID платежной связки для дальнейшего взаимодействия" %}
```
### Создание подписки
Автоматическое списание раз в период
{% @mermaid/diagram content="sequenceDiagram
Client ->> Merchant: Выбирает подписку
```
Note over Merchant: Получить доступные платежные связки пользователя
Note over Merchant: Выбрать связку с подходящей монетой/сетью, которую ранее создал пользователь
Merchant ->> Apollopayment: Создание подписки
Apollopayment ->> Merchant: Данные подписки
Merchant ->> Client: Уведомление об успешном создании подписки
Note over Apollopayment: Попытка оплаты с кошелька пользователя
Apollopayment -->> Merchant: Вебхук об изменении статуса подписки
Merchant ->> Client: Уведомление об успешной оплате или об ошибке при оплате" %}
```
### Свободный платеж
{% @mermaid/diagram content="sequenceDiagram
Merchant ->> Apollopayment: Создание платежа
Apollopayment ->> Merchant: Тело платежа
```
Note over Apollopayment: Попытка оплаты с кошелька пользователя
Apollopayment -->> Merchant: Вебхук об изменении статуса платежа" %}
```
# Создание платежной связки
Метод создает временную ссылку для подключения пользователя. Пользователь должен перейти по ссылку и дать разрешение на трату монет с его адреса. После этого вы получите вебхук со статусом и идентификатором платежной связки
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/create-subscriber-billing-link" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение платежной связки
Метод позволяет получить данные платежной связки
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/get-billing-link" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение платежных связок по пользователю
Метод позволяет получить список платежных связок по конкретному пользователю
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/get-billing-links-by-subscriber" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Отключение платежной связки
Метод позволяет отключить платежную связку. Вы больше не сможете подключать подписки и производить платежи по этой платежной связке
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/disable-subscriber-billing-link" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание подписки
Метод позволяет подключить подписку
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/create-subscription" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение подписки
Метод позволяет получить информацию о подписке
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/get-subscription" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Отключение подписки
Метод позволяет отключить ранее подключенную подписку
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/cancel-subscription" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание платежа
Метод позволяет создать платеж с произвольной суммой в монете, в которой был подключен адрес
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/recurrents/make-payment" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# KYT
# Проверка рисков транзакции
Метод позволяет проверить риски совершенной транзакции.
Данный запрос может выполняться несколько секунд. Не рекомендуется ставить timeout меньше 15 секунд.
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------- | -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| tx | Да | Строка | Хеш транзакции |
| currency | Да | Строка | Монета |
| network | Да | Строка | Сеть |
| outputAddress | Да | Строка | Адрес-получатель монет |
| direction | Да | Строка | Сторона для проверки рисков. Принимает значение sent или received.
Значение sent следует передавать, если была совершена транзакция вывода с вашего адреса: тогда будут проверены риски совершенной транзакции со стороны отправителя
Значение received следует передавать, если был совершен депозит на ваш адрес: тогда будут проверены риски получения монет на ваш адрес
|
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| -------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| level | Строка | Уровень риска |
| categories | Строка | Массив с разбиением риска по категориям |
| categories.level | Строка | Уровень риска в этой категории |
| categories.usdAmount | Число | Сумма в USD, которая связана с этой категорией риска |
| categories.category | Строка или null | Название категории |
| categories.service | Строка или null | Сервис, который связан с данной категорией риска |
| categories.exposure | Строка | DIRECT - прямая связь ("грязные" монеты были отправлены с адреса злоумышленника на адрес получателя напрямую)
INDIRECT - косвенная связь (полученные монеты когда-то были помечены рискованными, но прошли через цепочку адресов)
|
Параметр `level` может принимать следующие значения:
* `white` - нет риска
* `green` - минимальный риск
* `yellow` - средний риск
* `red` - высокий риск
* `black` - критический риск
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/kyt/check-transfer" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Проверка рисков вывода
Метод позволяет проверить риски вывода, перед его совершением.
Данный запрос может выполняться несколько секунд. Не рекомендуется ставить timeout меньше 15 секунд.
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | ---------------------- |
| currency | Да | Строка | Монета |
| network | Да | Строка | Сеть |
| address | Да | Строка | Адрес-получатель монет |
| amount | Да | Строка | Сумма вывода |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| -------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| level | Строка | Уровень риска |
| categories | Строка | Массив с разбиением риска по категориям |
| categories.level | Строка | Уровень риска в этой категории |
| categories.usdAmount | Число | Сумма в USD, которая связана с этой категорией риска |
| categories.category | Строка или null | Название категории |
| categories.service | Строка или null | Сервис, который связан с данной категорией риска |
| categories.exposure | Строка | DIRECT - прямая связь ("грязные" монеты были отправлены с адреса злоумышленника на адрес получателя напрямую)
INDIRECT - косвенная связь (полученные монеты когда-то были помечены рискованными, но прошли через цепочку адресов)
|
Параметр `level` может принимать следующие значения:
* `white` - нет риска
* `green` - минимальный риск
* `yellow` - средний риск
* `red` - высокий риск
* `black` - критический риск
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/kyt/check-withdrawal-address" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Проверка риска вывода на указанный адрес
Метод позволяет получить информацию об уровне риска вывода на адрес
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/kyt/withdrawal-address-screening" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Партнерское API
# Создание пользователя
Метод позволяет создать пользователя. Если пользователь с таким `email`, уже зарегистрирован - метод вернет соответствующую ошибку.
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | ------------------ |
| email | Да | Строка | Email пользователя |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| ------------ | --------------- | --------------------------------------------------------- |
| id | Строка | Идентификатор пользователя |
| email | Строка | Email пользователя |
| password | Строка | Сгенерированный пароль (показывается только при создании) |
| lastLoginAt | Строка или null | Дата последнего входа пользователя через веб интерфейс |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/create-user" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение пользователя
Метод позволяет получить пользователя
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | -------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| ------------ | --------------- | ---------------------------------------------------------------------------- |
| id | Строка | Идентификатор пользователя |
| email | Строка | Email пользователя |
| utm | Строка или null | Данные о utm-метке (если пользователь зарегистрировался через веб интерфейс) |
| createdAt | Строка | Дата регистрации пользователя |
| confirmedAt | Строка или null | Дата подтверждения почты пользователя |
| lastLoginAt | Строка | Дата последнего входа пользователя через веб интерфейс |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-user" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение всех пользователей
Метод позволяет получить всех пользователей
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | ------------------------------------------ |
| userId | Да | Строка | Идентификатор пользователя |
| limit | Да | Число | Лимит на количество пользователей в ответе |
| offset | Да | Число | Сдвиг (для пагинации) |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| ------------ | ------- | ------------------------------ |
| users | Массив | Массив объектов пользователя |
| total | Число | Общее количество пользователей |
**Объект пользователя:**
| **Параметр** | **Тип** | **Описание** |
| ------------ | --------------- | ---------------------------------------------------------------------------- |
| id | Строка | Идентификатор пользователя |
| email | Строка | Email пользователя |
| utm | Строка или null | Данные о utm-метке (если пользователь зарегистрировался через веб интерфейс) |
| createdAt | Строка | Дата регистрации пользователя |
| confirmedAt | Строка или null | Дата подтверждения почты пользователя |
| lastLoginAt | Строка | Дата последнего входа пользователя через веб интерфейс |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-users" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание организации
Метод позволяет создать организацию для пользователя
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/create-user-organization" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение списка организаций
Метод позволяет получить список организаций
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-user-organizations" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение авансовых балансов пользователя
Метод позволяет получить авансовые балансы пользователя
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | -------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| ----------------------------- | ------------ | --------------------------------------------------------- |
| advancedBalanceId | Строка | Идентификатор авансового баланса |
| currency | Строка | Монета баланса |
| balance | Строка | Баланс |
| availableCurrenciesForDeposit | Массив строк | Массив монет, доступных для пополнения авансового баланса |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-organization-advanced-balances" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Пополнение авансового баланса пользователя
Метод позволяет пополнить авансовый баланс пользователя (уточните доступность метода в поддержке)
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ----------------- | -------------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
| advancedBalanceId | Да | Строка | Идентификатор авансового баланса |
| amount | Да | Строка | Сумма пополнения. Число должно содержать не больше двух знаков после запятой (т.е. '5.25' подходит, а '5.529' - нет) |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/top-up-advanced-balance" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение общих тарифов
Метод позволяет получить все общие тарифы на сервисе. Если для пользователя не указан индивидуальный тариф, то при списании комиссии применяется общий тариф для всех пользователей
### Ответ:
В ответе представлен массив объектов тарифов:
| **Параметр** | **Тип** | **Описание** |
| ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | Строка | Идентификатор тарифа |
| action | Строка | Целевое действие по тарифу |
| amount | Строка | Доля комиссии от суммы операции (например, 0.01 означает комиссию в 1% от суммы операции) |
| minAmount | Строка или null | Минимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не менее чем minAmount)
null - без ограничений
|
| maxAmount | Строка или null | Максимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не более чем maxAmount)
null - без ограничений
|
Параметр `action` может принимать следующие значения:
| **Тариф** | **Описание** |
| --------------------- | -------------------------------------------- |
| INTERNAL\_TRANSFER | Внутренний перевод |
| ORDER\_DEPOSIT | Пополнение по ордеру |
| WALLET\_DEPOSIT | Пополнение кошелька |
| WALLET\_WITHDRAWAL | Вывод с кошелька |
| PAYOUT\_DEPOSIT | Пополнение выплатного баланса |
| PAYOUT\_WITHDRAWAL | Вывод с выплатного баланса |
| PERSONAL\_DEPOSIT | Пополнение персональных адресов |
| PERSONAL\_WITHDRAWAL | Вывод с персонального адреса |
| COLLECT\_WITHDRAWAL | Вывод с головного адреса |
| RECURRENT\_DEPOSIT | Пополнение рекурентного адреса (по подписке) |
| RECURRENT\_WITHDRAWAL | Вывод с рекурентного адреса |
| BRIDGE\_INTERNAL | Блокчейн мост |
| BRIDGE\_EXTERNAL | Блокчейн мост через API |
| EXCHANGE\_INTERNAL | Обмен |
| EXCHANGE\_AUTO | Обмен через API |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-default-tariffs" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание/обновление индивидуального тарифа
Метод позволяет создать или обновить индивидуальный тариф.
Если для данного `userId` и `action` уже существует тариф, то остальные указанные данные перезапишут этот тариф
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
| action | Да | Строка | Целевое действие по тарифу |
| amount | Да | Строка | Доля комиссии от суммы операции (например, 0.01 означает комиссию в 1% от суммы операции) |
| minAmount | Нет | Строка или null | Минимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не менее чем minAmount)
null - без ограничений
|
| maxAmount | Нет | Строка или null | Максимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не более чем maxAmount)
null - без ограничений
|
| comment | Нет | Строка или null | Пользовательский комментарий/заметка для тарифа |
Параметр `action` может принимать следующие значения:
| **Тариф** | **Описание** |
| --------------------- | -------------------------------------------- |
| INTERNAL\_TRANSFER | Внутренний перевод |
| ORDER\_DEPOSIT | Пополнение по ордеру |
| WALLET\_DEPOSIT | Пополнение кошелька |
| WALLET\_WITHDRAWAL | Вывод с кошелька |
| PAYOUT\_DEPOSIT | Пополнение выплатного баланса |
| PAYOUT\_WITHDRAWAL | Вывод с выплатного баланса |
| PERSONAL\_DEPOSIT | Пополнение персональных адресов |
| PERSONAL\_WITHDRAWAL | Вывод с персонального адреса |
| COLLECT\_WITHDRAWAL | Вывод с головного адреса |
| RECURRENT\_DEPOSIT | Пополнение рекурентного адреса (по подписке) |
| RECURRENT\_WITHDRAWAL | Вывод с рекурентного адреса |
| BRIDGE\_INTERNAL | Блокчейн мост |
| BRIDGE\_EXTERNAL | Блокчейн мост через API |
| EXCHANGE\_INTERNAL | Обмен |
| EXCHANGE\_AUTO | Обмен через API |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/set-organization-tariff" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение индвидуальных тарифов
Метод позволяет получить все индивидуальные тарифы. Если для пользователя указан индвидуальный тариф, то комиссия по указанной операции будет списываться по индивидуальному тарифу
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | -------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
### Ответ:
В ответе представлен массив объектов тарифов:
| **Параметр** | **Тип** | **Описание** |
| ----------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | Строка | Идентификатор тарифа |
| advancedBalanceId | Строка | Идентификатор авансового баланса пользователя |
| action | Строка | Целевое действие по тарифу |
| amount | Строка | Доля комиссии от суммы операции (например, 0.01 означает комиссию в 1% от суммы операции) |
| minAmount | Строка или null | Минимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не менее чем minAmount)
null - без ограничений
|
| minAmount | Строка или null | Максимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не более чем maxAmount)
null - без ограничений
|
| comment | Строка или null | Комментарий/заметка к тарифу |
| createdAt | Строка | Дата создания тарифа |
| updatedAt | Строка | Дата обновление тарифа |
Параметр `action` может принимать следующие значения:
| **Тариф** | **Описание** |
| --------------------- | -------------------------------------------- |
| INTERNAL\_TRANSFER | Внутренний перевод |
| ORDER\_DEPOSIT | Пополнение по ордеру |
| WALLET\_DEPOSIT | Пополнение кошелька |
| WALLET\_WITHDRAWAL | Вывод с кошелька |
| PAYOUT\_DEPOSIT | Пополнение выплатного баланса |
| PAYOUT\_WITHDRAWAL | Вывод с выплатного баланса |
| PERSONAL\_DEPOSIT | Пополнение персональных адресов |
| PERSONAL\_WITHDRAWAL | Вывод с персонального адреса |
| COLLECT\_WITHDRAWAL | Вывод с головного адреса |
| RECURRENT\_DEPOSIT | Пополнение рекурентного адреса (по подписке) |
| RECURRENT\_WITHDRAWAL | Вывод с рекурентного адреса |
| BRIDGE\_INTERNAL | Блокчейн мост |
| BRIDGE\_EXTERNAL | Блокчейн мост через API |
| EXCHANGE\_INTERNAL | Обмен |
| EXCHANGE\_AUTO | Обмен через API |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-organization-tariffs" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Создание API ключа
Метод позволяет создать API ключ для пользователя
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | -------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
| alias | Да | Строка | Название API ключа |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| ------------ | ------- | ----------------------- |
| id | Строка | Идентификатор API ключа |
| public | Строка | Публичный ключ |
| secret | Строка | Приватный ключ |
| alias | Строка | Название API ключа |
| createdAt | Строка | Дата создания ключа |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/create-api-keys" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение API ключей
Метод позволяет получить API ключи пользователя
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | ----------------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
| limit | Да | Число | Лимит на количество ключей в ответе |
| offset | Да | Число | Сдвиг (для пагинации) |
### Ответ:
| **Параметр** | **Тип** | **Описание** |
| ------------ | --------------- | ---------------------------------------- |
| keys | Массив объектов | Массив объектов API ключей |
| total | Число | Общей количество API ключей пользователя |
Параметр `keys` является массивом следующих объектов:
| **Параметр** | **Тип** | **Описание** |
| ------------ | ------- | ----------------------- |
| id | Строка | Идентификатор API ключа |
| public | Строка | Публичный ключ |
| secret | Строка | Часть приватного ключа |
| alias | Строка | Название API ключа |
| createdAt | Строка | Дата создания ключа |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/get-api-keys" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Удаление API ключа
Метод позволяет удалить API ключ пользователя
### Запрос:
| **Параметр** | **Обязателен** | **Тип** | **Описание** |
| ------------ | -------------- | ------- | -------------------------- |
| userId | Да | Строка | Идентификатор пользователя |
| keyId | Да | Строка | Идентификатор ключа |
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/partner/api/delete-api-keys" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Вебхуки
# Получение вебхука
Метод позволяет получить оригинальное тело вебхука.
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/webhooks/get" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Получение вебхука (расширенный)
Метод позволяет получить полную информацию по вебхуку.
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/webhooks/get-verbose" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
# Сиротские транзакции
В этом разделе представлены методы для получения и вывода сиротских транзакций.
**Сиротские транзакции** - это транзакции случайно отправленный на адрес, который\
был создан для другой монеты.
При обнаружении такой транзакции вы можете вывести полученные монеты на указанный адрес.\
У транзакций есть две стадии `DEPOSIT` и `WITHDRAWAL`. Вывод можно создать когда транзакция\
находиться на стадии `DEPOSIT` и в статусе `PROCESSED`, так же в теле транзакции есть параметр`canWithdrawal` на который можно ориентироваться при попытке вывода.
После вывода вам придет вебхук на указанный URL при запросе вывода (тело вебхука будет идентично телу вывода).\
Так же в теле сиротской транзакции появится исходящая транзакция в поле `outTransaction`
## Описание полей транзакции
| Поле | Описание |
| ---------------- | -------------------------------------------------------------------------------------- |
| `id` | Идентификатор транзакции в системе |
| `organizationId` | Идентификатор организации, которой принадлежит адрес |
| `orderId` | Идентификатор ордера, к которому был привязан адрес в момент обнаружения транзакции |
| `stage` | Текущая стадия транзакции. Доступно 2 значени: `DEPOSIT` и `WITHDRAWAL` |
| `status` | Статус текущей стадии тразакции |
| `message` | Сообщение при отклонении операции |
| `currency` | Монета транзакции |
| `network` | Сеть транзакции |
| `amount` | Сумма транзакции |
| `canWithdrawal` | Доступен ли вывод монет. (Доступно только на стадии `DEPOSIT` и в статусе `PROCESSED`) |
| `inTransaction` | Данные входящей транзакции |
| `outTransaction` | Данные исходящей транзакции если был запрошен вывод |
| `createdAt` | Дата обноружения транзакции |
***
Входящая тразакция:
| Поле | Описание |
| ------------- | ---------------------------------------- |
| `addressType` | Тип адреса, на который пришла транзакция |
| `addressId` | Идентификатор адреса в системе |
| `address` | Адрес в блокчейне |
| `txId` | Идентификатор транзакции в блокчейне |
| `amount` | Сумма транзакции |
| `status` | Статус транзакции |
| `createdAt` | Дата обнарущения транзакции |
Исходящая тразакция тразакция:
| Поле | Описание |
| -------------- | --------------------------------------------- |
| `address` | Адрес в блокчейне |
| `txId` | Идентификатор транзакции в блокчейне |
| `amount` | Сумма транзакции |
| `status` | Статус транзакции |
| `feeAmount` | Комиссия сети за транзакцию |
| `feeAmountUSD` | Комиссия сети за транзакцию в пересчете к USD |
| `withdrawalId` | Идентификатор вывода в системе |
| `createdAt` | Дата создания запроса на вывод |
***
Описание поля `addressType`:
| Значение | Описание |
| ----------- | ------------------------------- |
| `PAY_IN` | Адрес для платежей |
| `PAY_OUT` | Выплатной адрес |
| `BUSINESS` | Бизнек кошелек |
| `RECURRENT` | Адрес для рекуррентных платежей |
| `PERSONAL` | Персональный адрес |
Описание поля `status`:
| Значение | Описание |
| ----------- | --------------------------------- |
| `init` | Транзакция была создана в системе |
| `processed` | Успешно обработана |
| `error` | Ошибка в процессе обработки |
| `rejected` | Отклонена системой |
| `pending` | В процессе обработки |
***
Стадии транзакции:
| Стадия | Описание |
| ------------ | ---------------------------------------------------------------------------------- |
| `DEPOSIT` | Был получен депозит, для вывода необходимо дождаться перехода в статус `PROCESSED` |
| `WITHDRAWAL` | Был запрошен вывод полученных монет. |
***
Статусы транзакции:
| Статус | Описание |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PENDING` | Операция в процессе исполнения. Для стадии `DEPOSIT` - ожидание подтверждений входящей транзакции. Для стадии `WITHDRAWAL` - ожидание отправки транзакции в блокчейн |
| `PROCESSED` | Операция успешно исполнена. Для стадии `DEPOSIT` - входящая транзакция подтверждена. Для стадии `WITHDRAWAL` - транзакция успешно отправлена |
| `ERROR` | Ошибка при обработке операции |
| `REJECTED` | Операция отклонена |
## Токен комиссии
Для запроса токена комиссии необходимо указать идентификатор сиротской транзкции. Токен формируется для сумма, которая пришла на адрес в полном обьеме.
| Поле | Описание |
| ------------------ | -------------------------------------------------------------------------------------------------- |
| `currency` | Монета вывода |
| `network` | Сеть вывода |
| `feeSource` | Источник списания комиссии. Доступно 2 значения: `ADDRESS`, `ADVANCE` |
| `blockchainFee` | Комиссия сети в монете транзакции |
| `blockchainFeeUSD` | Комиссия сети в пересчете к USD |
| `serviceFee` | Комиссия сервиса |
| `serviceFeeUSD` | Комиссия сервиса в USD |
| `amount` | Сумма вывода |
| `amountTo` | Сумма, которую получит исходящий адрес после вывода (за вычетом комиссий при `feeSource: ADDRESS`) |
| `price` | Курс пересчета комиссии сети к USD |
| `token` | Токена вывода |
| `expiresAt` | Дата истечения токена |
***
Описание поля `feeSource`:
| Значение | Описание |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ADDRESS` | Источник списания комиссии сети за вывод - адрес. В данном случае `blockchainFee` будет взята из суммы вывода, поэтому поля `amount` и `amountTo` будут отличаться. |
| `ADVANCE` | Источник списания комиссии сети за вывод - авансовый баланс. В данном случае с авансового баланса будет списана `blockchainFeeUSD` + `blockchainFeeUSD`. |
# Получение транзакции
Получение информации о сиротской транзакции по ее ID
{% openapi src="/files/X1afO3tUwak9QdphOSjI" path="/api-gateway/orphan-deposits/get-deposit" method="post" %}
[openapi.json](https://2137468372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyOhoj9DD5mXL8tljp4Kp%2Fuploads%2Fgit-blob-c7502c7186093d67358d3eddf6a9a3abb7fd07f9%2Fopenapi.json?alt=media)
{% endopenapi %}
---
[Next Page](/llms-full.txt/1)