Данный метод позволяет получить:
Важно!
Данные метод имеет ограничения по кол-ву вызовов от имени одного партнера (throttling), не более 1 rps, при превышении нагрузки, запрос будет отклонен с соответствующей ошибкой HTTP status code - 429
Поэтому не рекомендуется использования метода в бизнес логике приложения, для запроса статуса оплаты, необходимо ожидать callback с идентификатором платежа и использовать метода запроса статуса по конкретной оплате - Информация о платеже
GET |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| Request-Id | guid | да | Идентификатор конкретного запроса |
Requestor-Name | string | нет | Наименование сервиса.
|
| Requestor-Type | string | нет | Тип витрины.
|
| Requestor-Version | string | нет | Версия виджета/sdk |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
sessionId | string[32] | да | Идентификатор платежной сессии |
Content-Type: application/json; charset=utf-8 |
Поле | Тип | Описание | |
|---|---|---|---|
sessionId | string | да | Идентификатор сессии |
| status | statusEnum | да | Статус сессии:
|
| reason | string(enum) | нет | Причина завершения сессии, заполняется при status=close
|
| createdAt | dateTime | да | Дата и время создания сессии |
| requestedCloseAt | dateTime | да | Дата и время запланированного окончания сессии |
| closedAt | dateTime | да | Дата и время фактического окончания сессии |
| payments | object | да | Проведенные по сессии платежи |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
id | int64 | да | Идентификатор платежа |
| createdAt | dateTime | да | Дата и время создания записи в сервисе |
| status | statusEnum | да | Статус платежа |
| serviceId | int64 | нет | Идентификатор сервиса |
| amount | amount | да | Сумма платежа |
| currency | string | да | Валюта |
| description | string | нет | Описание |
| error | object | нет | Набор полей с описание ошибки |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
code | string | да | Код ошибки |
| message | string | да | Описание ошибки |
| isFatal | boolean | да | Признак фатальности ошибки |
GET https://sandbox.pay.mts.ru/private/v1/payments/sessions/8b3c3f9b5a934a1780c93da5cc495b27/info HTTP/1.1 |
Content-Type: application/json; charset=utf-8 |
{
"sessionId": "8b3c3f9b5a934a1780c93da5cc495b27",
"status": "close",
"reason": "closeByTimeout",
"createdAt": "2020-11-18T19:06:16.778Z",
"requestedCloseAt": "2020-11-18T19:16:16.778Z",
"closedAt": "2020-11-18T19:16:16.778Z",
"payments": [
{
"createdAt": "2021-12-04T12:39:03.103Z",
"id": 23489,
"status": "rejected",
"serviceId": 1150,
"currency": "643",
"amount": 10,
"description": "Оплата",
"error": {
"code": "02005009",
"message": "Processing: Insufficient funds",
"isFatal": false
}
},
{
"createdAt": "2021-12-04T13:20:01.103Z",
"id": 23490,
"status": "executed",
"serviceId": 1150,
"currency": "643",
"amount": 10,
"description": "Оплата"
}
]
}
code | http-code | message | userMessage |
|---|---|---|---|
00299998 | 400 | Validation error | Не пройдена валидация данных |
00299999 | 500 | An unexpected error has occurred | Непредвиденная ошибка |
| 00200001 | 401 | Session {0} not found | Сессия не найдена |
| 00200002 | 401 | Certificate is not valid | Сертификат не прошел проверку |
| 01000002 | 460 | Inactive merchant | Мерчант не активный |