Создание выплаты

Запрос

Необходим API Ключ с доступом к созданию выплат.

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

URL: https://api.fride.io/payoff/create
Метод отправки: POST

Заголовки запроса

Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}

Параметры запроса

Имя поля	Тип поля	Описание
service	string required	Метод выплаты
wallet_to	string required	Номер карты/телефона/кошелька для выплаты
amount	number format: double required	Сумма к выплате в рублях. (Если в сумме есть копейки, то отправляйте их с разделителем ".") Пример: 1000.28
subtract	int enum: [1, 2] default: 2	С кого списывать комиссию, с баланса или с суммы. По умолчанию комиссия снимается с суммы. Варианты: 1 - с баланса 2 - с суммы
order_id	string min: 1 max: 100	ID платежа в вашей системе Значение может содержать буквы (включая русские), цифры и специальные символы _-+[]|=*@, длиной от 1 до 100 символов
webhook_url	string format: uri	URL для отправки оповещения о изменении статуса выплаты. Если URL будет указан, то он будет приоритетнее URL который указан в личном кабинете.
payoff_data	object	Дополнительные данные выплаты (обязательно для СБП и Мобильной связи РФ)
payoff_data.sbp_bank	string	ID банка СБП из списка (обязательно для СБП)
payoff_data.mobile_ru_operator	string enum: [beeline, tele2, mts, megafon, yota]	Мобильный оператор РФ: beeline - Билайн tele2 - Tele2 mts - МТС megafon - Мегафон yota - Yota (обязательно для Мобильной связи РФ)

Ответ после запроса

Формат ответа: JSON

Схема успешного ответа:

Имя	Тип	Описание
id	string format: uuid	ID выплаты в нашей системе

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

Успех

{
    "id": "2fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Ошибка

{"error": "Не передан заголовок X-Api-Key"}

Возможные статусы ответа:

• 200: Успех
• 400: Ошибка валидации
• 401: Ошибка авторизации
• 403: Ошибка доступа
• 404: Ошибка поиска
• 429: Ограничение запросов
• 500: Внутренняя ошибка системы