B2C

Запрос возврата оплаты QR-кода или кассовой платёжной ссылки

Песочница
POST https://sandbox.alfabank.ru/api/sbp/jp/v1/refund
Пром
POST https://baas.alfabank.ru/api/sbp/jp/v1/refund
Scope

c2b-sbp

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
termNo
stringrequired

Номер терминала

payrrn
stringoptional

Референсный идентификатор запроса в системе Банка. Обязательное поле для операций по кассовой платёжной ссылке

qrcId
stringoptional

Идентификатор QR-кода. Для операций по кассовой платёжной ссылке не передавать

originalTrxId
stringoptional

Идентификатор исходной операции СБП. Обязательное поле при возврате по статическому QR-коду

originalTrxDT
stringoptional

Дата и время отменяемого платежа

amount
integerrequired

Сумма платежа в копейках

currency
stringrequired

Код валюты. Возможные значения:

  • •
    RUR - российский рубль
objectoptional

Данные запроса

notificationUrl
stringoptional

Полный URL для получения уведомления о финальном статусе оплаты QR-кода. Если параметр отсутствует, уведомление не производится

messageId
stringoptional

Уникальный идентификатор сообщения

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/sbp/jp/v1/refund' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "termNo": "30000600",
7  "payrrn": "000000020512",
8  "qrcId": "AD100074066RHM939FE9OQKR0TQ63HB6",
9  "originalTrxId": "A003610425360300b4ubOp6511E4F998",
10  "originalTrxDT": "2022-12-19T07:40:28Z",
11  "amount": 10000,
12  "currency": "RUR",
13  "queryData": {
14    "notificationUrl": "http://10.8.18.33:9017/sbp-payment/agent/status"
15  },
16  "messageId": "123Rersal_Num567"
17}'
Параметры ответа
Пример ответа 201 (Created)
1{
2  "termNo": "30000600",
3  "amount": 10000,
4  "currency": "RUR",
5  "trxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
6  "trxDT": "2022-12-19T07:40:28Z",
7  "payrrn": "000000020512",
8  "messageId": "123Rersal_Num567"
9}
BODY
атрибут
описание
termNo
stringrequired

Номер терминала

amount
integerrequired

Сумма платежа в копейках

currency
stringrequired

Код валюты. Принимает возможные значения:

  • •
    RUR - российский рубль
trxId
stringrequired

Уникальный идентификатор операции возврата в НСПК

trxDT
stringrequired

Дата и время платежа

payrrn
stringrequired

Референсный идентификатор запроса в системе Банка

messageId
stringoptional

Уникальный идентификатор сообщения

Пример ответа 201 (Created)
1{
2  "termNo": "30000600",
3  "amount": 10000,
4  "currency": "RUR",
5  "trxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
6  "trxDT": "2022-12-19T07:40:28Z",
7  "payrrn": "000000020512",
8  "messageId": "123Rersal_Num567"
9}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа