Skip to main content
POST
Запросить возврат по транзакции

Авторизации

Authorization
string
header
обязательно

Токен доступа, полученный через POST /auth (client_id + client_secret). Действителен в течение 300 секунд.

Заголовки

X-Sub-Account
string

Reference субсчёта, в котором должна выполняться операция. Если заголовок не передан, операция выполняется в основном аккаунте; зарезервированное значение principal также указывает на основной аккаунт и равнозначно отсутствию заголовка. Принимается всеми эндпоинтами, кроме POST /auth и самих эндпоинтов /sub-accounts, которые всегда работают с основным аккаунтом.

Возможные ошибки: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Требует, чтобы у учётных данных был включён доступ к субсчетам (Настройки → Интеграция → Учётные данные API). По умолчанию он выключен и не заменяется никаким разрешением, даже FULL_ACCESS: без него ответ — 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Пример:

"loja-centro"

Параметры пути

id
string<uuid>
обязательно

ID платёжной транзакции, подлежащей возврату

Тело

application/json
reason
string

Причина возврата (необязательно, максимум 255 символов)

Maximum string length: 255
Пример:

"Cliente solicitou cancelamento"

Ответ

Возврат успешно запрошен. Статус PENDING до подтверждения через вебхук.

originalTransactionId
string<uuid>
обязательно

ID исходной транзакции, по которой выполняется возврат

pspProvider
string
обязательно

PSP-провайдер, обработавший возврат

pspRefundTransactionId
string
обязательно

ID транзакции возврата в PSP

status
enum<string>
обязательно

Статус, возвращённый PSP. PENDING означает, что возврат принят, но ещё не подтверждён — подтверждение приходит через вебхук refund_completed.

Доступные опции:
PENDING,
CONFIRMED,
ERROR
Пример:

"PENDING"