Payment notification (paymentAviso)

Description

Yandex.Checkout uses this request to tell the merchant that the user's money was successfully transferred to the merchant's address. This means that the merchant is obligated to provide the user with the product or service that was paid for.

Method name

paymentAviso

Address for receiving request

avisoURL — The URL in the merchant's system. Stored on Yandex.Checkout. You can set it during activation.

Request parameters

Parameter

Type

Description

requestDatetime

dateTime

Time when request was formed in Yandex.Checkout.

paymentDatetime

dateTime

Time when the order payment was registered in Yandex.Checkout.

action

normalizedString, maximum 16 characters

Request type. Value: paymentAviso

When exchanging data in PKCS#7 format, it is passed as the opening tag of an XML document.

The VAT amount you sent in the payment form. Shown if vatType=calculated.

Information about the buyer company for B2B payments (paymentType=2S)

b2b_full_name

string

Full name of the organization.

b2b_short_name

string

Abbreviated name. Shown if available.

b2b_adress

string

Address.

b2b_inn

string

INN (TIN).

b2b_kpp

string

KPP (TRRC).

b2b_bank

string

Name of the bank.

b2b_bank_office

string

Bank branch.

b2b_bik

string

BIC.

b2b_account

string

Account number.

Any names other than those listed above

string

Parameters added to the payment form by the merchant.

Tip.

The Payer's country code (cps_user_country_code) comes from technical sources corresponding to the selected payment method. The customer does not confirm this information anywhere. Yandex.Checkout is likewise not responsible for the validity of this data.

Yandex.Checkout requests may contain parameters not described in this document. The merchant should ignore them.

Requests don't have to contain all the parameters. Only parameters that are needed for calculating the MD5 checksum are required (action, orderSumAmount, orderSumCurrencyPaycash, orderSumBankPaycash, shopId, invoiceId, customerNumber).

Parameters for electronic payment receipt

These parameters are present in the request if you set up interaction with your cloud sales register via Yandex.Checkout and transfer parameters for creating a receipt in the payment request. See Sending details for the receipt

Parameter

Type

Value

penReceiptDateTime

string

Date and time of creating the receipt as recorded in the fiscal storage.

Format: dd.MM.yyyy HH:mm:ss

penReceiptTotal

decimal (2 digits after the point)

Total amount in the receipt.

penFnNumber

string, maximum of 16 characters

Number of the fiscal storage.

penFiscalDocumentNumber

int

Fiscal number of the document.

penFiscalDocumentAttribute

string, maximum of 19 characters

Fiscal feature of the document.

Parameter

Type

Value

penReceiptDateTime

string

Date and time of creating the receipt as recorded in the fiscal storage.

Format: dd.MM.yyyy HH:mm:ss

penReceiptTotal

decimal (2 digits after the point)

Total amount in the receipt.

penFnNumber

string, maximum of 16 characters

Number of the fiscal storage.

penFiscalDocumentNumber

int

Fiscal number of the document.

penFiscalDocumentAttribute

string, maximum of 19 characters

Fiscal feature of the document.

Note.

If the payment notification was not delivered (the merchant does not respond to repeated paymentAviso requests, or returns technical errors), the payment is considered unsuccessful by default. This means that Yandex.Checkout stops attempting to deliver notifications, marks the payment as undelivered, and does not enter it in the report of accepted payments. The amount of the unsuccessful payment will be automatically returned to the payer. The merchant can find "lost" notifications by using payment management (MWS) methods for cross-checking.

If you want these payments to be considered successful, you can choose a different processing option for undelivered notifications. In this case, Yandex.Checkout stops attempting to deliver notifications and marks the transfer as successful. The payment will be included in the accepted payments report according to the time of the last attempt to deliver the paymentAviso request. The merchant can then find these "lost notifications" by checking the report or by using payment management (MWS) methods.

You can change how this situation is handled on request. If you want to consider undelivered notifications successful, inform your Yandex.Checkout manager.

When paying via B2B payments (paymentType=2S) the payment is considered successful in any case, regardless of your response to the notification of payment.