B2C

Получение статуса возврата по операции СБП

Пром GET https://baas.alfabank.ru/api/sbp/jp/v1/refund/status

Песочница GET https://sandbox.alfabank.ru/api/sbp/jp/v1/refund/status

Scope

c2b-sbp

Параметры запроса

HEADER
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Client Credentials Flow

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

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

Идентификатор терминала

payrrn
stringoptional

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

originalTrxId
stringoptional

Уникальный идентификатор платежа в НСПК. Обязательно, если не передан параметр payrrn

trxId
stringoptional

Уникальный идентификатор операции возврата в НСПК. Обязательно, если не передан параметр messageId

messageId
stringoptional

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/sbp/jp/v1/refund/status?termNo=90080567&payrrn=012345678912&originalTrxId=X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2&trxId=1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2&messageId=123Rersal_Num567 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Параметры ответа

Пример ответа 200 (OK)
{
  "termNo": "90080567",
  "amount": 10000,
  "originalQrcId": "AS1000670LSS7DN18SJQDNP4B05KLJL2",
  "originalTrxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
  "payerId": "*********1234",
  "status": "ACWP",
  "trxDT": "2020-07-28T11:45:31Z",
  "trxId": "1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2"
}
termNo
stringrequired

Идентификатор терминала

amount
integerrequired

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

originalQrcId
stringrequired

Идентификатор зарегистрированной платежной ссылки СБП, по которому была выполнена исходная операция СБП

originalTrxId
stringrequired

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

payerId
stringrequired

Маскированный номер телефона клиента-получателя (плательщика в исходной операции C2B, кому делается возврат)

status
stringrequired

Статус операции возврата в НСПК. Принимает возможные значения:

  • NTST - Операции по QR-коду не существует (NOT_STARTED);
  • RCVD - Операция в обработке (RECEIVED);
  • ACWP - Операция завершена успешно (ACCEPTED);
  • RJCT - Операция отклонена (REJECTED)
trxId
stringrequired

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

trxDT
date-timerequired

Дата и время выполнения возврата

messageId
stringoptional

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

batchId
stringoptional

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

url
stringoptional

Полный URL получения уведомления для торгово-сервисного предприятия (ТСП)

Пример ответа 200 (OK)
{
  "termNo": "90080567",
  "amount": 10000,
  "originalQrcId": "AS1000670LSS7DN18SJQDNP4B05KLJL2",
  "originalTrxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
  "payerId": "*********1234",
  "status": "ACWP",
  "trxDT": "2020-07-28T11:45:31Z",
  "trxId": "1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Пример ответа 429 (Too Many Requests)
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

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

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.