Chargeback

Прежде чем начать

Ваши запросы к API аутентифицируются с помощью токена доступа. Любой запрос без действительного токена доступа вернёт ошибку. Подробнее в разделе Аутентификация.

Базовый URL

• 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 — запрашивает анализ 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",
  "documents": [
    { "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
  ]
}

Поле	Тип	Обязательное	Описание
datetime	string	да	Дата и время запроса chargeback в формате ISO 8601.
requestor	object	да	Информация о заявителе.
requestor.key	string	да	Тип ключа идентификации заявителя (например, cpf).
requestor.value	string	да	Значение ключа идентификации заявителя.
name	string	да	Имя заявителя.
reason	string	да	Причина запроса chargeback.
observation	string	нет	Общие замечания по запросу.
documents	array	нет	Документы, относящиеся к chargeback. До 3 элементов, каждый в кодировке Base64 — только PDF.
documents[].label	string	да (для каждого элемента)	Имя файла или описание.
documents[].data	string	да (для каждого элемента)	PDF-файл в кодировке Base64.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}

Поле	Описание
id	Сгенерированный идентификатор chargeback.

Об ответах с ошибками см. в разделе Ошибки — Создание транзакции.

Получение статуса анализа chargeback

GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — проверяет статус конкретного chargeback.

Заголовки

Заголовок	Значение
Authorization	Bearer {token} — действительный токен доступа.

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "status": "waiting"
}

Поле	Описание
id	Идентификатор chargeback.
status	Текущий статус chargeback.

См. Перечисления — Результат chargeback для всех возможных статусов. Для оптимизации производительности реализуйте Webhook вместо опроса (polling) этого эндпоинта.