-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(payments-plugin): Smaller fixes for the PayPal plugin documentation
- Loading branch information
1 parent
d390175
commit 05251c8
Showing
6 changed files
with
222 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
143 changes: 143 additions & 0 deletions
143
docs/docs/reference/core-plugins/payments-plugin/pay-pal-plugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| --- | ||
| title: "PayPalPlugin" | ||
| isDefaultIndex: false | ||
| generated: true | ||
| --- | ||
| <!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script --> | ||
| import MemberInfo from '@site/src/components/MemberInfo'; | ||
| import GenerationInfo from '@site/src/components/GenerationInfo'; | ||
| import MemberDescription from '@site/src/components/MemberDescription'; | ||
|
|
||
|
|
||
| ## PayPalPlugin | ||
|
|
||
| <GenerationInfo sourceFile="packages/payments-plugin/src/paypal/paypal.plugin.ts" sourceLine="124" packageName="@vendure/payments-plugin" /> | ||
|
|
||
| This plugin enables payments via the [PayPal Order API](https://developer.paypal.com/docs/api/orders/v2/#orders_create). | ||
|
|
||
| > **_Note:_** This plugin only supports a [2 step flow](https://docs.vendure.io/guides/core-concepts/payment/#two-step). | ||
| > This means that the payment has to manually captured by an admin. | ||
| ## Requirements | ||
|
|
||
| 1. Create a PayPal business account. | ||
| 2. Make sure you have the client ID and secret of your PayPal REST API app. | ||
| 3. Get the merchant ID from your PayPal account. This is the account ID of your PayPal business account. | ||
| 4. Install the Payments plugin: | ||
|
|
||
| `yarn add @vendure/payments-plugin` | ||
|
|
||
| or | ||
|
|
||
| `npm install @vendure/payments-plugin` | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Add the plugin to your VendureConfig `plugins` array: | ||
| ```ts | ||
| import { PayPalPlugin } from '@vendure/payments-plugin/package/paypal'; | ||
|
|
||
| // ... | ||
|
|
||
| plugins: [ | ||
| // Set the apiUrl to the PayPal sandbox environment | ||
| PayPalPlugin.init({ apiUrl: 'https://sandbox.paypal.com/' }), | ||
| ] | ||
| ``` | ||
| 2. Create a new PaymentMethod in the Admin UI, and select "PayPal payments" as the handler. | ||
| 3. Set your PayPal client ID, secret and merchant ID in the according fields. | ||
|
|
||
| ## Storefront usage | ||
|
|
||
| To successfully make a payment, the following steps are explained in detail: | ||
| 1. Create a PayPal order | ||
| 2. Use the PayPal SDK to authorize the payment | ||
| 3. Add the payment to the order | ||
| 4. Capture the payment | ||
|
|
||
| ### Create PayPal order | ||
|
|
||
| Begin by creating a new PayPal order. This order is the reference for the payment and is used to authorize the payment. | ||
| Make sure to store the order ID in your frontend, as it is needed in the next steps. | ||
|
|
||
| This step does not modify any data on your Vendure instance. It only creates a new order in the PayPal system. | ||
|
|
||
| Create the PayPal order using the following mutation: | ||
| ```GraphQL | ||
| mutation CreatePayPalOrder { | ||
| createPayPalOrder() { | ||
| ... on PayPalOrder { | ||
| id | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Authorize payment | ||
| The PayPal order you created must be authorized by your customers. This step is handled by the PayPal SDK for the most part. | ||
|
|
||
| For JavaScript projects, you can check out this integration guide to | ||
| integrate the PayPal SDK: [PayPal SDK Integration Guide](https://developer.paypal.com/studio/checkout/standard/integrate). | ||
|
|
||
| ### Add payment | ||
| After authorizing the payment, you need to add it to the Vendure order. This will add and validate the authorizations | ||
| add to the payment in the previous step. If the payment is valid, the order will be updated to the next state. | ||
|
|
||
| ```GraphQL | ||
| mutation AddPaymentToOrder() { | ||
| addPaymentToOrder(input: { | ||
| method: "paypal-payment-method", | ||
| metadata: { | ||
| orderId: "the PayPal order ID" | ||
| } | ||
| }) { | ||
| ... on Order { | ||
| id | ||
| code | ||
| state | ||
| payments { | ||
| id | ||
| state | ||
| transactionId | ||
| method | ||
| } | ||
| } | ||
| ... on ErrorResult { | ||
| message | ||
| errorCode | ||
| } | ||
| ... on PaymentFailedError { | ||
| paymentErrorMessage | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Capture payment | ||
| Using the admin ui, the admin can settle this payment. After this step, the payment is successfully captured. | ||
|
|
||
| ## Creating refunds | ||
| Refunds can be created like any other refund in Vendure. The refund will be processed through the PayPal API. | ||
|
|
||
| ```ts title="Signature" | ||
| class PayPalPlugin { | ||
| static options: PayPalPluginOptions; | ||
| init(options: PayPalPluginOptions) => Type<PayPalPlugin>; | ||
| } | ||
| ``` | ||
|
|
||
| <div className="members-wrapper"> | ||
|
|
||
| ### options | ||
|
|
||
| <MemberInfo kind="property" type={`PayPalPluginOptions`} /> | ||
|
|
||
|
|
||
| ### init | ||
|
|
||
| <MemberInfo kind="method" type={`(options: PayPalPluginOptions) => Type<<a href='/reference/core-plugins/payments-plugin/pay-pal-plugin#paypalplugin'>PayPalPlugin</a>>`} /> | ||
|
|
||
| Initialize the PayPal payment plugin | ||
|
|
||
|
|
||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
docs/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| title: "AddressBasedTaxZoneStrategy" | ||
| isDefaultIndex: false | ||
| generated: true | ||
| --- | ||
| <!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script --> | ||
| import MemberInfo from '@site/src/components/MemberInfo'; | ||
| import GenerationInfo from '@site/src/components/GenerationInfo'; | ||
| import MemberDescription from '@site/src/components/MemberDescription'; | ||
|
|
||
|
|
||
| ## AddressBasedTaxZoneStrategy | ||
|
|
||
| <GenerationInfo sourceFile="packages/core/src/config/tax/address-based-tax-zone-strategy.ts" sourceLine="27" packageName="@vendure/core" since="3.1.0 | ||
|
|
||
| :::info | ||
|
|
||
| This is configured via `taxOptions.taxZoneStrategy = new AddressBasedTaxZoneStrategy()` in | ||
| your VendureConfig. | ||
|
|
||
| :::" /> | ||
|
|
||
| Address based <a href='/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy'>TaxZoneStrategy</a> which tries to find the applicable <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> based on the | ||
| country of the billing address, or else the country of the shipping address of the Order. | ||
|
|
||
| Returns the default <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>'s default tax zone if no applicable zone is found. | ||
|
|
||
| ```ts title="Signature" | ||
| class AddressBasedTaxZoneStrategy implements TaxZoneStrategy { | ||
| determineTaxZone(ctx: RequestContext, zones: Zone[], channel: Channel, order?: Order) => Zone; | ||
| } | ||
| ``` | ||
| * Implements: <code><a href='/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy'>TaxZoneStrategy</a></code> | ||
|
|
||
|
|
||
|
|
||
| <div className="members-wrapper"> | ||
|
|
||
| ### determineTaxZone | ||
|
|
||
| <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zones: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>[], channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`} /> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters