confirmPayment method

Description

Complete a successful transfer to the merchant's account. Used for deferred payments.

Restriction. 

In order to complete confirmation requests (confirmPayment) and cancel deferred payments (cancelPayment), you must register a separate store.

For more information, contact your Yandex.Checkout manager.

Note. 
  • If a store has deferred payments set up in Yandex.Checkout, all payments to this store will be deferred. This means they are performed in two steps: first money is reserved on the payer's bank card, then it is debited from the card.
  • The amount specified in the request to confirm a deferred payment may be less than the reserved amount. In this case, the amount remaining is automatically refunded to the Payer's bank card.
  • If the confirmation period has expired for a deferred payment, the response will contain an error, even if the request parameters are correct. The confirmation period is defined by the bank that is processing the operation. Each bank sets this time individually.

Address for calling the confirmPayment operation

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

Input parameters

Parameter

Type

Description

requestDT

dateTime

Time in the merchant's system when the request to perform the operation was made.

orderId

long

Transaction number of the deferred payment, issued by Yandex.Checkout in the invoiceId parameter.

amount

CurrencyAmount

Amount to transfer.

currency

string, 3 characters

3-letter currency code for the transfer. Specified in accordance with ISO 4217:2008.

ym_merchant_receipt string

Data for creating the receipt in the JSON format (as in payment form).

The parameter is transmitted and deemed mandatory in the following cases:

  • you set up interaction with your online sales register via Yandex.Checkout and transmit details for creating the receipt in the payment form
  • transfer amount (amount) differs from the initial amount transmitted in payment form (partial clearing is carried out).

Output parameters

The response contains parameters that are shared for all types of financial transaction request.

Request example

requestDT=2011-07-02T20:38:00.000Z&orderId=12345&amount=10.00&currency=RUB

Response example

<confirmPaymentResponse 
         orderId="12345"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         />

See also

Scenario for deferred payments

Rules for processing requests

Error codes

Data types