API

Создать трейд на ввод средств (Pay In)

POST /api/v3/trades/pay_in

Параметры для генерации подписи

callback_url::cents::currency::customer::merchant::order_id::payment_type::reject_url::success_url

Параметры

merchant^requred

UUID мерчанта
order_id^requred

индентификатор, который позволяет идентифицировать трейд в системе мерчанта
cents^requred

Сумма в копейках. Например, сумма 3руб. 12коп. - это число 312
- Минимальное и максимальное значение можно узнать с помощью GET /api/v1/trades/data
currency^requred

Валюта трейда.
- Доступные значения: RUB, UZS, KZT, UAH
- Список доступных значений можно увидеть в GET /api/v1/trades/data
payment_type^requred

Выбранные тип перевода.
- Список доступных значений можно увидеть в GET /api/v1/trades/data
Возможные значения:
- any_bank - перевод на карту любого доступного банка
- sbp - СБП переводы по номеру телефона
- sber - перевод на карту Сбербанк
- ecom_sbp - перевод через платежную ссылку в системе сбп
- account_number - перевод по номеру счета в банке
- click, lemonpay, payme - перевод через разные платежные системы в UZS
customer

Уникальный индентификатор покупателя. В качестве значения может быть имя, email, любое id в системе мерчанта
callback_url

URL на веб-сайте Мерчанта, куда будет отправлен POST запрос о статусе выполнения вызываемых методов (настраивается в Личном кабинете):
- Если параметр передан – используется его значение.
- Если нет – значение в настройках личного кабинета
success_url

URl для рекдиректа с платежной страницы после подтверждения платежа
reject_url

URl для рекдиректа с платежной страницы после реджекта платежа

Пример запроса

POST /api/v3/trades/pay_in
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    order_id: "Order999",
    cents: 10000,
    currency: "RUB",
    payment_type: "sber",
    customer: "customer_email@example.com",
    callback_url: "https://api.merchant_sitem.com/callback_url"
    success_url: "https://api.merchant_sitem.com/success_url"
    reject_url: "https://api.merchant_sitem.com/reject_url"
}

Пример ответа

{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "0ebe12eb-740c-4635-8cbd-4f0c12002673"
    order_id: "external_merchant_id",
    state: "created",
    kind: 'pay_in',
    amount_cents: 20000, 
    amount_currency: "RUB", 
    rate: 101.23,
    crypto_amount_currency: "USDT", 
    crypto_amount_cents: 19756, 
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data: {
        name: "Елена Кузнецова", 
        number: "1111 1111 1111 1111",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },
    payment_bill_url: 'https://s3-server/bill_image'
}

Обьект payment_data

Обьект payment_data содержит все необходимые поля для совершения перевода. В зависимости от выбранного способа оплаты (поле payment_type) список полей может различаться.

Примеры значений payment_data:

Перевод по номеру карты:

    payment_data: {
        name: "Елена Кузнецова", 
        number: "1111 1111 1111 1111",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },

Перевод по номеру телефона (СБП):

    payment_data: {
        name: "Елена Кузнецова", 
        bank_name: "Альфа-Банк",
        number: "7 999 222 33 44",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },

Перевод по номеру счета:

    payment_data: {
        name: "ТРЕФИЛОВА ВИКТОРИЯ АЛЕКСАНДРОВНА",
        number: "40817810440103331111",
        bic: "044525225",
        payment_reason: "Перевод",
        bank_name: "SBERBANK",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    }

Создать трейд на вывод средств (Pay Out)

POST /api/v1/trades/pay_out

Параметры для генерации подписи

callback_url::cents::currency::customer::merchant::order_id::payment_data_name::payment_data_number::payment_type

Параметры

merchant^requred

UUID мерчанта
order_id^requred

индентификатор, который позволяет идентифицировать трейд в системе мерчанта
cents^requred

Сумма в копейках. Например, сумма 3руб. 12коп. - это число 312
- Минимальное и максимальное значение можно узнать с помощью GET /api/v1/trades/data
currency^requred

Валюта трейда.
- Доступные значения: "RUB", "UZS"
- Список доступных значений можно увидеть в GET /api/v1/trades/data
payment_type^requred

Выбранные тип перевода.
- Список доступных значений можно увидеть в GET /api/v1/trades/data
payment_data_number^requred

Номер карты на которую необходимо совершить перевод
payment_data_name

Фамилия Имя владельца карты
customer

Уникальный индентификатор покупателя. В качестве значения может быть имя, email, любое id в системе мерчанта
callback_url

URL на веб-сайте Мерчанта, куда будет отправлен POST запрос о статусе выполнения вызываемых методов (настраивается в Личном кабинете):
- Если параметр передан – используется его значение.
- Если нет – значение в настройках личного кабинета

Пример запроса

POST /api/v1/trades/pay_out
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    order_id: "123",
    cents: 10000,
    currency: "RUB",
    payment_type: "sber",
    payment_data_number: "1111 1111 1111 1111",
    payment_data_name: "Валентин Евтушенко",
    callback_url: "https://api.merchant_sitem.com/callback_url",
    customer: "customer_email@example.com",
}

Пример ответа

{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "0ebe12eb-740c-4635-8cbd-4f0c12002673"
    order_id: "external_merchant_id",
    state: "created",
    kind: 'pay_out',
    amount_cents: 20000, 
    amount_currency: "RUB", 
    rate: 101.23,
    crypto_amount_currency: "USDT", 
    crypto_amount_cents: 19756, 
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data_number: "1111 1111 1111 1111",
    payment_data_name: "Валентин Евтушенко",
    payment_bill_url: 'https://s3-server/bill_image',
    payment_page_link: null
}

Получить статус трейда

GET /api/v3/trades/{uuid}

Параметры для генерации подписи

merchant::uuid

Параметры

merchant^requred

UUID мерчанта
uuid^requred

UUID Трейда

Пример запроса

GET /api/v3/trades/3fa85f64-5717-4562-b3fc-2c963f66afa6
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Пример ответа

{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "0ebe12eb-740c-4635-8cbd-4f0c12002673"
    order_id: "external_merchant_id",
    state: "created",
    kind: 'pay_in',
    amount_cents: 20000, 
    amount_currency: "RUB", 
    rate: 101.23,
    crypto_amount_currency: "USDT", 
    crypto_amount_cents: 19756, 
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data: {
        name: "Елена Кузнецова", 
        number: "1111 1111 1111 1111",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },
    payment_bill_url: 'https://s3-server/bill_image'
}

Поиск трейдов

GET /api/v1/trades/search

Параметры для генерации подписи

merchant::order_id

Параметры

merchant^requred

UUID мерчанта
order_id

Внешний идентификатор трейда

Пример запроса

GET /api/v1/trades/search
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    order_id: "external_merchant_id"
}

Пример ответа

[{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    order_id: "external_merchant_id",
    state: "created",
    amount_cents: 20000, 
    amount_currency: "RUB", 
    rate: 101.23,
    crypto_amount_currency: "USDT", 
    crypto_amount_cents: 19756, 
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data_name: "Елена Кузнецова", 
    payment_data_number: "1111 1111 1111 1111",
    payment_bill_url: 'https://s3-server/bill_image',
    payment_page_link: 'https://payment-link.com'
}]

Загрузить доп информацию по трейду

POST /api/v1/trades/{uuid}/events

Параметры для генерации подписи

details::merchant::uuid

Параметры

merchant^requred

UUID мерчанта
uuid^requred

UUID Трейда
details

Дополнительная информация о трейде: номер карты кастомера, форма платежа итд. Все что может помочь трейдеру закрыть платеж
receipt

Файл с чеком или выпиской из банка

Пример запроса

GET /api/v1/trades/3fa85f64-5717-4562-b3fc-2c963f66afa6/events
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    details: "card number"
}

Пример ответа

blank

Справочная информация, для создания трейда

GET /api/v1/trades/data

Параметры для генерации подписи

kind::merchant

Параметры

merchant^requred

UUID мерчанта
kind^requred

Тип трейда - Доступные значения: "pay_in", "pay_out"

Пример запроса

GET /api/v1/trades/data
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    kind: "pay_in"
}

Пример ответа

[
    {
        currency: "RUB", 
        limit_min: 1000, 
        limit_max: 1000000, 
        payment_type: "sber"
    }, 
    {
        currency: "RUB", 
        limit_min: 1000, 
        limit_max: 1000000, 
        payment_type: "any_bank"
    }
]

Пожаловаться на трейд

POST /api/v3/trades/:uuid/complain

В случае, если кастомер не уверен что автоматика корректно обработает его трейд, то он может пожаловаться на него. В этом случае трейд перейдет в состоянии pending и не будет обработан автоматически. Трейдеру придется переводить его дальше только в ручном режиме.

Это возможно только для трейдов в состоянии created. Для того, что бы обажаловать трейд, который был завершен необходимо использовать метод POST /api/v1/trades/:uuid/dispute

Параметры для генерации подписи

merchant::uuid

Параметры

merchant^requred

UUID мерчанта
uuid^requred

UUID Трейда

Пример запроса

POST /api/v1/trades/3fa85f64-5717-4562-b3fc-2c963f66afa6/complain
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Пример ответа

{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "0ebe12eb-740c-4635-8cbd-4f0c12002673"
    order_id: "external_merchant_id",
    state: "created",
    kind: 'pay_in',
    amount_cents: 20000, 
    amount_currency: "RUB", 
    rate: 101.23,
    crypto_amount_currency: "USDT", 
    crypto_amount_cents: 19756, 
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data: {
        name: "Елена Кузнецова", 
        number: "1111 1111 1111 1111",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },
    payment_bill_url: 'https://s3-server/bill_image'
}

Открыть диспут по трейду

POST /api/v3/trades/:uuid/dispute

Если после завершении трейда, мерчант или кастомер не согласны с тем как он прошел, они могут открыть диспут. В этом случае трейд передет в состояние disputing и администрация платформы проверит оплату совместно с представитеялми мерчанта и трейдера

Это возможно только для трейдов в финальном состоянии: confirmed или rejected.

Параметры для генерации подписи

merchant::uuid

Параметры

merchant^requred

UUID мерчанта
uuid^requred

UUID Трейда

Пример запроса

POST /api/v1/trades/3fa85f64-5717-4562-b3fc-2c963f66afa6/dispute
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Пример ответа

{
    uuid: "6dae5b5b-a218-45d1-bd96-a0cf54aff6a6", 
    merchant: "0ebe12eb-740c-4635-8cbd-4f0c12002673"
    order_id: "external_merchant_id",
    state: "created",
    kind: 'pay_in',
    amount_cents: 20000, 
    amount_currency: "RUB", 
    rate: 101.23,
    crypto_amount_currency: "USDT", 
    crypto_amount_cents: 19756, 
    seller: "artisan", 
    buyer: "customer_uniq_id",
    payment_data: {
        name: "Елена Кузнецова", 
        number: "1111 1111 1111 1111",
        url: 'https://payment_url.example/6dae5b5b-a218-45d1-bd96-a0cf54aff6a6'
    },
    payment_bill_url: 'https://s3-server/bill_image'
}

Баланс мерчанта

GET /api/v2/merchant/balance

Параметры для генерации подписи

merchant

Параметры

merchant^requred

UUID мерчанта

Пример запроса

GET /api/v2/merchant/balance?merchant=3fa85f64-5717-4562-b3fc-2c963f66afa6

Пример ответа

В зависимости от настроек баланс может приходить в разном формате:

Раздельный крипто баланс:

{
  "pay_in": {
    "amount_cents": 1000000,
    "amount_currency": "USDT"
  },
  "pay_out": {
    "amount_cents": 10000000,
    "amount_currency": "USDT"
  }
}

Общий фиатный баланс:

{
  "amount_cents": 1000000,
  "amount_currency": "RUB"
}

Курс валюты

GET /api/v1/trades/rate

Параметры для генерации подписи

currency::kind::merchant

Параметры

currency^requred

Валюта сделки.
kind^requred

Тип трейда - Доступные значения: "pay_in", "pay_out"
merchant^requred

UUID мерчанта

Пример запроса

GET /api/v1/trades/rate
{
    merchant: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    currency: "RUB",
    kind: "pay_in"
}

Пример ответа

{
  "from": "RUB",
  "to": "USDT",
  "rate": 98.45
}