Подтверждение платежа¶

Запрос подтверждает платёж после холдирования средств. Если используется двухшаговый сценарий, мерчанту необходимо отправить этот запрос после авторизации платежа. Возможно только однократное успешное подтверждение платежа.

Сценарий, в котором используется метод подтверждения платежа, см. в статье «Оплата с формы партнёра»

Запрос¶

PUT /payin/v1/sites/{siteId}/payments/{paymentId}/captures/{captureId}

Параметры строки запроса¶

Параметр	Обязательный	Тип	Описание
siteId	Да	string	Строковый идентификатор сайта ТСП в QIWI Кассе
paymentId	Да	string	Идентификатор платежа в информационной системе ТСП. Этот идентификатор ТСП получает в уведомлении о платеже
captureId	Да	string	Уникальный идентификатор подтверждения в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных подтверждений для этого `siteId`

Заголовки¶

Заголовок	Обязательный	Тип	Описание
Authorization	Да	string	Авторизационные данные. `Bearer [access-token]`
Content-type	Да	string	Тип запроса. `application/json`
Accept	Нет	string	Тип ответа. `application/json`

Параметры тела запроса¶

Параметр	Обязательный	Тип	Описание
callbackUrl	Нет	string(256)	URL отправки уведомления по операции
comment	Нет	string(255)	Описание услуги, которую получает клиент

Пример запроса¶

Подтверждение платежа

PUT /partner/payin/v1/sites/test-01/payments/1811/captures/bxwd8096 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

{
  "callbackUrl": "https://example.com/callbacks",
  "comment": "Example capture"
}

Ответ¶

См. также список общих HTTP кодов ошибок

Поля успешного ответа¶

Параметр	Обязательный	Тип	Описание
paymentId	Да	string	Идентификатор платежа. Такой же как в запросе
createdDateTime	Да	string	Дата создания счёта
amount	Да	object	Сумма операции
capturedAmount	Да	object	Сумма подтверждений
refundedAmount	Да	object	Сумма возвратов
paymentMethod	Да	object	Метод платежа
status	Да	object	Статус платежа
customer	Нет	object	Данные покупателя
flags	Нет	array of strings	Дополнительные команды для API, указанные в исходном платеже
customFields	Нет	object	Поля с произвольной информацией, дополняющей данные по операции
requirements	Нет	object	Требования для дополнительной аутентификации клиента
createdToken	Нет	object	Данные выпущенного платёжного токена

Поля ответа с ошибкой¶

Параметр	Обязательный	Тип	Описание
serviceName	Да	string	Имя сервиса, сгенерировавшего ошибку
errorCode	Да	string	Код ошибки
description	Да	string	Описание ошибки для ТСП
userMessage	Да	string	Описание ошибки для отображения покупателю
dateTime	Да	string	Дата и время ошибки
traceId	Да	string	Уникальный ID лога ошибки
cause	Нет	object	Описание ошибки валидации конкретного поля

Примеры ответов¶

Успешный ответОтвет с ошибкой 4xxОтвет с ошибкой 5xx

{
  "captureId": "bxwd8096",
  "createdDateTime": "2024-03-20T16:29:58.96+03:00",
  "amount": {
    "currency": "RUB",
    "value": "6.77"
  },
  "status": {
    "value": "COMPLETED",
    "changedDateTime": "2024-03-20T16:29:58.963+03:00"
  }
}

{
  "serviceName":"payin-core",
  "errorCode":"validation.error",
  "description":"Validation error",
  "userMessage":"Validation error",
  "dateTime" : "2024-03-13T16:49:59.166+03:00",
  "traceId" : "fd0e2a08c63ace83"
}

{
  "serviceName":"payin-core",
  "errorCode":"internal.error",
  "userMessage":"Internal error",
  "description":"Internal error",
  "traceId":"3fb3420ee1795dcf",
  "dateTime":"2020-02-12T21:28:01.813+03:00"
}