Запрос статуса

Обновлено 27 августа 2025

Запрос статуса

Запрос

Header Parameters

RqUID

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Body

required

Тело запроса

rq_uid

string

required

Возможные значения: >= 32 characters и <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

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

rq_tm

string

required

Возможные значения: <= 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$

Дата/Время формирования запроса

order_id

string

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

ID заказа в АС ППРБ.Карты

tid

string

required

Возможные значения: <= 8 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,8}$

Уникальный идентификатор терминала (добавляется в API v2.0.0)

partner_order_number

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^.{1,36}$

Номер заказа в CRM Клиента (добавляется в API v2.0.0)

Ответы

200 OK

Schema

rq_uid

string

required

Возможные значения: >= 32 characters и <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

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

rq_tm

string

required

Возможные значения: <= 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$

Дата/Время формирования запроса

mid

string

Возможные значения: <= 15 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

Уникальный идентификатор Торговой точки

tid

string

Возможные значения: <= 8 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

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

id_qr

string

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

IdQR устройства или tid Уникальный идентификатор терминала для СБП, на котором сформирован заказ

order_id

string

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

ID заказа в АС ППРБ.Карты

order_state

string

Возможные значения: <= 20 characters, [PAID, CREATED, REVERSED, REFUNDED, REVOKED, DECLINED, EXPIRED, ON_PAYMENT]

Статус заказа

order_operation_params

object[]

Possible values: >= 1, <= 100000

Блок с перечнем операций, привязанных к данному заказу с детализацией по каждой операции

Array [

operation_id

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Идентификатор операции в АС ППРБ.Карты

operation_date_time

string

required

Возможные значения: <= 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$

Дата/Время регистрации заказа

rrn

string

required

Возможные значения: <= 12 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

RRN операции

operation_type

string

required

Возможные значения: <= 36 characters, [PAY, REVERSE, REFUND]

Тип операции

operation_sum

integer

required

Возможные значения: >= 0 и <= 999999999999999

Сумма операции в минимальных единицах Валюты

operation_currency

string

required

Возможные значения: <= 3 characters, Value must match regular expression ^[0-9]{3}$

Валюта операции, цифровой код по ISO 4217

auth_code

string

required

Возможные значения: <= 8 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Код авторизации

response_code

string

required

Возможные значения: <= 2 characters, Value must match regular expression ^[A-Za-z0-9_\\-]+$

Код выполнения запроса

response_desc

string

Возможные значения: <= 256 characters, Value must match regular expression ^.*$

Описание кода выполнения запроса

client_name

string

Возможные значения: <= 256 characters, Value must match regular expression ^.*$

Маскированное Имя Отчество Ф. плательщика

]

sbp_operation_params

object

Блок с перечнем параметров операции СБП. Передается только для операции оплаты через СБП (добавляется в API v3.0.0)

sbp_operation_id

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

Идентификатор операции в СБП

sbp_masked_payer_id

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^[A-Za-z0-9_\-\s\\+()/*]*$

Маскированный идентификатор плательщика

error_code

string

required

Возможные значения: <= 6 characters, Value must match regular expression ^[A-Za-z0-9_\\-]+$

Код ошибки

error_description

string

Возможные значения: <= 1024 characters, Value must match regular expression ^.*$

Описание ошибки выполнения запроса

{
  "rq_uid": "d0c5d5d03e074ad7ba2e2e248eef7e9c",
  "rq_tm": "2005-08-15T15:52:01Z",
  "mid": "123456789123456",
  "tid": "12345678",
  "id_qr": "20305",
  "order_id": "123456123456",
  "order_state": "PAID",
  "order_operation_params": [
    {
      "operation_id": "d1c3d5d93e094ad7ba3e5e248eef7e3c",
      "operation_date_time": "2005-08-15T15:52:01Z",
      "rrn": "123456123456",
      "operation_type": "REVERSE",
      "operation_sum": 123,
      "operation_currency": "643",
      "auth_code": "12345678",
      "response_code": "0",
      "response_desc": "Описание ошибки выполнения запроса",
      "client_name": "Иванов Иван И."
    }
  ],
  "sbp_operation_params": {
    "sbp_operation_id": "B105600390167601000004681598593B",
    "sbp_masked_payer_id": "*********6731"
  },
  "error_code": "123456",
  "error_description": "Описание ошибки выполнения запроса"
}

Client Error 400 Bad Request (Запрос не корректен)'

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Client Error 401 Unauthorized (Приложение не авторизовано, либо некорректное значение client-id)

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Forbidden

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Not Found

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Method Not Allowed (Ошибка API gateway, не найдены операци и, поддерживающие запрошенную http-команду)

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Too Many Requests (Превышен лимит отправляемых запросов)

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Internal Server Error (Внутренняя ошибка сервера

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

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

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Service Unavailable (Операция не доступна)

Gateway Timeout

Loading...