116 lines
3.6 KiB
Markdown
116 lines
3.6 KiB
Markdown
# @root/paypal-checkout
|
|
|
|
In contrast to the official PayPal Checkout SDK - which is auto-generated code
|
|
with lots of abstraction without much value - this is very little abstraction,
|
|
but specificially designed to be (mostly) idiomatic JavaScript / Node.js. \
|
|
(excuse the `snake_case` - that's how the PayPal REST API is designed).
|
|
|
|
|
|
|
|
<img src="https://www.paypalobjects.com/webstatic/en_US/i/buttons/checkout-logo-large.png" alt="Check out with PayPal" />
|
|
|
|
The Good Documentation™ for the PayPal API (a.k.a. PayPal Checkout SDK) is the
|
|
"REST API". See
|
|
|
|
- <https://developer.paypal.com/docs/api/orders/v2/> (one-time payments)
|
|
- <https://developer.paypal.com/docs/api/subscriptions/v1/> (recurring
|
|
subscriptions)
|
|
- <https://www.paypal.com/webapps/mpp/logos-buttons> (the buttons)
|
|
|
|
# Install
|
|
|
|
```bash
|
|
npm install --save @root/paypal-checkout
|
|
```
|
|
|
|
# Usage
|
|
|
|
```js
|
|
"use strict";
|
|
|
|
require("dotenv").config({ path: ".env" });
|
|
|
|
let PPC = require("@root/paypal-checkout");
|
|
PPC.init({
|
|
client_id: "xxxx",
|
|
client_secret: "****",
|
|
});
|
|
|
|
PPC.Subscriptions.createRequest({
|
|
// See https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions
|
|
});
|
|
```
|
|
|
|
# API
|
|
|
|
```txt
|
|
PayPal.init(client_id, client_secret, 'sandbox|live', defaults);
|
|
PayPal.request({ method, url, headers, json });
|
|
|
|
PayPal.Product.create({ ... }); // event_type: "CATALOG.PRODUCT.CREATED"
|
|
PayPal.Product.list();
|
|
PayPal.Product.details(id);
|
|
PayPal.Product.update(id, { description }); // event_type: "CATALOG.PRODUCT.UPDATED"
|
|
|
|
PayPal.Plan.create({ ... }); // event_type: "BILLING.PLAN.CREATED"
|
|
PayPal.Plan.list();
|
|
PayPal.Plan.details(id);
|
|
PayPal.Plan.update(id, { description }); // event_type: "BILLING.PLAN.UPDATED"
|
|
|
|
PayPal.Subscription.createRequest({ ... });
|
|
PayPal.Subscription.details(id);
|
|
PayPal.Subscription.cancel(id, { reason });
|
|
```
|
|
|
|
# Redirects
|
|
|
|
Subscription Request `return_url` will include the following:
|
|
|
|
```txt
|
|
https://example.com/redirects/paypal-checkout/return
|
|
?subscription_id=XXXXXXXXXXXXXX
|
|
&ba_token=BA-00000000000000000
|
|
&token=XXXXXXXXXXXXXXXXX
|
|
```
|
|
|
|
# Webhooks
|
|
|
|
Webhooks can be set up in the Application section of the Dashboard:
|
|
|
|
- <https://developer.paypal.com/developer/applications>
|
|
|
|
You'll see a list of applications. Click on one to access the webhooks.
|
|
|
|
# Notes
|
|
|
|
Note: Just about everything in the PayPal SDK that uses `ALL_CAPS` is a
|
|
`constant`/`enum` representing an option you can pick from limited number of
|
|
options.
|
|
|
|
Sandbox accounts (for creating fake purchases) can be managed at:
|
|
<https://developer.paypal.com/developer/accounts>
|
|
|
|
Note on Auth + Capture:
|
|
|
|
> Authorization and capture enables you to authorize fund availability but delay
|
|
> fund capture. This can be useful for merchants who have a delayed order
|
|
> fulfillment process. Authorize & Capture also enables merchants to change the
|
|
> original authorization amount in case the order changes due to shipping,
|
|
> taxes, or gratuity.
|
|
>
|
|
> For any payment type, you can capture less than or the full original
|
|
> authorized amount. You can also capture up to 115% of or $75 USD more than the
|
|
> original authorized amount, whichever is less.
|
|
>
|
|
> See
|
|
>
|
|
> - <https://developer.paypal.com/docs/admin/auth-capture/>
|
|
> - <https://developer.paypal.com/docs/api/payments/v2/#authorizations_capture>
|
|
|
|
Buttons:
|
|
|
|
- <https://www.paypal.com/webapps/mpp/logos-buttons> <== THE ONE YOU WANT
|
|
- <img src="https://www.paypalobjects.com/webstatic/en_US/i/buttons/checkout-logo-large.png" alt="Check out with PayPal" />
|
|
- <https://developer.paypal.com/docs/checkout/>
|
|
- <https://www.paypal.com/buttons/>
|