| Nuget Package

.NET-клиент для Яндекс.Кассы

Swith to English

Клиент разработан на основе документации по API.

Клиент поддерживает классическую синхронную модель вызовов (класс Client) и async / await (класс AsyncClient).

Покрытие API почти полное и включает в себя создание платежа, подтверждение, возврат или отмену платежа, авиабилеты и чеки по ФЗ-54.

Начало использования

Для проведения платежей сайт вашего магазина должен быть доступен для получения уведомлений от Яндекс.Кассы. URL для уведомлений нужно указать в настройках магазина.

Все вызовы API проводятся через класс Client. Для его создания нужны номер магазина и секретный ключ:

    var client = new Yandex.Checkout.V3.Client(
        shopId: "12345", 
        secretKey: "ASDLsdFgsJnbKeJnOuQImWuJEuRPyIrOEwsRK");

Чтобы использовать async/await, создайте AsyncClient:

    AsyncClient asyncClient = client.MakeAsync();

AsyncClient содержит те же методы, что и Client, только с суффиксом "Async". Дальше пример для Client.

Для проведения платежа по инструкции Быстрый старт (шаги 1-4):

    // 1. Создайте платеж и получите ссылку для оплаты
    var newPayment = new NewPayment
    {
        Amount = new Amount { Value = 100.00m, Currency = "RUB" },
        Confirmation = new Confirmation { 
            Type = ConfirmationType.Redirect,
            ReturnUrl = "http://myshop.ru/thankyou"
        }
    };
    Payment payment = client.CreatePayment(newPayment);
    
    // 2. Перенаправьте пользователя на страницу оплаты
    string url = payment.Confirmation.ConfirmationUrl;
    Response.Redirect(url);

    // 3. Дождитесь получения уведомления
    Message message = Client.ParseMessage(Request.HttpMethod, Request.ContentType, Request.InputStream);
    Payment payment = message?.Object;
    
    if (message?.Event == Event.PaymentWaitingForCapture && payment.Paid)
    {
        // 4. Подтвердите готовность принять платеж
        _client.CapturePayment(payment.Id);
    }

Полный код в примере на ASP.NET.

Минимальные требования

Nuget-пакет содержит версии для трех платформ:

• .NET 4.0: нет поддержки async / await, не содержит класса AsyncClient.
• .NET 4.5
• .NET Standard 2.0: этот вариант подойдет для большинства современных проектов.

Нужный вариант библиотеки выбирается автоматически при установке пакета. Инструкции по установке на странице nuget.org.

Политика версионирования

<PackageVersion> следует правилам семантического версионирования.

<FileVersion> и <InformationalVersion> равны <PackageVersion>, за которой следует точка и номер сборки. Они назначаются в AppVeyor.

<AssemblyVersion> установлена в значение 0.0.0.0 в файле csproj и не меняется в процессе сборки. Она будет установлена в значение 1.0.0.0, когда API станет стабильным, и впоследствии мажорная версия (и только она) будет увеличиваться при внесении изменений, нарушающих обратную совместимость API.

Устранение проблем

"Authentication failed because the remote party has closed the transport stream."

Если вы получили эту ошибку при попытке создания платежа, возможно, вы используете протокол, не поддерживаемый Яндекс.Кассой. По состоянию на июль 2018 поддерживается TLS 1.2, что может измениться в будущем. Добавьте следующий код перед посылкой запроса:

    using System.Net;

    ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;

Или, если вы используете .NET 4.0 или ниже:

    ServicePointManager.SecurityProtocol = (SecurityProtocolType)3072;