Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit cacf320

Browse files
danidelcardanidelcar
authored
Merge pull request #2555 from magento-devdocs/ss-payments-dev
PAY-2057: Adds Payment Services extension documentation and updates the release notes section with GA release of Payment Services
2 parents fab5665 + 54831f1 commit cacf320

12 files changed

+461
-1
lines changed

‎_config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ defaults:
109109
github_files: https://github.com/magento/magento2-page-builder-docs/tree/master/
110110
github_repo: https://github.com/magento/magento2-page-builder-docs/
111111

112+
-
113+
scope:
114+
path: magento-payments
115+
values:
116+
group: magento-payments
117+
112118
-
113119
scope:
114120
path: guides/v2.3/mrg

‎src/_data/main-nav.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,10 @@
206206
url: /marketplace/sellers/getting-started.html
207207
versionless: true
208208

209+
- label: Payment Services
210+
url: /payment-services/index.html
211+
versionless: true
212+
209213
- label: Order Management
210214
url: http://omsdocs.magento.com/en/
211215

‎src/_data/toc/payment-services.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
label: Payment Services
2+
versionless: true
3+
pages:
4+
- label: Introduction
5+
url: /payment-services/index.html
6+
versionless: true
7+
8+
- label: Install Payment Services
9+
url: /payment-services/install-payments.html
10+
versionless: true
11+
12+
- label: Configure Payment Services
13+
url: /payment-services/configure-payments.html
14+
versionless: true
15+
children:
16+
- label: Customize buttons and messaging
17+
url: /payment-services/customize-buttons-messaging.html
18+
versionless: true
19+
20+
- label: Security
21+
url: /payment-services/security.html
22+
versionless: true
23+
24+
- label: Release Notes
25+
url: /payment-services/release-notes.html
26+
versionless: true

‎src/_data/toc/release-notes.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,14 @@ pages:
143143
- label: Product Recommendations
144144
url: /recommendations/release-notes.html
145145
versionless: true
146-
146+
147147
- label: Sales Channels
148148
children:
149149

150150
- label: Amazon
151151
url: /extensions/amazon-sales/release-notes/
152152
versionless: true
153+
154+
- label: Payment Services
155+
url: /payment-services/release-notes.html
156+
versionless: true

‎src/payment-services/assets/onboardingflow-docs-v2.png

145 KB
Loading

‎src/payment-services/configure-payments.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
group: payment-services
3+
title: Configure Payment Services
4+
---
5+
6+
After you install Payment Services, you can easily configure it from [within the Admin]({{ site.user_guide_url }}/payment-services/configure-payments.html) or via the Command Line Interface (CLI).
7+
8+
## Configure data export
9+
10+
Payment Services combines order data exported from Magento Open Source and Adobe Commerce with aggregated payment data from payment providers to create useful reports. The Payment Services extension uses indexers to efficiently collect all of the necessary data for the reports.
11+
12+
See [our user guide]({{ site.user_guide_url }}/payment-services/order-payment-status.html#data-used-in-the-report) to learn about the data used in Payment Services reporting.
13+
14+
### Set indexers
15+
16+
Order data is exported and persisted in the Payment Service, using one of two index modes---`ON SAVE` (default) or `BY SCHEDULE` (recommended).
17+
18+
The following indexes are for Payment Services:
19+
20+
| Code | Name | Description |
21+
| --- | --- | --- |
22+
| `sales_order_data_exporter` | Sales Order Feed | Builds index of order data |
23+
| `sales_order_status_data_exporter` | Sales Order Statuses Feed | Builds index of sales order statuses data |
24+
| `store_data_exporter` | Stores Feed | Builds index of store data |
25+
26+
To change the index mode for all three indexers, run:
27+
28+
``` bash
29+
bin/magento indexer:set-mode schedule sales_order_data_exporter sales_order_status_data_exporter store_data_exporter
30+
```
31+
32+
{:.bs-callout-tip}
33+
If you don't specify any indexers in your command, all indexers are updated to the same value. If you want to change a specific indexer you must list it in your command.
34+
35+
See [Configure indexers]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-index.html#configure-indexers) in [Manage the Indexers]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-index.html) to learn more about manually changing the mode of an indexer or [Index management]({{ site.user_guide_url }}/system/index-management.html#change-the-index-mode) to learn how to to change it in the Admin.
36+
37+
### Manually reindex data
38+
39+
You can manually reindex data, instead of waiting for it to happen automatically. See [Reindex]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-index.html#reindex) in [Manage the Indexers]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-index.html) for more information.
40+
41+
When `BY SCHEDULE` mode is set, the system keeps track of changed entities and the cron job updates the index for them based on a set schedule. See [Run cron from the command line]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-cron.html#config-cli-cron-group-run) in [Configure and run cron]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-cron.html) to learn how to manually trigger indexation using cron jobs.
42+
43+
### Send reindexed data to payment service
44+
45+
After the data is indexed, it will be sent automatically to Payment Services. You can also manually trigger the process of sending indexed data with this command:
46+
47+
``` bash
48+
bin/magento saas:resync --feed [feedName]
49+
```
50+
51+
Use the following command options:
52+
53+
| Command | Description |
54+
| --- | --- |
55+
| `bin/magento saas:resync --feed [feedName]` | Performs a re-indexation of the specified feed and sends it to the corresponding service |
56+
| `bin/magento saas:resync --no-reindex` | Skips indexation and sends un-synced data from the indexes |
57+
58+
The `--feed` parameter allows you to specify which feed you want to send:
59+
60+
| Feed | Description |
61+
| --- | --- |
62+
| `paymentServicesOrdersProduction` | Orders feed in Production mode |
63+
| `paymentServicesOrdersSandbox` | Orders feed in Sandbox mode |
64+
| `paymentServicesOrderStatusesProduction` | Order statuses in Production mode |
65+
| `paymentServicesOrderStatusesSandbox` | Order statuses in Sandbox mode |
66+
| `paymentServicesStoresProduction` | Stores in Production mode |
67+
| `paymentServicesStoresSandbox` | Stores in Sandbox mode |
68+
69+
All data needed for the reports is sent to Payment Services automatically if cron is configured and installed. You can also manually trigger the process of sending cron data to Payment Services.
70+
71+
``` bash
72+
bin/magento cron:run --group payment_services_data_export
73+
```
74+
75+
See [Manage the indexers]({{ site.baseurl }}{{ site.gdeurl }}/config-guide/cli/config-cli-subcommands-index.html) to learn more about re-indexing and indexers.

‎src/payment-services/customize-buttons-messaging.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
group: payment-services
3+
title: Customize buttons and messaging
4+
---
5+
6+
You can easily customize [PayPal Smart button styling](#paypal-smart-buttons) and [PayPal PayLater messaging, styling, and layout](#paypal-paylater) on the product page, the checkout page, in the shopping cart, and in the mini cart.
7+
8+
## PayPal Smart Buttons
9+
10+
To customize Smart Button styling, create a module with a dependency on `Magento_PaymentServicesPaypal`.
11+
12+
1. In the [`di.xml` file]({{ site.baseurl }}{{ site.gdeurl }}/extension-dev-guide/build/di-xml-file.html), create a new type named `Magento\PaymentServicesPaypal\Block\SmartButtons`.
13+
1. In the `arguments` block, specify one argument named `componentConfig` and `xsi:type="array"`.
14+
1. Under this new argument, specify three items named `product`, `cart`, and `minicart` with `xsi:type="array"`.
15+
1. Under each item, specify a nested item named `styles` with `xsi:type="array"`.
16+
1. Reference [PayPal's available styling](https://developer.paypal.com/docs/archive/checkout/how-to/customize-button/) and apply any desired parameters as nested items.
17+
18+
``` xml
19+
<type name="Magento\PaymentServicesPaypal\Block\SmartButtons">
20+
<arguments>
21+
<argument name="componentConfig" xsi:type="array">
22+
<item name="product" xsi:type="array">
23+
<item name="styles" xsi:type="array">
24+
<item name="layout" xsi:type="string">horizontal</item>
25+
<item name="color" xsi:type="string">gold</item>
26+
<item name="shape" xsi:type="string">rect</item>
27+
<item name="label" xsi:type="string">paypal</item>
28+
<item name="tagline" xsi:type="boolean">false</item>
29+
</item>
30+
</item>
31+
<item name="cart" xsi:type="array">
32+
<item name="styles" xsi:type="array">
33+
<item name="layout" xsi:type="string">vertical</item>
34+
<item name="color" xsi:type="string">gold</item>
35+
<item name="shape" xsi:type="string">rect</item>
36+
<item name="label" xsi:type="string">paypal</item>
37+
<item name="tagline" xsi:type="boolean">false</item>
38+
</item>
39+
</item>
40+
<item name="minicart" xsi:type="array">
41+
<item name="styles" xsi:type="array">
42+
<item name="layout" xsi:type="string">vertical</item>
43+
<item name="color" xsi:type="string">gold</item>
44+
<item name="shape" xsi:type="string">rect</item>
45+
<item name="label" xsi:type="string">paypal</item>
46+
<item name="tagline" xsi:type="boolean">false</item>
47+
</item>
48+
</item>
49+
</argument>
50+
</arguments>
51+
</type>
52+
```
53+
> Sample Smart Buttons customization
54+
55+
## PayPal PayLater
56+
57+
To customize the PayPal PayLater messaging, style, and layout, create a module with a dependency on `Magento_PaymentServicesPaypal`, for the [product page, cart, minicart](#create-module-for-product-page-cart-and-minicart), or [checkout page](#create-module-for-checkout-page), and then [edit the styling of the module](#edit-the-styling).
58+
59+
### Create module for product page, cart, and minicart
60+
61+
1. In the [`di.xml` file]({{ site.baseurl }}{{ site.gdeurl }}/extension-dev-guide/build/di-xml-file.html), create a new `type` named `Magento\PaymentServicesPaypal\Block\Message`.
62+
1. In the `arguments` block, specify one argument named `componentConfig` and `xsi:type="array"`.
63+
1. Under this new argument, specify three items named `product`, `cart`, and `minicart` with `xsi:type="array"`.
64+
65+
### Create module for checkout page
66+
67+
1. In the [`di.xml` file]({{ site.baseurl }}{{ site.gdeurl }}/extension-dev-guide/build/di-xml-file.html), create a new type named `Magento\PaymentServicesPaypal\Model\SmartButtonsConfigProvider`.
68+
1. In the `arguments` block, specify one argument named `messageStyles` and `xsi:type="array"`.
69+
70+
### Edit the styling
71+
72+
1. Under each element (for the `product`, `cart`, `minicart`, or `checkout`), specify a nested item named `styles` with `xsi:type="array"`.
73+
1. Reference [PayPal's available styling](https://developer.paypal.com/docs/business/pay-later/us/integrate/customize-messages/) and apply any desired parameters as nested items.
74+
75+
``` xml
76+
<type name="Magento\PaymentServicesPaypal\Block\Message">
77+
<arguments>
78+
<argument name="componentConfig" xsi:type="array">
79+
<item name="product" xsi:type="array">
80+
<item name="styles" xsi:type="array">
81+
<item name="layout" xsi:type="string">text</item>
82+
<item name="logo" xsi:type="array">
83+
<item name="type" xsi:type="string">inline</item>
84+
</item>
85+
</item>
86+
</item>
87+
<item name="cart" xsi:type="array">
88+
<item name="styles" xsi:type="array">
89+
<item name="layout" xsi:type="string">text</item>
90+
<item name="logo" xsi:type="array">
91+
<item name="type" xsi:type="string">inline</item>
92+
</item>
93+
</item>
94+
</item>
95+
<item name="minicart" xsi:type="array">
96+
<item name="styles" xsi:type="array">
97+
<item name="layout" xsi:type="string">text</item>
98+
<item name="logo" xsi:type="array">
99+
<item name="type" xsi:type="string">inline</item>
100+
</item>
101+
</item>
102+
</item>
103+
</argument>
104+
</arguments>
105+
</type>
106+
<type name="Magento\PaymentServicesPaypal\Model\SmartButtonsConfigProvider">
107+
<arguments>
108+
<argument name="messageStyles" xsi:type="array">
109+
<item name="layout" xsi:type="string">text</item>
110+
<item name="logo" xsi:type="array">
111+
<item name="type" xsi:type="string">inline</item>
112+
</item>
113+
</argument>
114+
</arguments>
115+
</type>
116+
```
117+
> Sample PayLater customization

‎src/payment-services/index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
group: payment-services
3+
title: Payment Services
4+
---
5+
6+
Payment Services for Adobe Commerce and Magento Open Source is your turnkey self-service solution, including sandbox testing and a simple setup, for providing robust and secure payment processing for your Magento websites.
7+
8+
Payment Services is:
9+
10+
* Easy to set up and maintain
11+
* Designed to maximize your profit
12+
* Safe and secure
13+
* Designed to meet all your payments needs
14+
* Self-contained within the Admin
15+
16+
See a full list of features and more detailed information in the [user guide]({{ site.user_guide_url }}/payment-services/index.html).
17+
18+
## Availability
19+
20+
Payment Services is available for Adobe Commerce and Magento Open Source. Payment Services is now compatible with Adobe Commerce versions 2.4.0 to 2.4.3-p1.
21+
22+
See [Lifecycle policy]({{site.baseurl}}/release/lifecycle-policy.html) and [Payment Services release notes]({{site.baseurl}}/payment-services/release-notes.html) pages for more release and version-specific information.
23+
24+
## Get started
25+
26+
Onboarding and setting up Payment Services is completed in [just a few steps]({{ site.user_guide_url }}/payment-services/index.html#get-started).
27+
28+
This complete onboarding flow diagram shows the general process, for both the user and the internal system, for onboarding Payment Services.
29+
30+
![Onboarding flow]({% link payment-services/assets/onboardingflow-docs-v2.png %}){: .zoom}
31+
_Onboarding flow (click to zoom)_
32+
33+
## Support
34+
35+
Payment Services is designed to be the simplest payments system you've ever used. Got questions about features, implementation, configuration, fee structure, extensibility, or reporting? We've got you covered.
36+
37+
* [MerchDocs (user guide)]({{ site.user_guide_url }}/payment-services/index.html)---See our Payment Services-related user guide documentation.
38+
* [Help center](https://support.magento.com/hc/en-us)---See our Payment Services-related knowledgebase and [submit Support tickets](https://support.magento.com/hc/en-us/articles/360000913794#submit-ticket) for extra help.

0 commit comments

Comments
 (0)