📥 Платёж
Создание PayIn
Создание новой заявки на приём платежа от клиента.
POST/api/v1/pay-in
Параметры запроса
| Параметр | Тип | Обязательный | Описание | Пример |
|---|---|---|---|---|
| bankId | number | Да | ID банка из /api/v1/banks | 1 |
| externalID | string | Да | Уникальный ID в вашей системе (1-64 символа, латиница, цифры, дефис, подчёркивание) | "test_merchant_id_2" |
| currencyId | number | Да | ID валюты из /api/v1/currencies | 1 |
| amount | string | Да | Сумма платежа (не более 2 знаков после запятой) | "1000" |
| method | string | Да | Метод платежа (CARD, SBP, ACCOUNT, NSPK и другие) | "CARD" |
| callbackURL | string | Нет | URL для получения webhook уведомлений | "https://example.com/callback" |
| description | string | Нет | Описание платежа | "Test payment" |
JSON ключи в теле запроса должны идти в алфавитном порядке при генерации подписи.
Пример запроса
json
{
"bankId": 1,
"externalID": "test_merchant_id_2",
"currencyId": 1,
"callbackURL": "https://example.com/callbacks/payment",
"description": "Test payment",
"amount": "1000",
"method": "CARD"
}Пример ответа
json
{
"success": true,
"data": {
"id": "uuid-here",
"externalID": "test_merchant_id_2",
"trackerId": "f5ef6b73-0952-4602-a306-82ef1f755f85",
"status": "PROCESSING",
"amount": "1000",
"commission": "1044.20",
"currency": "RUB",
"bank": "Озон Банк (Ozon)",
"method": "CARD",
"receiver": "2200154965960000",
"holder": "Иванов Иван Иванович",
"description": "Тестовая оплата",
"createdAt": "2025-01-01T12:00:00Z",
"updatedAt": "2025-01-01T12:00:00Z"
}
}Поля ответа
| Поле | Тип | Описание |
|---|---|---|
| id | string (UUID) | Уникальный ID заявки в системе Platix |
| externalID | string | Ваш уникальный ID заявки |
| trackerId | string | ID для отслеживания |
| status | string | Текущий статус заявки |
| amount | string | Сумма платежа |
| commission | string | Сумма с учётом комиссии |
| receiver | string | Реквизиты для оплаты (номер карты/телефон) |
| holder | string | Имя держателя карты/счёта |
| createdAt | string (ISO 8601) | Дата создания заявки |
| updatedAt | string (ISO 8601) | Дата последнего обновления |