Выплаты
Бразилия (BRL)
Как создавать выплаты в BRL
Выплаты позволяют отправлять средства с вашего мерчант-счёта на банковские карты, номера телефонов и другие платёжные реквизиты пользователей.
Перед тем как начать
Как авторизовывать запросы
Перед запросами убедитесь, что на вашем мерчант-счёте достаточно средств для выплаты.
Создание выплаты
Отправьте POST-запрос для создания новой выплаты:
POST /v1/payoutsПример запроса
curl -X POST "https://api.panel.valutix.kz/v1/payouts" \
-H "Content-Type: application/json" \
-H "X-Api-Token: YOUR_API_TOKEN" \
-d '{
"amount": 1000.50,
"currency": "RUB",
"paymentType": "EMAIL",
"account": {
"name": "Ivan Ivanov",
"requisites": "mail@mail.com",
"userId": "user_12345"
},
"note": "Выплата по заказу №1234"
}'Параметры запроса
Основные параметры
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| amount | number | ✅ Да | Сумма выплаты |
| currency | string | ✅ Да | Код валюты |
| paymentType | string | ✅ Да | Тип платежа |
| account | object | ✅ Да | Реквизиты получателя |
| note | string | ❌ Нет | Заметка к выплате |
Объект account
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | string | ✅ Да | Имя получателя |
| requisites | string | ✅ Да | Реквизиты счёта (номер карты / телефона — зависит от типа платежа) |
| userId | string | ✅ Да | ID пользователя в вашей системе |
Поддерживаемые валюты
| Значение | Описание |
|---|---|
| BRL | Бразильский реал |
Типы платежей
| Значение | Описание | Пример |
|---|---|---|
| RANDOM | Случайный PIX-ключ | super-uuid-secret |
| SIM | Перевод на номер телефона | +551223544654655 |
| Перевод на email | email@example.com | |
| CNPJ | Перевод на CNPJ (Бразилия) | 1234567800200 |
| CPF | Перевод на CPF (Бразилия) | 12345678900 |
Пример успешного ответа
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"merchantId": "123e4567-e89b-12d3-a456-426614174000",
"amount": "1000.50",
"account": {
"name": "Ivan Ivanov",
"requisites": "4111111111111111",
"userId": "user_12345"
},
"status": "CREATED",
"type": "EMAIL",
"requisites": {},
"statusMessage": null,
"metadata": null,
"createdAt": "2023-03-21T12:34:56Z",
"updatedAt": "2023-03-21T12:34:56Z",
"completedAt": null
}Поля ответа
| Поле | Тип | Описание |
|---|---|---|
| id | string | UUID выплаты |
| merchantId | string | UUID вашего мерчанта |
| amount | string | Сумма выплаты |
| account | object | Реквизиты получателя |
| status | string | Текущий статус выплаты |
| type | string | Тип платежа |
| requisites | object | Дополнительные реквизиты |
| statusMessage | string / null | Сообщение статуса (если есть) |
| metadata | object / null | Дополнительные метаданные |
| createdAt | string | Время создания |
| updatedAt | string | Время последнего обновления |
| completedAt | string / null | Время завершения |
Статусы выплат
| Статус | Описание |
|---|---|
| CREATED | Выплата создана |
| PENDING | Выплата обрабатывается |
| COMPLETED | Выплата успешно завершена |
| FAILED | Ошибка выплаты |
| CANCELED | Выплата отменена |
| EXPIRED | Срок действия выплаты истёк |
Проверка статуса выплаты
Чтобы узнать текущий статус выплаты, отправьте GET-запрос:
GET /v1/payouts/{payoutId}Пример запроса
curl -X GET "https://api.panel.valutix.kz/v1/payouts/123e4567-e89b-12d3-a456-426614174000" \
-H "X-Api-Token: YOUR_API_TOKEN"Webhook'ов для выплат нет. Чтобы получать обновления статуса, периодически опрашивайте статус по ID (например, каждые 30 минут).
Рекомендации
- Всегда проверяйте баланс мерчанта перед созданием выплат - Сохраняйте
idвыплаты из ответа для отслеживания статуса - Реализуйте периодический опрос статуса для обновлений - Обрабатывайте все возможные значения статусов в своей интеграции