Статус платежа
Получить информацию о платежной транзакции.
Запрос
GET /sites/{siteId}/payments/{paymentId}
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: qpay-api.qiwi.kz
Ответ
{
"paymentId": "342413",
"createdDateTime": "2022-12-12T10:10:19+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"status": {
"value": "CREATED",
"changedDateTime": "2022-12-12T10:10:19+06:00"
},
"customer": {
},
"flags": ["BIND_PAYMENT_TOKEN"],
"paymentMethod": {
"type": "TOKEN"
}
}
Параметры запроса
Path Parameters
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
siteId | string | Да | Строковый идентификатор сайта ТСП в QIWI Кассе. |
paymentId | string | Да | Уникальный идентификатор платежа в информационной системе ТСП, по которому ранее создан платеж ТСП в рамках одного siteId. |
Headers
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
Authorization | string | Да | Авторизационные данные. "Bearer [acсess-token]" |
Accept | string | Да | Тип запроса. "application/json" |
Response
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
paymentId | string | Да | Уникальный идентификатор в запросе платежа в информационной системе ТСП. |
createdDateTime | string | Да | Дата создания платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm). |
amount | object | Да | Информация о сумме операций |
capturedAmount | object | Да | Информация о сумме подтверждений. |
refundedAmount | object | Да | Информация о сумме возврата. |
paymentMethod | object | Да | Метод платежа |
status | object | Да | Статус платежа |
customer | object | Нет | Информация о клиенте |
flags | array of strings | Да | Дополнительные команды для API. "SALE" — одношаговый платеж. "BIND_PAYMENT_TOKEN" — флаг для выпуска платежного токена |
createdToken | object | Нет | Данные о созданном токене. |
Customer
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
account | string | Нет | Уникальный идентификатор клиента в системе ТСП. |
email | string | Нет | Email клиента в системе ТСП |
name | string | Нет | Наименование клиента |
phone | string | Нет | Номер мобильного телефона. Например: 77071112233 |
Status
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
value | string | Да | Строковое значение статуса. WAITING - ожидание платежа. DECLINED - ошибка в платеже. COMPLETED - успешность платежа. |
changedDateTime | string | Да | Дата изменения платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm). |
reason | string | Нет | Строковое описание ошибки платежа. |
CreatedToken
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
token | string | Да | Строковое значение токена. |
name | string | Да | Название токена |