Tiefer Einblick: PayPal-Integration Teil 2: PayPal REST API

In diesem Tutorial zeige ich Ihnen, wie Sie Zahlungen mit der PayPal REST API und C# durchführen. Alle von ihnen bereitgestellten Bibliotheken für verschiedene Sprachen wie Ruby, Node.js, Python, PHP usw. sind sehr ähnlich, sodass alle hier aufgeführten Konzepte auf alle Bibliotheken anwendbar sind.

Projekteinstellungen

Zuerst habe ich ein MVC-Projekt in Visual Studio 2015 erstellt: Datei > Neu > Projekt und ASP.NET-Anwendung ausgewählt.

Wählen Sie die Vorlage „ASP.NET 5-Webanwendung“ aus, die das neue MVC 6 verwendet. Es ähnelt MVC 5, wenn Sie damit vertraut sind.

Wie Sie auf dem Foto unten sehen können, habe ich der Lösung einige Dateien und Ordner hinzugefügt. Die wichtigsten zwei Dinge, die es zu beachten gilt, sind:

In den

Referenzen
1. habe ich das Ziel DNX Core 5.0 entfernt, wodurch wir dieses Projekt unter Mac OS X oder Linux ausführen können, aber die PayPal-Bibliotheken, die wir benötigen, wurden noch nicht aktualisiert. Ich habe den Ordner „Services“ hinzugefügt, in dem ich die Logik für die PayPal-Aufrufe einkapseln werde, damit wir die Steuerung einfach und klar halten können.

Verwenden Sie NuGet, um das PayPal SDK zu installieren.

Klicken Sie mit der rechten Maustaste auf den

Lösungsnamen und wählen Sie NuGet-Pakete verwalten, suchen Sie dann nach „PayPal“ und installieren Sie es.

PayPal-App erstellen

Um unsere Anwendung mit PayPal zu integrieren, müssen wir zu PayPal Developers navigieren und unter

REST-API-Anwendungen

auf Anwendung erstellen klicken.

Benennen Sie Ihre App und wählen Sie ein Sandbox-Entwicklerkonto aus, das Sie mit der App verknüpfen möchten. Zu Testzwecken können wir zu http://sandbox.paypal.com navigieren und uns mit den Sandbox-Anmeldedaten anmelden, um ein Test-PayPal-Konto und Transaktionen anzuzeigen.

Nachdem Sie auf

App erstellen

geklickt haben, sehen wir den Bestätigungsbildschirm mit der Kunden-ID und dem geheimen Token.

Kopieren Sie die clientId und das clientSecret-Token nach

, wie im Screenshot unten gezeigt:

appsettings.json

Testzahlung

PayPal bietet eine Sandbox-Umgebung zum Testen. Von dort aus können Sie Testkäufer- und Verkäuferkonten erstellen. Nach der Anmeldung verfügen Sie über ein Unternehmenskonto in der Sandbox, das mit Ihrem Entwicklerkonto verknüpft ist.

Um ein neues Testkonto zu erstellen, melden Sie sich auf der Entwickler-Website an, klicken Sie dann auf die Registerkarte

Systemsteuerung

und navigieren Sie zu Sandbox > Konten. Die Liste der Testkonten (falls verfügbar) können Sie hier einsehen:

Wenn Sie noch kein Testkonto erstellt haben, klicken Sie oben rechts auf

Konto erstellen

, um mindestens ein persönliches Testkonto und ein Geschäftskonto zu erstellen.

Nachdem Sie ein Testkonto erstellt haben, können Sie sich über www.sandbox.paypal.com mit der Test-E-Mail-Adresse und dem Passwort anmelden, die Sie jedem Konto im vorherigen Formular zugewiesen haben. Dies ist nützlich, um zu testen, ob Gelder auf Ihr Test-Geschäftskonto überwiesen werden, wenn Sie einen Kauf über Ihr persönliches Testkonto tätigen. Jetzt können Sie mit der Integration mit PayPal beginnen und testen, ob Gelder von einem Konto auf ein anderes übertragen werden.

Einzelne PayPal-Zahlung

PayPal bietet verschiedene Zahlungsmethoden an. Sie können direkte Kreditkartenzahlungen nutzen, was bedeutet, dass Ihre Kunden weder die PayPal-Anmeldeseite noch die PayPal-Zusammenfassung sehen können – alles geschieht auf Ihrer Website. Dazu müssen Sie PCI-kompatibel sein und ich empfehle die Verwendung von Stripe, da Sie nur SSL über deren JavaScript-Bibliothek benötigen. Um per PayPal zu bezahlen, gibt es hingegen drei Schritte:

1. Geben Sie Zahlungsinformationen an, um eine Zahlung zu erstellen.
2. Lassen Sie die Zahlung genehmigen, leiten Sie Ihre Kunden an PayPal weiter, um die Transaktion zu genehmigen.
3. Nachdem PayPal Ihren Kunden zurück auf Ihre Website weitergeleitet hat, Führen Sie die Zahlung aus, um das Geld zu erhalten.

Im Ordner Services meines MVC-Projekts habe ich die PayPalPaymentService-Klasse erstellt und darin die folgenden Methoden hinzugefügt:

public static Payment CreatePayment(string baseUrl, string intent)
{
    // ### Api Context
    // Pass in a `APIContext` object to authenticate 
    // the call and to send a unique request id 
    // (that ensures idempotency). The SDK generates
    // a request id if you do not pass one explicitly. 
    var apiContext = PayPalConfiguration.GetAPIContext();

    // Payment Resource
    var payment = new Payment()
    {
        intent = intent,    // `sale` or `authorize`
        payer = new Payer() { payment_method = "paypal" },
        transactions = GetTransactionsList(),
        redirect_urls = GetReturnUrls(baseUrl, intent)
    };

    // Create a payment using a valid APIContext
    var createdPayment = payment.Create(apiContext);

    return createdPayment;
}

private static List<Transaction> GetTransactionsList()
{
    // A transaction defines the contract of a payment
    // what is the payment for and who is fulfilling it. 
    var transactionList = new List<Transaction>();

    // The Payment creation API requires a list of Transaction; 
    // add the created Transaction to a List
    transactionList.Add(new Transaction()
    {
        description = "Transaction description.",
        invoice_number = GetRandomInvoiceNumber(),
        amount = new Amount()
        {
            currency = "USD",
            total = "100.00",       // Total must be equal to sum of shipping, tax and subtotal.
            details = new Details() // Details: Let's you specify details of a payment amount.
            {
                tax = "15",
                shipping = "10",
                subtotal = "75"
            }
        },
        item_list = new ItemList()
        {
            items = new List<Item>()
            {
                new Item()
                {
                    name = "Item Name",
                    currency = "USD",
                    price = "15",
                    quantity = "5",
                    sku = "sku"
                }
            }
        }
    });
    return transactionList;
}

private static RedirectUrls GetReturnUrls(string baseUrl, string intent)
{
    var returnUrl = intent == "sale" ? "/Home/PaymentSuccessful" : "/Home/AuthorizeSuccessful";

    // Redirect URLS
    // These URLs will determine how the user is redirected from PayPal 
    // once they have either approved or canceled the payment.
    return new RedirectUrls()
    {
        cancel_url = baseUrl + "/Home/PaymentCancelled",
        return_url = baseUrl + returnUrl
    };
}

public static Payment ExecutePayment(string paymentId, string payerId)
{
    // ### Api Context
    // Pass in a `APIContext` object to authenticate 
    // the call and to send a unique request id 
    // (that ensures idempotency). The SDK generates
    // a request id if you do not pass one explicitly. 
    var apiContext = PayPalConfiguration.GetAPIContext();
    
    var paymentExecution = new PaymentExecution() { payer_id = payerId };
    var payment = new Payment() { id = paymentId };

    // Execute the payment.
    var executedPayment = payment.Execute(apiContext, paymentExecution);

    return executedPayment;
}

Einige Parameter werden in diesem Aufruf übergeben:

• Intent: Drei mögliche Werte: „Sales“ für sofortige Zahlung, „Authorize“ für Autorisierung zur späteren Erfassung der Zahlung oder „Order“ für die Erstellung einer Bestellung. Wenn Sie ermächtigt sind, eine Zahlung später abzubuchen, haben Sie eine dreitägige Garantie, können aber versuchen, die Zahlung bis zu 29 Tage später einzuziehen.
• Zahler: Die Geldquelle für diese Zahlung, die verwendete Zahlungsmethode – PayPal-Wallet-Zahlung, Banklastschrift oder direkte Kreditkarte.
• Transaktion: Wird zur Angabe des Zahlungsbetrags und optional zur Angabe der zu zahlenden Artikel verwendet. Bei Bedarf können Sie auch Zwischensummen, Versandkosten und Steuern angeben.
• Weiterleitungs-URL: Geben Sie die URL an, an die PayPal Ihre Kunden nach einer Transaktion weiterleitet, damit Sie die Datenbank aktualisieren und eine Bestätigungsmeldung anzeigen können.

Die bisherige Funktionalität kann vom Controller wie unten gezeigt genutzt werden:

public IActionResult CreatePayment()
{
    var payment = PayPalPaymentService.CreatePayment(GetBaseUrl(), "sale");
    
    return Redirect(payment.GetApprovalUrl());
}

public IActionResult PaymentCancelled()
{
    // TODO: Handle cancelled payment
    return RedirectToAction("Error");
}

public IActionResult PaymentSuccessful(string paymentId, string token, string PayerID)
{
    // Execute Payment
    var payment = PayPalPaymentService.ExecutePayment(paymentId, PayerID);

    return View();
}

Wie Sie sehen, habe ich drei Aktionen erstellt:

• Zahlung erstellen: Dies ist die Aktion, die die Zahlung auslöst. Es ruft PayPal auf, um die Zahlung zu erstellen, und leitet den Benutzer dann an PayPal weiter, um die Transaktion zu genehmigen.
• Zahlung erfolgreich: So leitet PayPal den Kunden nach erfolgreicher Zahlung zurück. An diesem Punkt können wir die Zahlung ausführen und das Geld auf unser Händlerkonto überweisen.
• PaymentCancelled: Leiten Sie den Benutzer von PayPal zu dieser Aktion weiter, wenn er den Genehmigungsprozess abbricht. An dieser Stelle möchten Sie dem Kunden möglicherweise die Möglichkeit geben, es erneut zu versuchen oder Sie zu kontaktieren.

Autorisieren Sie die Zahlung, um sie später zu erhalten

Dieses Szenario ist dem vorherigen Fall sehr ähnlich. Sie können diese Methode verwenden, wenn Sie versuchen, ein Produkt vorzubestellen, das noch nicht verfügbar ist. Die Schritte, um diese Zahlung zu erhalten, sind:

1. Zahlung autorisieren: Der „Intent“-Parameter dieses Aufrufs sollte „Autorisieren“ lauten.
2. Bezahlt werden: Denken Sie daran, dass die Autorisierung für bis zu 3 Tage garantiert ist. Sie können jedoch versuchen, bis zu 29 Tage lang bezahlt zu werden.

Um diese Zahlungsart zu implementieren, habe ich gerade eine neue Methode in der PayPalPaymentService-Klasse hinzugefügt, um die Zahlung zu erfassen:

public static Capture CapturePayment(string paymentId)
{
    var apiContext = PayPalConfiguration.GetAPIContext();

    var payment = Payment.Get(apiContext, paymentId);
    var auth = payment.transactions[0].related_resources[0].authorization;

    // Specify an amount to capture.  By setting 'is_final_capture' to true, all remaining funds held by the authorization will be released from the funding instrument.
    var capture = new Capture()
    {
        amount = new Amount()
        {
            currency = "USD",
            total = "4.54"
        },
        is_final_capture = true
    };

    // Capture an authorized payment by POSTing to
    // URI v1/payments/authorization/{authorization_id}/capture
    var responseCapture = auth.Capture(apiContext, capture);

    return responseCapture;
}

Dann habe ich in HomeController zwei neue Aktionen hinzugefügt, um diese Zahlungsart anzuzeigen:

public IActionResult AuthorizePayment()
{
    var payment = PayPalPaymentService.CreatePayment(GetBaseUrl(), "authorize");
    
    return Redirect(payment.GetApprovalUrl());
}

public IActionResult AuthorizeSuccessful(string paymentId, string token, string PayerID)
{
    // Capture Payment
    var capture = PayPalPaymentService.CapturePayment(paymentId);

    return View();
}

• AuthorizePayment ist die Aktion, die die Zahlung auslöst. Sie ist der vorherigen Funktion „CreatePayment“ sehr ähnlich, aber in diesem Fall übergeben wir „authorize“ als Intent-Parameter.
• AuthorizeSuccessful ist die Aktion, die Ihre Kunden nach erfolgreicher Genehmigung einer PayPal-Zahlung weiterleitet. Zu diesem Zeitpunkt erfasse ich die Zahlung, aber Sie können die paymentId in der Datenbank speichern und die Zahlung bei Bedarf erfassen.

In diesen Codebeispielen habe ich der Einfachheit halber die Werte der Zahlungsvariablen fest codiert. In Ihrer realen Anwendung würden Sie sie wahrscheinlich in eine Methode einbinden, die alle diese Werte als Variablen akzeptiert, sodass alles dynamisch festgelegt und wiederverwendet werden kann.

Abonnieren

In PayPal wird dies als „Abrechnungsplan“ bezeichnet. Sie können einen wiederkehrenden Zahlungsplan erstellen und Ihren Kunden einen Abrechnungsplan abonnieren, indem Sie eine Abrechnungsvereinbarung erstellen. Mit der PayPal-REST-API können Sie Abrechnungspläne erstellen, aktualisieren oder löschen; dies können Sie verwenden, wenn Sie ein Admin-Panel erstellen möchten, um diese Dinge für Ihr Unternehmen zu verwalten.

Die Schritte zum Erstellen einer wiederkehrenden Gebühr für einen Kunden sind wie folgt:

1. Erstellen Sie einen Abrechnungsplan und aktivieren Sie ihn. Nachdem Sie einen Abrechnungsplan erstellt haben, hat dieser den Status „Erstellt“. Es muss durch Ausgabe einer PATCH-Anfrage aktiviert werden.
2. Vergleichsvereinbarung erstellen und Ausführen: Die Antwort auf den Aufruf „Vergleichsvereinbarung erstellen“ enthält Links zu „application_url“ und „execute_url“. Wir müssen die Genehmigung der Abrechnungsvereinbarung einholen und dann die Abrechnungsvereinbarung ausführen.

Abrechnungsplan

Erstellen Sie einen Abrechnungsplan

Erstellen Sie Abrechnungspläne, die Abrechnungszyklen definieren. Dies ist eine Zusammenfassung der Parameter, die wir beim Erstellen des Plans übergeben müssen.

• 名称：计费计划的名称。
• 说明：计费计划的说明。
• 类型：对于固定次数的定期付款，允许的值为“FIXED”；对于手动取消之前重复的计划，允许的值为“INFINITE”。
• 商户首选项：这是一个指定首选项的对象，例如设置费用、付款的最大失败尝试次数、返回 URL、取消 URL、通知 URL，PayPal 在付款后将在其中重定向用户。
• 付款定义：此计划的付款定义数组。通常，该数组将具有一两个付款定义。如果我们想提供免费试用或折扣价格试用，那么我们会设置两种付款定义。第一个定义是试用期，第二个定义是定期付款。付款定义的属性包括名称、类型（试用或常规）、频率（日、周、月、年）、 >频率间隔（如果我们将频率设置为“周”并将频率间隔设置为“1”，则我们定义每周付款）、向客户收费的金额，以及cycles 是总付款次数。 收费模式用于指定计划金额之外的运费和税费。

这是一个代码片段，展示了如何创建计费计划：

// Define the plan and attach the payment definitions and merchant preferences.
// More Information: https://developer.paypal.com/webapps/developer/docs/api/#create-a-plan
var billingPlan = new Plan
{
    name = "Tuts+ Plus",
    description = "Monthly plan for courses.",
    type = "fixed",
    // Define the merchant preferences.
    // More Information: https://developer.paypal.com/webapps/developer/docs/api/#merchantpreferences-object
    merchant_preferences = new MerchantPreferences()
    {
        setup_fee = GetCurrency("0"), // $0
        return_url = "returnURL", // Retrieve from config
        cancel_url = "cancelURL", // Retrieve from config
        auto_bill_amount = "YES",
        initial_fail_amount_action = "CONTINUE",
        max_fail_attempts = "0"
    },
    payment_definitions = new List<PaymentDefinition>
    {
        // Define a trial plan that will only charge $9.99 for the first
        // month. After that, the standard plan will take over for the
        // remaining 11 months of the year.
        new PaymentDefinition()
        {
            name = "Trial Plan",
            type = "TRIAL",
            frequency = "MONTH",
            frequency_interval = "1",
            amount = GetCurrency("0"), // Free for the 1st month
            cycles = "1",
            charge_models = new List<ChargeModel>
            {
                new ChargeModel()
                {
                    type = "TAX",
                    amount = GetCurrency("1.65") // If we need to charge Tax
                },
                new ChargeModel()
                {
                    type = "SHIPPING",
                    amount = GetCurrency("9.99") // If we need to charge for Shipping
                }
            }
        },
        // Define the standard payment plan. It will represent a monthly
        // plan for $19.99 USD that charges once month for 11 months.
        new PaymentDefinition
        {
            name = "Standard Plan",
            type = "REGULAR",
            frequency = "MONTH",
            frequency_interval = "1",
            amount = GetCurrency("15.00"),
            // > NOTE: For `IFNINITE` type plans, `cycles` should be 0 for a `REGULAR` `PaymentDefinition` object.
            cycles = "11",
            charge_models = new List<ChargeModel>
            {
                new ChargeModel
                {
                    type = "TAX",
                    amount = GetCurrency("2.47")
                },
                new ChargeModel()
                {
                    type = "SHIPPING",
                    amount = GetCurrency("9.99")
                }
            }
        }
    }
};

// Get PayPal Config
var apiContext = PayPalConfiguration.GetAPIContext();

// Create Plan
plan.Create(apiContext);

新创建的结算计划处于 CREATED 状态。将其激活为“活动”状态，以便您的客户可以订阅该计划。要激活该计划，我们需要发出 PATCH 请求：

// Activate the plan
var patchRequest = new PatchRequest()
{
    new Patch()
    {
        op = "replace",
        path = "/",
        value = new Plan() { state = "ACTIVE" }
    }
};
plan.Update(apiContext, patchRequest);

如您所见，PayPal 库是其 REST API 的直接包装器，这很好，但与 Stripe 等其他 API 相比，该 API 也非常复杂。因此，将所有 PayPal 通信包装在对象中，为我们的应用程序提供更清晰、更简单的 API，这确实是一个不错的选择。在这里您可以看到封装在多个带有参数的函数中的代码的样子：

public static Plan CreatePlanObject(string planName, string planDescription, string returnUrl, string cancelUrl,
    string frequency, int frequencyInterval, decimal planPrice,
    decimal shippingAmount = 0, decimal taxPercentage = 0, bool trial = false, int trialLength = 0, decimal trialPrice = 0)
{
    // Define the plan and attach the payment definitions and merchant preferences.
    // More Information: https://developer.paypal.com/docs/rest/api/payments.billing-plans/
    return new Plan
    {
        name = planName,
        description = planDescription,
        type = PlanType.Fixed,

        // Define the merchant preferences.
        // More Information: https://developer.paypal.com/webapps/developer/docs/api/#merchantpreferences-object
        merchant_preferences = new MerchantPreferences()
        {
            setup_fee = GetCurrency("1"),
            return_url = returnUrl,
            cancel_url = cancelUrl,
            auto_bill_amount = "YES",
            initial_fail_amount_action = "CONTINUE",
            max_fail_attempts = "0"
        },
        payment_definitions = GetPaymentDefinitions(trial, trialLength, trialPrice, frequency, frequencyInterval, planPrice, shippingAmount, taxPercentage)
    };
}

private static List<PaymentDefinition> GetPaymentDefinitions(bool trial, int trialLength, decimal trialPrice,
    string frequency, int frequencyInterval, decimal planPrice, decimal shippingAmount, decimal taxPercentage)
{
    var paymentDefinitions = new List<PaymentDefinition>();

    if (trial)
    {
        // Define a trial plan that will charge 'trialPrice' for 'trialLength'
        // After that, the standard plan will take over.
        paymentDefinitions.Add(
            new PaymentDefinition()
            {
                name = "Trial",
                type = "TRIAL",
                frequency = frequency,
                frequency_interval = frequencyInterval.ToString(),
                amount = GetCurrency(trialPrice.ToString()),
                cycles = trialLength.ToString(),
                charge_models = GetChargeModels(trialPrice, shippingAmount, taxPercentage)
            });
    }

    // Define the standard payment plan. It will represent a 'frequency' (monthly, etc)
    // plan for 'planPrice' that charges 'planPrice' (once a month) for #cycles.
    var regularPayment = new PaymentDefinition
    {
        name = "Standard Plan",
        type = "REGULAR",
        frequency = frequency,
        frequency_interval = frequencyInterval.ToString(),
        amount = GetCurrency(planPrice.ToString()),
        // > NOTE: For `IFNINITE` type plans, `cycles` should be 0 for a `REGULAR` `PaymentDefinition` object.
        cycles = "11",
        charge_models = GetChargeModels(trialPrice, shippingAmount, taxPercentage)
    };
    paymentDefinitions.Add(regularPayment);

    return paymentDefinitions;
}

private static List<ChargeModel> GetChargeModels(decimal planPrice, decimal shippingAmount, decimal taxPercentage)
{
    // Create the Billing Plan
    var chargeModels = new List<ChargeModel>();
    if (shippingAmount > 0)
    {
        chargeModels.Add(new ChargeModel()
        {
            type = "SHIPPING",
            amount = GetCurrency(shippingAmount.ToString())
        });
    }
    if (taxPercentage > 0)
    {
        chargeModels.Add(new ChargeModel()
        {
            type = "TAX",
            amount = GetCurrency(String.Format("{0:f2}", planPrice * taxPercentage / 100))
        });
    }

    return chargeModels;
}

更新结算计划

您可以通过提出“PATCH”请求来更新现有结算方案的信息。这是一个包装该调用的函数：

public static void UpdateBillingPlan(string planId, string path, object value)
{
    // PayPal Authentication tokens
    var apiContext = PayPalConfiguration.GetAPIContext();

    // Retrieve Plan
    var plan = Plan.Get(apiContext, planId);

    // Activate the plan
    var patchRequest = new PatchRequest()
    {
        new Patch()
        {
            op = "replace",
            path = path,
            value = value
        }
    };
    plan.Update(apiContext, patchRequest);
}

要更新计费计划描述，我们可以调用此函数并传递正确的参数：

UpdateBillingPlan(
    planId: "P-5FY40070P6526045UHFWUVEI", 
    path: "/", 
    value: new Plan { description = "new description" });

删除结算计划

理想情况下，当您不想接受新客户加入结算计划时，您需要将其更新为“非活动”状态。这不会影响该计划的现有计费协议。只需调用 UpdateBillingPlan 函数即可完成此操作：

UpdateBillingPlan(
    planId: "P-5FY40070P6526045UHFWUVEI",
    path: "/",
    value: new Plan { state = "INACTIVE" });

计费协议

创建计费协议

创建一个或多个结算计划后，您希望开始让客户注册您的订阅计划。为此，您需要收集客户详细信息并向 PayPal 提出请求。为了能够测试此功能，我向 HomeController 添加了几个操作：

public IActionResult Subscribe()
{
    var plan = PayPalSubscriptionsService.CreateBillingPlan("Tuts+ Plan", "Test plan for this article", GetBaseUrl());

    var subscription = PayPalSubscriptionsService.CreateBillingAgreement(plan.id, 
        new PayPal.Api.ShippingAddress
        {
            city = "London", 
            line1 = "line 1",
            postal_code = "SW1A 1AA",
            country_code = "GB"
        }, "Pedro Alonso", "Tuts+", DateTime.Now);
    
    return Redirect(subscription.GetApprovalUrl());
}

public IActionResult SubscribeSuccess(string token)
{
    // Execute approved agreement
    PayPalSubscriptionsService.ExecuteBillingAgreement(token);

    return View();
}

public IActionResult SubscribeCancel(string token)
{
    // TODO: Handle cancelled payment
    return RedirectToAction("Error");
}

• 订阅：这是调用的第一个操作。它正在创建一个测试结算计划，然后创建该计划的结算协议（订阅），并将用户重定向到 PayPal 以确认付款。
• 订阅成功：此操作是成功订阅后用作“返回 URL”的操作。协议令牌标识符在查询字符串中传递，我们使用此令牌来执行计费协议并使其处于活动状态。
• SubscribeCancel： 此操作用作“取消 URL”。如果由于某种原因付款失败，或者您的客户取消了 PayPal 付款，用户将采取此操作，您需要处理此问题。也许可以提供重试的选项。

正如您在前面的代码片段中看到的，我已将大部分功能包装在几个方法中。第一个是上一节中解释的“CreateBillingPlan”。第二个是“CreateBillingAgreement”，用于为用户订阅计划：

public static Agreement CreateBillingAgreement(string planId, ShippingAddress shippingAddress, 
    string name, string description, DateTime startDate)
{
    // PayPal Authentication tokens
    var apiContext = PayPalConfiguration.GetAPIContext();

    var agreement = new Agreement()
    {
        name = name,
        description = description,
        start_date = startDate.ToString("yyyy-MM-ddTHH:mm:ss") + "Z",
        payer = new Payer() { payment_method = "paypal" },
        plan = new Plan() { id = planId },
        shipping_address = shippingAddress
    };
    
    var createdAgreement = agreement.Create(apiContext);
    return createdAgreement;
}

第三种方法是“ExecuteBillingAgreement”。成功订阅批准后，我们​​使用返回的令牌来激活订阅：

public static void ExecuteBillingAgreement(string token)
{
    // PayPal Authentication tokens
    var apiContext = PayPalConfiguration.GetAPIContext();

    var agreement = new Agreement() { token = token };
    var executedAgreement = agreement.Execute(apiContext);
}

暂停计费协议

使用此方法暂停协议：

public static void SuspendBillingAgreement(string agreementId)
{
    var apiContext = PayPalConfiguration.GetAPIContext();

    var agreement = new Agreement() { id = agreementId };
    agreement.Suspend(apiContext, new AgreementStateDescriptor()
        { note = "Suspending the agreement" });
}

重新激活计费协议

这个与上一个非常相似：

public static void ReactivateBillingAgreement(string agreementId)
{
    var apiContext = PayPalConfiguration.GetAPIContext();

    var agreement = new Agreement() { id = agreementId };
    agreement.ReActivate(apiContext, new AgreementStateDescriptor()
        { note = "Reactivating the agreement" });
}

取消计费协议

使用此功能取消计划：

public static void CancelBillingAgreement(string agreementId)
{
    var apiContext = PayPalConfiguration.GetAPIContext();

    var agreement = new Agreement() { id = agreementId };
    agreement.Cancel(apiContext, new AgreementStateDescriptor()
        { note = "Cancelling the agreement" });
}

更新计费协议

这个选项非常有限，我希望从这次通话中可以更改订阅计划，以升级或降级客户。与 Stripe 不同，单次调用不支持此功能。您需要通过取消当前协议并创建新的升级或降级协议来处理这种情况。这并不理想，但将来可能会改变。

结论

这是人们用来与 PayPal 集成的最常用功能的概述。他们的 API 比本文中解释的集成方法要大得多 - 您还可以发放退款和部分退款，并且他们针对本文涵盖的示例中的边缘情况提供了许多不同的选项。如果您有兴趣获得有关任何特定集成的更多详细信息，请在评论中留下建议。

Das obige ist der detaillierte Inhalt vonTiefer Einblick: PayPal-Integration Teil 2: PayPal REST API. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!