Changelog
This is an old version of the API. Switch to the YooMoney API.
2024
October 3
You now should set the
topped_up_phone
parameter with the recipient's phone number when adding money to phone balance (MCC 4814). It's mandatory when you process payments made from bank card (paymentType="AC"
), via YooMoney wallet (paymentType="PC"
), if a payment method was selected on the YooMoney's side (paymentType=""
), and when you process recurring payments (repeatCardPayment
method).July 1
The protocol stops supporting the “Installments” payment method (
CR
):- Payments by this method are unavailable.
- You can refund payments made by this payment method until December 31, 2024 inclusive (until 11:59:59 PM by Moscow time). If 30 days or more have passed since the date of payment, notify the manager before making a refund: they will help you do it properly.
February 21
The QIWI Wallet payment method (
QW
) has been disabled due to the fact that QIWI Bank had its license revoked. Payments and refunds for this method are unavailable.2023
June, 15
The protocol no longer supports the Alfa-Click and ERIP (Belarus) payment methods.
2022
December, 16
Added a new payment method: Mir Pay.
August, 19
The protocol no longer supports the MasterPass payment method.
April, 20
The protocol no longer supports the Apple Pay and Google Pay payment methods.
March, 25
You can't issue reusable payment codes for cash payments made via payment kiosks anymore. Codes issued earlier can still be used.
If you want to accept payments in cash via payment kiosks, make a request to generate a one-time code: in the payment form, specify
paymentType=GP
as the payment method and include the payment amount in the sum
parameter.March, 11
All transactions via Visa, Mastercard, JCB, and American Express cards issued abroad have been suspended in Russia. Therefore, there are restrictions on using Apple Pay and Google Pay:
- Payments via Apple Pay are only available for MIR cards.
- Payments via Google Pay are no longer available for Mastercard and Visa cards, therefore, we've temporarily disabled this payment method. We'll enable it again if it becomes possible to add MIR cards to Google Pay.
February, 11
The WebMoney payment method (
WM
) has been disabled due to the fact that WebMoney's settlement bank had its license revoked. Payments and refunds for this method are unavailable.February, 7
The SberBank Online payment method has been disabled. If you need to refund payments via SberBank Online, you can do so until April 10, 2022 inclusive (until 11:59:59 PM by Moscow time).
To accept payments via SberBank, use the SberPay payment method.
2021
October, 6
The SberBank Online payment method is about to be disabled:
- If you’d like to start accepting payments via SberBank, use SberPay.
- If you already accept payments via SberBank Online, you’ll be switched to SberPay automatically.
May, 21
Added error code 616 which is returned in response to a
returnPayment
request when you're trying to return a transfer after its refund period expired.May, 12
Added a new payment method via SberBank — SberPay. YooMoney switches those who has access to the SberBank Online payment method to SberPay.
2020
December, 22
Limitation added for payment refunds: successful payments via SberBank Online (
SB
payment method code) can only be refunded within a year since the date of order registration in YooMoney (orderCreatedDatetime
in the notification of order verification).December, 10
- A certificate issued by the NBCO YooMoney certificate authority is now required for authenticating connections to YooMoney’s servers. The certificate request application form, certification chain for verifying the end server certificate, and certificate revocation list (CRL) in the manual for getting a certificate have been updated.
- Payment form now must be sent to a new address:
https://yoomoney.ru/eshop.xml
- Запросы по Протоколу управления заказами теперь нужно отправлять по новому адресу:
https://shop.yookassa.ru
- Адрес электронной почты для связи с менеджерами ЮKassa изменен на merchants@yoomoney.ru, адрес для связи по техническим вопросам изменен на b2b_support@yoomoney.ru.
June, 5
Added limit for refunds: a successful payment can only be refunded within three years since the date of order registration in YooMoney (
orderCreatedDatetime
in order verification notification).February, 6
The option to accept payments from legal entities via SberBank Business Online is now available to clients of any banks.
2019
October, 11
Added the option to accept payments via direct carrier billing.
July, 1
- We added the option of transferring user data (
customer
parameter) as well as additional product information (productCode
,countryOfOriginCode
,customsDeclarationNumber
, andexcise
parameters) for the receipt when creating or refunding a payment. - The
customerContact
parameter is now deprecated. You can still use it but we recommend sending the data in thecustomer
parameter.
June, 11
The YooMoney demo environment is removed from service. Use the demo store for testing the payments.
2018
November, 13
We now support FFD 1.05 for compatibility with online sales registers, allowing you to send the payment form with two new parameters in addition to the data for the receipt: payment subject (
paymentSubjectType
) and payment method (paymentMethodType
). Both parameters are optional.April, 26
The “KupiVKredit” payment method (
paymentType=KV
) is no longer supported.2017
September, 12
- We added the description for the 425 error (technical error appearing in response to the
createInvoice
request). - We fixed a few important details.
August, 25
- We added description of 428 error (refund is forbidden for this payment method).
- You can only transmit email address in HTTP and Email payment form in the
cps_email
parameter. Otherwise the request will return error.
August, 14
- We introduced payment via SberBank’s mobile app: the buyer proceeds to the issued invoice via deep linking.
- Parameters for creating the receipt are now transmitted in paymentAviso. These parameters allow for sending electronic receipt to the buyer.
- When transmitting parameters for the receipt, product name (the text parameter) expands to 128 characters. For instance, see Parameters for the receipt in the payment form.
July, 28
We added an explanation for sending details for the receipt when putting an operation on hold. Details for the receipt are transmitted to your online sales register on the first stage: if the authorization was successful. If the amount is adjusted upon the payment confirmation, a return receipt is transmitted, and then a receipt for this new operation is transmitted. If the payment is cancelled on the second stage, a return receipt is transmitted.
June, 11
- We added the environment parameter to the listOrders method, which allows for distinguishing test and real operations.
- If you transmit parameters for the receipt in the returnPayment method and cannot receive a precise amount (one kopeck less or one kopeck bigger), you need to transmit the amount that is one kopeck bigger.
- Clarified: the time of a payment in the registers of accepted transfers is the time when this operation was created in YooMoney.
June, 5
We added explanations to the description of parameters for creating the receipt. We also changed examples.
June, 1
We added an option of transmitting fiscal data to online sales register adopted by the store. Online sales register transmits these data to the Operator of Fiscal Data; these data is used for creating a receipt for the buyer (this protocol does not include creating a receipt for the buyer).
You can view changes in the special section: Changes of protocol for work under Federal Law No. 54
We added the following sections:
- Transmitting data for the receipt — description of the payment scenario where fiscal data are transmitted
- Parameters for creating a receipt — additional parameters for transmitting fiscal data via a payment form
The amendments affect the following pages:
- Description of the payment process
- Form for HTTP notifications
- Form for email notifications
- returnPayment method
- repeatCardPayment method
- createInvoice method
- Error codes
May, 17
Updated information on:
- you can only provide deferred payments for
paymentType=AC
(payment with a bank card); - when paying via KupiVkredit (
paymentType=KV
), all parameters with the qualifier goods_ are optional. Parameterseller_id
is not transferred. (See Payment form).
April, 6
Updated information on:
customerNumber
andorderNumber
parameters in allnormalizedString
cases;- payments via KupiVkredit (
paymentType=KV
) do not requirecategory_code_N
andgoods_description_N
(see Payment form).
March, 14
Changed:
- The qppi.ru (
QP
) payment method no longer works (service closed); - the YooMoney activation method CMS Module is now called the Payment module.
February, 28
Updated information on:
- The listReturns method should simultaneously specify either the
invoiceId
andshopID
parameters or thefrom
,till
andshopID
parameters. - The reason for the request (planned replacement) was added to the SSL certificate request.
- If you can do a return on a payment order, then you can also do it automatically.
- In the createInvoice request, the
offline
value is passed into thepayMethod
parameter by default.
January, 26
For deferred payment using a bank card, the merchant gets the
paymentAviso
notification after money is successfully reserved on the payer’s card.2016
December, 14
Added documentation for:
- Requesting a QR code. You can send a request with payment form data for paying for an order, get a response with a QR code in SVG format, and display it for the user (or print it and stick it on the product package).
- Error codes that are returned in response to the
createInvoice
request (614
and615
).
Updated information on:
- Depositing money to the test wallet (there is a new link to the deposit form).
- In the Interaction over SSL section, the file with the certification chain has changed.
October, 21
Updated information on:
- The flow for receiving payments: in most scenarios, first the merchant receives the order verification request, and then the user confirms the payment.
- When using dynamic URLs for redirecting the customer back to the store from the successful payment page (
successUrl
andfailUrl
), both URLs must be specified. - Money can be held for deferred payments for up to 7 days, and the hold can be extended for up to 30 days. However, the issuing bank might unblock the amount at any point during this time.
September, 29
Added documentation for:
- Information on payments via SberBank Online without going to the YooMoney service (see the note for the payment scenario using external payment systems).
- Additional parameters for this payment method (in the description of the createInvoice method).
- Error codes that are sent in response to
createInvoice
andconfirmInvoice
(in the Reference). - Information about a new payment method, ERIP in Belarusia (in the section Cash payment via kiosks and in the list of payment methods).
May, 17
Added documentation for:
- Payment from an account in an SMS message.
- Two methods that are used when paying in an SMS message: createInvoice and
confirmInvoice
. - New error codes for this payment method.
April, 12
Updated:
- Added information about Smart Payments to the description of the payment process.
- Updated the description of payments using credit.
- Corrected the descriptions of several parameters and added some important notes.
March, 2
Added documentation for:
- Information on deferred payments using a bank card.
- Information on repeated payments using a bank card.
Updated:
- The payment methods section has new information about the invoice expiration when paying via external payment systems.
- Fixed several minor discrepancies.
2015
December, 25
Updated a new payment scenario with the choice of payment method on the YooMoney side (see the description of the two scenarios and the examples of payment forms).
November, 23
Updated:
- Details of working with repeatCardPayment (additional parameters for the payment form and the
checkOrder
andpaymentAviso
requests). - Description of working with test Wallets when testing payment.
October, 1
Updated:
- New error codes.
- Details of payment in cash at kiosks outside the Russian Federation.
September, 1
Added documentation for:
- Secure interaction using PKCS#7.
- Interaction for order payment by credit (new payment method: “KupiVkredit”).
- The
cancelOrder
requests (used for notification of order cancellation when paying by credit). - New payment method: QPPI.ru.
- Reports on refunded payments.
Updated:
- Details of calling
checkOrder
before receiving funds from the user for payments using an external payment system and cash payments at kiosks. - Details of making refunds using the returnPayment method.