Отмена/возврат финансовой операции
/cancel
Отмена/возврат финансовой операции
Request
Header Parameters
Возможные значения: <= 32 characters
, Value must match regular expression ^[0-9a-fA-F]{32}$
- application/json
Body
required
Тело запроса
Возможные значения: >= 32 characters
и <= 32 characters
, Value must match regular expression ^[0-9a-fA-F]{32}$
Уникальный идентификатор запроса
Возможные значения: <= 20 characters
, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Дата/Время формирования запроса
Возможные значения: <= 36 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,36}$
ID заказа в АС ППРБ.Карты
Возможные значения: <= 36 characters
, [REFUND
, REVERSE
]
По умолчанию: REFUND
Тип операции (добавляется в API v2.0.0)
Возможные значения: <= 50 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,50}$
Идентификатор операции (оплаты/возврата) в АС ППРБ.Карты, которую требуется отменить
Возможные значения: <= 8 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,8}$
Код авторизации
Возможные значения: <= 36 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,36}$
IdQR устройства или tid Уникальный идентификатор терминала для СБП, на котором сформирован заказ
Возможные значения: <= 8 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,8}$
Уникальный идентификатор терминала (добавляется в API v2.0.0)
Возможные значения: >= 0
и <= 15 characters
, <= 999999999999999
Сумма отмены/возврата в минимальных единицах Валюты
Возможные значения: <= 3 characters
, Value must match regular expression ^[0-9]{3}$
Валюта операции, цифровой код по ISO 4217
Возможные значения: <= 13 characters
, Value must match regular expression ^007[0-9]{10}$
Идентификатор Получателя. Возможные значения: Номер мобильного телефона клиента физ. лица в формате '+79001234567' (добавляется в API v3.0.0)
Возможные значения: <= 140 characters
, Value must match regular expression ^.*$
Описание назначения платежа (добавляется в API v3.0.0)
200 OK
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: >= 32 characters
и <= 32 characters
, Value must match regular expression ^[0-9a-fA-F]{32}$
Уникальный идентификатор запроса
Возможные значения: <= 20 characters
, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Дата/Время формирования запроса
Возможные значения: <= 36 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
Идентификатор операции (оплаты/возврата) в АС ППРБ.Карты, которую требуется отменить
Возможные значения: <= 20 characters
, [PAID
, CREATED
, REVERSED
, REFUNDED
, REVOKED
, DECLINED
, EXPIRED
, ON_PAYMENT
]
Статус заказа
Возможные значения: <= 50 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
Уникальный идентификатор операции в ППРБ.Карты (прямой/возврата), которую необходимо отменить
Возможные значения: <= 20 characters
, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Дата/время операции отмены/возврата
Возможные значения: <= 36 characters
, [PAY
, REVERSE
, REFUND
]
Тип операции
Возможные значения: >= 0
и <= 999999999999999
Сумма операции в минимальных единицах Валюты
Возможные значения: <= 3 characters
, Value must match regular expression ^[0-9]{3}$
Валюта операции, цифровой код по ISO 4217
Возможные значения: <= 8 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
Код авторизации
Возможные значения: <= 12 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
RRN операции
Возможные значения: <= 8 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
Уникальный идентификатор терминала
Возможные значения: <= 36 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
IdQR устройства или tid Уникальный идентификатор терминала для СБП, на котором сформирован заказ
Возможные значения: <= 6 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$
Код выполнения запроса
Возможные значения: <= 1024 characters
, Value must match regular expression ^.*$
Описание ошибки выполнения запроса
sbp_operation_params object
Блок с перечнем параметров операции СБП. Передается только для операции оплаты через СБП (добавляется в API v3.0.0)
Возможные значения: <= 50 characters
, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$
Идентификатор операции в СБП
Возможные значения: <= 36 characters
, Value must match regular expression ^.*$
Наименование юр. лица торгово-сервисного предприятия
{
"rq_uid": "d0c5d5d03e074ad7ba2e2e248eef7e9c",
"rq_tm": "2005-08-15T15:52:01Z",
"order_id": "720ade472cdd400d93e7e6a4f94e38d2",
"order_status": "CREATED",
"operation_id": "123456789",
"operation_date_time": "2005-08-15T15:52:01Z",
"operation_type": "PAY",
"operation_sum": "123",
"operation_currency": "643",
"auth_code": "1234",
"rrn": "123123123",
"tid": "12345",
"id_qr": "123456789123456789",
"error_code": "000001",
"error_description": "Описание ошибки выполнения запроса",
"sbp_operation_params": {
"sbp_cancel_operation_id": "D105600390167601000004681598593B",
"sbp_merchant_name": "OOO \"Ромашка\""
}
}
Client Error 400 Bad Request (Запрос не корректен)'
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Client Error 401 Unauthorized (Приложение не авторизовано, либо некорректное значение client-id)
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Forbidden
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Not Found
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Method Not Allowed (Ошибка API gateway, не найдены операци и, поддерживающие запрошенную http-команду)
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Too Many Requests (Превышен лимит отправляемых запросов)
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Internal Server Error (Внутренняя ошибка сервера
- application/json
- Схема
- Пример из схемы
Schema
Возможные значения: Value must match regular expression ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^.*$
Описание ошибки
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
Дополнительная информация
Возможные значения: <= 254 characters
, Value must match regular expression ^.*$
вызываемый сервис
{
"httpCode": "400",
"message": "Error",
"moreInfo": "Error",
"path": "Error"
}
Service Unavailable (Операция не доступна)
Gateway Timeout