Confirming a Payment

Confirms payment. If two-step payment scenario is used, a merchant must send this request after successfull payment authorization. Only single successful payment confirmation is possible.

For scenarios using this method, please see “Partner Form Payment“

Request

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

Path Parameters

Parameter	Required	Type	Description
siteId	Yes	string	Merchant site identifier
paymentId	Yes	string	Unique payment identifier in the merchant’s system. The merchant receives this identifier in payment notification
captureId	Yes	string	Unique capture identifier in the merchant’s system

Headers

Header	Required	Type	Description
Authorization	Yes	string	API access key. Bearer [access-token]
Content-type	Yes	string	Request content. application/json
Accept	No	string	Response content. application/json

Body Parameters

Параметр	Обязательный	Тип	Описание
callbackUrl	No	string(256)	Notification URL
comment	No	string(255)	Service description for the client

Request Example

Confirming a Payment

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"
}

Response

See also HTTP error codes

Successful Response Parameters

Parameter	Required	Type	Description
paymentId	Yes	string	Payment identifier
createdDateTime	Yes	string	Payment creation date
amount	Yes	object	Operation amount
capturedAmount	Yes	object	Captured amount
refundedAmount	Yes	object	Refunded amount
paymentMethod	Yes	object	Payment method
status	Yes	string	Invoice status
customer	No	object	Customer data: account, email, phone
flags	No	array of strings	Additional API commands. Possible values: TEST, AFT
customFields	No	object	Additional information for the operation
requirements	No	object	Requirements for customer’s additional verification
createdToken	No	object	Payment token information

Error Parameters

Parameter	Required	Type	Description
serviceName	Yes	string	Name of the service that produced the error
errorCode	Yes	string	Error code
description	Yes	string	Error description for the merchant
userMessage	Yes	string	Error description for the customer
dateTime	Yes	string	Error date and time
traceId	Yes	string	Error Log unique ID
cause	No	object	Description for the field validation error

Response Examples

Successful responseResponse with error 4xxResponse with error 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"
}