Перейти к основному содержимому

Бенефициары

Бенефициар — это ваш клиент, деньги которого лежат на номинальном счёте. Например, исполнитель на бирже фриланса или продавец на маркетплейсе. Деньги принадлежат ему, а распоряжаетесь ими вы как площадка.

Прежде чем проводить выплаты, зарегистрируйте бенефициара через API. После регистрации ему можно создать виртуальный счёт и включать его в сделки.

С чего начать​​

Работа с бенефициаром зависит от того, кто он. У физлиц, ИП и самозанятых есть этап проверки документов, у юрлиц его нет, и вызываются они по разным версиям API. Поэтому методы разнесены по типу бенефициара:

Общий формат вызова​​

Все методы раздела работают по протоколу JSONRPC. Точка входа для методов версии 2:

<Адреса слоёв>/v2/jsonrpc

Методы версии 3 вызываются по другому адресу:

<Адреса слоёв>/v3/jsonrpc

Передавайте заголовок Content-Type со значением application/json. Название метода указывайте в поле method, параметры — в объекте params.

Пример вызова:

curl -X POST "<Адреса слоёв>/v2/jsonrpc" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "0d6a26ea-84f0-4be2-9999-b46edc9b59b6",
    "jsonrpc": "2.0",
    "method": "get_beneficiary",
    "params": {
      "beneficiary_id": "981fee11-9969-4e80-9f5f-02af462cb51e"
    }
  }'

В описаниях методов показаны только тела запросов и ответов. Обёртка curl для всех методов одинаковая — меняются method и params.

Инфо

Параметр обязателен, если он помечен знаком ● в колонке «Обяз.». Входящие запросы проверяются на состав параметров и их типы. При несоответствии вернётся ошибка с описанием.

Важно

Все данные, полученные от сервиса, храните у себя на сервере. Не делайте прямых запросов от клиента — например, чтобы показать остаток на виртуальном счёте.

Особенности​​

  • Методы, которые возвращают списки без пагинации, отдают максимум 1000 элементов.
  • Для некоторых методов задана частота вызовов — не чаще одного запроса в 5 минут с одинаковыми параметрами. Запросы с разными фильтрами или по разным объектам можно отправлять независимо друг от друга.