B2C

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

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

c2b-sbp

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

application/json

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

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

payrrn
stringoptional

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

originalTrxId
stringoptional

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

trxId
stringoptional

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

messageId
stringoptional

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

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/refund/status?termNo={termNo}&payrrn={payrrn}&originalTrxId={originalTrxId}&trxId={trxId}&messageId={messageId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "termNo": "30000600",
3  "amount": 12300,
4  "originalQrcId": "AS1000670LSS7DN18SJQDNP4B05KLJL2",
5  "originalTrxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
6  "payerId": "*********5526",
7  "status": "ACWP",
8  "trxId": "1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2",
9  "trxDT": "2020-07-28T11:45:31Z",
10  "messageId": "123Rersal_Num567",
11  "batchId": "1738",
12  "url": "http://10.8.18.33:9017/sbp-payment/agent/status"
13}
BODY
атрибут
описание
termNo
stringrequired

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

amount
integerrequired

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

originalQrcId
stringrequired

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

originalTrxId
stringrequired

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

payerId
stringrequired

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

status
stringrequired

Статус оплаты QR-кода в НСПК. Принимает возможные значения:

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

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

trxDT
stringrequired

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

messageId
stringoptional

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

batchId
stringoptional

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

url
stringoptional

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

Пример ответа 200 (OK)
1{
2  "termNo": "30000600",
3  "amount": 12300,
4  "originalQrcId": "AS1000670LSS7DN18SJQDNP4B05KLJL2",
5  "originalTrxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
6  "payerId": "*********5526",
7  "status": "ACWP",
8  "trxId": "1SA32XD5F6G78J9K0HC4S5C6D4V7D5J2",
9  "trxDT": "2020-07-28T11:45:31Z",
10  "messageId": "123Rersal_Num567",
11  "batchId": "1738",
12  "url": "http://10.8.18.33:9017/sbp-payment/agent/status"
13}
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}
Нет тела ответа