Завершение аутентификации покупателя
Запрос создает платежную транзакцию.
Запрос
POST /sites/{siteId}/payments/{paymentId}/complete
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: qpay-api.qiwi.kz
{
"threeDS": {
"pares": "eh233d908sdfsd"
}
}
Ответ
{
"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": "COMPLETED",
"changedDateTime": "2022-12-12T10:10:19+06:00"
},
"customer": {
},
"flags": ["BIND_PAYMENT_TOKEN"],
"paymentMethod": {
"type": "CARD",
"maskedPan": "444444******1049"
},
"createdToken": {
"token": "6628af1c-56d9-45e7-8a6a-c22d491d79fb",
"name": "token"
}
}
Параметры запроса
Path Parameters
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
siteId | string | Да | Строковый идентификатор сайта ТСП в QIWI Кассе. |
paymentId | string | Да | Уникальный идентификатор платежа в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных платежей ТСП в рамках одного siteId. |
Headers
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
Authorization | string | Да | Авторизационные данные. "Bearer [acсess-token]" |
Content-type | string | Да | Тип запроса. "application/json" |
Accept | string | Да | Тип запроса. "application/json" |
Request
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
threeDS | object | Нет | Данные аутентификации банковских карт по 3DS |
otp | object | Нет | Данные подтверждения одноразовым кодом |
ThreeDS
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
pares | string | Да | Результат аутентификации Покупателя, полученный после его возврата с ACS банка-эмитента |
Otp
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
code | string | Да | Код подтверждения - одноразовый пароль подтверждения транзакции плательщиком |
Response
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
paymentId | string | Да | Уникальный идентификатор платежа в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных платежей ТСП в рамках одного siteId. |
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 | Нет | Уникальный идентификатор клиента. Обязательный, если флаг BIND_PAYMENT_TOKEN |
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 | Да | Название токена |