confirmInvoice method

Description

Use this request to confirm debiting money from a user's account in an external payment system when using an SMS message to send an invoice.

  1. The external payment system sends the user an SMS message with a code.
  2. The user enters the code from the SMS on the store's site.
  3. The merchant sends a payment confirmation request (confirmInvoice) with the code entered by the user (the code is passed in the clientNumberCode parameter). Only send this request if the user is confirming the payment on the site, not in an SMS response message
Restriction. 

To process requests for payment using SMS messages, you must use the HTTP protocol.

Address for calling the confirmInvoice operation

https://server:port/webservice/mws/api/confirmInvoice

Input parameters

Parameter

Type

Description

clientOrderId

ClientTransactionNumber

Unique transaction ID. Provides protection from repeating operations by mistake. Recommended values: linearly increasing decimal integers.

shopId

xs:string

Merchant ID issued by Yandex.Checkout.

invoiceId

xs:string

Order ID in Yandex.Checkout. Must be the same as the value of the orderId attribute that was received in the response to the createInvoice request to create a payment.

clientNumberCode

xs:string

Payment confirmation code entered by the user.

Output parameters that are shared for all types of financial transaction requests.

Note. 

The store must provide a way to enter the code from the SMS and pass this code to Yandex.Checkout.

If the user entered an incorrect code from the SMS, the Counterparty receives the corresponding error in response to the request.

It is allowed to repeat the request for payment confirmation three times with different codes. After the third attempt, the payment process should be started over again with a createInvoice call and a new clientOrderId value.

Examples

Example of request parameters
clientOrderId=123456789&invoiceId=2000000123&amount=10.00&cvv=643
Response example
<confirmInvoiceResponse 
         clientOrderId="123456789"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         techMessage=""
         />

See also

Payment from an account in an SMS message

createInvoice method

Rules for processing requests

Error codes

Data types