Chargeback
Прежде чем начать
Ваши запросы к API аутентифицируются с помощью токена доступа. Любой запрос без действительного токена доступа вернёт ошибку. Подробнее в разделе Аутентификация.
- UAT:
https://transactions.transactional.uat.unico.app/api/public/v1 - Продакшн:
https://transactions.transactional.unico.app/api/public/v1
Уведомление о chargeback
POST /credit/transactions/{transaction_id}/chargeback — сообщает Unico, что по указанной транзакции получен chargeback.
Этот эндпоинт только сообщает о chargeback. Он не открывает анализ chargeback и не активирует гарантию ответственности. Чтобы Unico проанализировала chargeback, откройте оспаривание транзакции на портале.
| Заголовок | Значение |
|---|---|
Authorization | Bearer {token} — действительный токен доступа. |
{
"datetime": "2023-01-05T03:00:00.000Z",
"requestor": { "key": "cpf", "value": "USER_CPF" },
"name": "USER_NAME",
"reason": "REQUEST_REASON",
"observation": "GENERAL_OBSERVATIONS"
}
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
datetime | string | да | Дата и время получения chargeback в формате ISO 8601. |
requestor | object | да | Информация о заявителе. |
requestor.key | string | да | Тип ключа идентификации заявителя (например, cpf). |
requestor.value | string | да | Значение ключа идентификации заявителя. |
name | string | да | Имя заявителя. |
reason | string | да | Причина chargeback. |
observation | string | нет | Общие замечания по chargeback. |
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}
| Поле | Описание |
|---|---|
id | Идентификатор chargeback. |
У транзакции может быть только один chargeback. Повторное уведомление по транзакции, у которой он уже есть, возвращает 200 OK с id существующего chargeback и не изменяет его.
Об ответах с ошибками см. в разделе Ошибки — Создание транзакции.
Получение статуса chargeback
GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — проверяет статус конкретного chargeback.
| Заголовок | Значение |
|---|---|
Authorization | Bearer {token} — действительный токен доступа. |
{
"id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"status": "waiting"
}
| Поле | Описание |
|---|---|
id | Идентификатор chargeback. |
status | Текущий статус chargeback. |
Chargeback, о котором было сообщено, остаётся в статусе waiting. Если транзакция оспорена на портале, тот же id отражает ход и результат анализа. См. Перечисления — Результат chargeback для всех возможных статусов. Для оптимизации производительности реализуйте Webhook вместо опроса (polling) этого эндпоинта.