Completing Customer Authentication¶

Completes a payment authorization. After successful passing of a payment authorization, merchant sends the request with the corresponding parameters of authorization.

For scenarios using this method, please see “3D-Secure“

Request¶

POST /payin/v1/sites/{siteId}/payments/{paymentId}/complete

Path Parameters¶

Parameter	Required	Type	Description
siteId	Yes	string	Merchant site identifier
paymentId	Yes	string	Unique payment 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¶

Parameter	Required	Type	Description
threeDS	No	object	Data for bank card authentication via 3DS and 3DS2.0 protocols

Request Example¶

Completing Customer Authentication

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

{
  "threeDS": {
    "pares": "eJzVWFevo9iyfu9fMZrzaM0QjWHk3tIiGptgooE3cgabYMKvv3jvTurTc3XOfbkaJMuL...."
  }
}

Response¶

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
settlementAmount	No	object	Merchant’s settlement amount (when settlement currency differs from the currency of the payment authorization)
requirements	No	object	Requirements for customer’s additional verification
createdToken	No	object	Payment token information

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
settlementAmount	No	object	Merchant’s settlement amount (when settlement currency differs from the currency of the payment authorization)
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

{
  "paymentId" : "223E",
  "createdDateTime" : "2024-03-01T17:10:31.284+03:00",
  "amount" : {
    "currency" : "RUB",
    "value" : "200.00"
  },
  "capturedAmount" : {
    "currency" : "RUB",
    "value" : "0.00"
  },
  "refundedAmount" : {
    "currency" : "RUB",
    "value" : "0.00"
  },
  "paymentMethod" : {
    "type" : "CARD",
    "maskedPan" : "444444******1049"
  },
  "customer" : { },
  "deviceData" : { },
  "requirements" : {
    "threeDS" : {
      "pareq" : "eJyrrgUAAXUA+Q==",
      "acsUrl" : "https://test.paymentgate.ru/acs/auth/start.do"
    }
  },
  "status" : {
    "value" : "COMPLETED",
    "changedDateTime" : "2024-03-01T17:10:32.607+03:00"
  },
  "customFields" : { },
  "flags" : [ ]
}

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