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

Commit 1f86fb6

Browse files
shrieleneedshevtsov
authored andcommitted
PAY-658: Payout report view (#852)
* Add Payout reports topic, assets img folder and parent magento-payments folder * Add Report information and Transaction types sections * Clean up section headers and move content * Fixed broken hash link * Revise per PR comments * Rework and rename per UI change * Changed to Payouts terminology * Revised per Andy review * Remove mention of across providers per Hatinder PAY-226: Magento Payments info architecture (#890) * Add topics * Add front matter to topics * Add topics to sales.yml * Work on navs menus * Revise TOC, config yaml, etc for topics mock PAY-744: Order payment status reports (#911) * Add new Order payment status topic * Complete topic * Make edits per revision * Add topic to sales.yml for TOC * Remove transactions * Apply suggestions from code review Link revisions per Leslie review Co-authored-by: Leslie Tilling <[email protected]> Co-authored-by: Leslie Tilling <[email protected]> PAY-850: Revise Payouts doc to reflect date picker changes (#979) * Revise based on calendar/date picker changes and mechanism for specifying date range * Revise month day format * Change verbiage of customize timeframe PAY-776: Onboarding Magento Payments topic (#1036) * Add initial Prereqs, summary info to onboarding-payments.md * Add initial Obtain API credentials and Configure Magento Services content to onboarding-payments.md * Add more Configure Magento Services section content * Add Set Magento Payments as payment method section content * Add Enable live payments and Activate live payments sections * Add view edit sandbox image, further clarifications on onboarding-payments.md page * Add onboarding flow and related info * Revise topic per Russ review, block out password in screenshot * Revise topic per Igor review * Final revision about enabling sandbox vs live payments PAY-663: Payments overview topic (#1064) * Move intro out of Onboarding and to overview page, add top and features content to overview * Remove architecture mention and include link to onboarding from Get started section * Add Support section * Add more features * Revision per Russ review * Add Get extension section to Onboarding topic, revise wording of overview per Craig review * Remove commented out text * Comment out analytics dashboard line item in overview topic * Remove style choices per Leslie review * Fixing linting issues Revise Onboarding flow diagram with new version (#1073) PAY-621: Voids summary (#1080) * Brainstorming content * Add overview information about Magento void functionality * Rework text per Ian and Craig review * Update src/magento-payments/voids.md Co-authored-by: Leslie Tilling <[email protected]> Co-authored-by: Leslie Tilling <[email protected]> Update voids.md with links to documentation Add Security sections and more intro info Add Order recalc section info Minor changes per review Minor wording change Wording change per Igor review Add info about order recalc per Igor Update src/magento-payments/payments-options.md Co-authored-by: Leslie Tilling <[email protected]> Reword Order recalculation section to be more accurate Ad Pay Now button to payments-options.md Add Messaging section to Pay Later in Payments options topic, add PayPal Smart Buttons and Config sections to Configure payments topic Remove errant text Revisions per Craig and Igor review Fix weird spacing issue Generalize Pay Later messaging and options Add note about amounts subject to change Apply suggestions from code review Editorial review feedback from Leslie Co-authored-by: Leslie Tilling <[email protected]> Add info about PP not passing billing address during checkout to payments-options.md Add warning note about revoking Commerce Payments for processing payments in managing-payments.md and onboarding-payments.md Add info that this is done in PP settings Revision per Ian review Added revision to other page Add content for Refunds topic Clarifying changes to the Credit memos topic Add clarifying information to the revoke consent to Commerce Payments warnings Add Refund workflow section to Credit memos topic, add necessry info to new Refunds topic Reorganize Refund method section of credit memos to be clearer Fix spelling error Clarify account credit and reorganize in Credit memos topic Remove content from note on two pages Apply suggestions from code review Review from Leslie Co-authored-by: Leslie Tilling <[email protected]> Start adding install extension content before moving it to DevDocs Add link to DevDocs in Installing payments topic Remove extra heading from Installing payments Move Installing extension topic to child of Onboarding topic Revisions per Leslie review Replaced Magento Services w/Commerce Services in Onboarding payments topic Replaced Magento Services w/Commerce Services in Payments top level topic Link fixes Terminology changes and Leslie review revisions Add Checkout from product page section to Payments options topic Add PayPal button section to Payments options Fix trailing spaces error Revisions per Oleksandr review Minor wording change Revisions per Igor review Revise Onboarding payments topic per Admin UI changes Minor revisino to Onboarding payments Fixed error in Admin navigation string Apply suggestions from code review Co-authored-by: Erik Marr <[email protected]> Add Availability section to Payments overview about availability for supported versions Add Config options table for Configure PayPal Smart Buttons Add Config options table for Configure Credit Card FIelds Add Security section to Credit Card Fields Add General Configuration config section to be completed later and verbiage communicating that pay options config applies to the environment selected in that config Revisions per Leslie review Add Test in sandbox environment section, add Test in production section and related content Revise testing topic name in TOC, move testing into to Testing and validating topic, include links in onboarding to relevant info Add testing step to Onboarding topic Rename Get extension section to be more accurate Revision per Russ review Revise configure info in Onboarding payments topic Revise configure info in Configure payments topic, add General configuration sections Clarify production and sandbox merchant ID use Clarify Method config options per Ian review Formatting and heading changes per Leslie review Change TOCs and folder name Change naming/branding in all current topics Changes per Igor review Remove existing magento-payments directory Clarify warning on Managing payments topic Remove Magento from Admin mention in Payments Services top-level topic Add order-to-cash.md topic, Data export info, make changes to Payouts topic Change topic name and rejigger order-payment-status.md to be the Order payment status report topic Spelling grammar change Update column descriptions for Order payment status Add info about the data export and how to manually complete the steps Fix typo Revise top level page to be more apt, minimize smart buttons copy Remove Fraud topic and move PCI info for buttons to PCI compliance topic Fix linting issue Update src/payment-services/payments-options.md Co-authored-by: Leslie Tilling <[email protected]> Update column descriptions for Payouts statuses Remove extra space Change Magento to Commerce for order and transaction ID mentions Review revisions Accuracy change Move technical content to DevDocs PR and revise Configure data export section Remove old onboarding flow images, added new simplified one to Payment Services overview topic Move onboarding flow to onboarding topic, re-add missing image file Revise instructions and column descriptions per recent changes in parent issue Clean up payments.md topic Clean up payments-options.md Clean up onboarding-payments.md Clean up configuring-payments.md Clean up payouts.md Clean up order-payment-status.md Clean up financial-reporting.md Clean up managing-payments.md Clean up pci.md Add minor info to security.md Add info and cleanup testing-validation.md Add EAP banner to pages Revisions per Dima review Revision leftover Change main page name to index.md and fix related links Revisions per review, change to non-gerund titles and fix links Add Select data source section to the Order payment status topic Add Select data source section to the Payouts topic Revisions per Randy Oleksandr review, add note about onboarding live to get reports Fix broken links
1 parent 94eb1ba commit 1f86fb6

25 files changed

+883
-11
lines changed

_config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,11 @@ defaults:
146146
path: payment
147147
values:
148148
group: sales
149+
-
150+
scope:
151+
path: magento-payments
152+
values:
153+
group: sales
149154
-
150155
scope:
151156
path: configuration

src/_data/main-nav.yml

+3
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,9 @@
159159
- label: Payments
160160
url: /payment/payments.html
161161

162+
- label: Payment Services
163+
url: /payment-services/index.html
164+
162165
- label: Delivery
163166
url: /shipping/delivery.html
164167

src/_data/toc/sales.yml

+33
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,39 @@ pages:
239239
url: "/payment/zero-subtotal-checkout.html"
240240
- label: Fraud Protection
241241
url: "/sales/fraud-protection.html"
242+
- label: Payment Services
243+
url: "/payment-services/index.html"
244+
children:
245+
- label: Payment options
246+
url: "/payment-services/payments-options.html"
247+
- label: Onboard Payment Services
248+
url: "/payment-services/onboard-payments.html"
249+
children:
250+
- label: Install Payment Services
251+
url: "/payment-services/install-payments.html"
252+
- label: Configure Payment Services
253+
url: "/payment-services/configure-payments.html"
254+
- label: Financial reporting
255+
url: "/payment-services/financial-reporting.html"
256+
children:
257+
- label: Payouts report
258+
url: "/payment-services/payouts.html"
259+
- label: Order payment status report
260+
url: "/payment-services/order-payment-status.html"
261+
- label: Manage payments
262+
url: "/payment-services/manage-payments.html"
263+
children:
264+
- label: Refunds
265+
url: "/payment-services/refunds.html"
266+
- label: Voids
267+
url: "/payment-services/voids.html"
268+
- label: Security
269+
url: "/payment-services/security.html"
270+
children:
271+
- label: PCI compliance
272+
url: "/payment-services/pci.html"
273+
- label: Test and validate
274+
url: "/payment-services/test-validate.html"
242275
- label: Delivery
243276
url: "/shipping/delivery.html"
244277
children:

src/_includes/layout/page-header.html

+14-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
<!-- page-header -->
22
<section class="page-intro">
3-
{% include layout/edition-callout.html %}
4-
<h1 class="page-title">{{ page.title }}</h1>
5-
{% include layout/github-links.html %}
6-
</section>
7-
3+
4+
<h1 class="page-title">{{ page.title }}</h1>
5+
6+
{% include layout/github-links.html %}
7+
8+
{% include layout/edition-callout.html %}
9+
10+
{% if page.url contains "payment-services/" %}
11+
<div class="message-banner">
12+
This Payment Services functionality is available for Early Access Program (EAP) participants only.
13+
</div>
14+
{% endif %}
15+
16+
</section>

src/images/images/btn-download.png

1.05 KB
Loading
35 KB
Loading
Loading
Loading
Loading
156 KB
Loading
+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: Configure Payment Services
3+
---
4+
5+
You can customize Payment Services to your needs with helpful configuration options in the Admin.
6+
7+
When you configure Payment Services for {{ site.data.var.ee }} and {{ site.data.var.ce }} in the Admin, those configurations apply only to the environment that is set in the Method field of General Configuration. Any changes you make in the configuration fields are independent of switching the Method selection---if you switch the method, your selections will not reset.
8+
9+
See the [General Configuration section](#general-configuration) for more information.
10+
11+
## General configuration
12+
13+
You can enable Payment Services for your store, and enable either sandbox testing or live payments in the General Configuration section.
14+
15+
1. On the _Admin_ sidebar, go to **Stores** > _Settings_ > **Configuration**.
16+
1. In the left panel, expand **Sales** and choose **Payment Methods**.
17+
1. Expand the _Recommended Solutions_ section.
18+
1. In the _Payment Services_ section, expand the _General Configuration_ section.
19+
1. For **Enable**, set it to `Yes` to enable Payment Services for your store.
20+
1. For **Method**, set it to `Sandbox` if you are still testing Payment Services for your store or `Production` if you are ready to enable live payments.
21+
22+
{:.bs-callout .bs-callout-warning}
23+
Your Sandbox Merchant ID and Production Merchant ID will be auto-generated and present in their respectable fields once you have finished onboarding for the sandbox and/or production. Do not remove or change these IDs.
24+
25+
1. Click <span class="btn">Save Config</span> to save your changes.
26+
27+
### Configuration options
28+
29+
| Field | Scope | Description |
30+
|---|---|---|
31+
| Enable | website | Enable or disable Payment Services for your website. Options: Yes / No |
32+
| Method | store view | Set the method, or environment, for your store. Options: Sandbox / Production |
33+
| Sandbox Merchant ID | store view | Field for your sandbox merchant ID, auto-generated during sandbox onboarding. Do not change or alter this ID. |
34+
| Production Merchant ID | store view | Field for your production merchant ID, auto-generated during sandbox onboarding. Do not change or alter this ID. |
35+
36+
## Credit Card Fields
37+
38+
The Credit Card Fields payment options provide a simple and secure checkout for credit card or debit card payment methods.
39+
40+
See [Payments options]({% link payment-services/payments-options.md %}#paypal-smart-buttons) for more information.
41+
42+
### Configure Credit Card Fields
43+
44+
1. On the _Admin_ sidebar, go to **Stores** > _Settings_ > **Configuration**.
45+
1. In the left panel, expand **Sales** and choose **Payment Methods**.
46+
1. Expand the _Recommended Solutions_ section.
47+
1. In the _Payment Services_ section, expand the _Credit Card Fields_ section.
48+
1. For **Title**, enter text as needed to change the name of the payment method as shown during checkout.
49+
1. Select **Authorize** or **Authorize and Capture** to [set the payment action]({% link payment-services/onboard-payments.md %}#set-payment-services-as-payment-method).
50+
1. For **Debug Mode**, choose `Yes` to enable debug mode (or `No` to disable it).
51+
1. Click <span class="btn">Save Config</span> to save your changes.
52+
53+
#### Configuration options
54+
55+
| Field | Scope | Description |
56+
|---|---|---|
57+
| Title | store view | Add the text to be displayed as the title for this payment option in the Payment Method view during checkout. Options: text field |
58+
| Payment Action | website | The [payment action]({% link configuration/sales/payment-methods.md %}#payment-actions) for the specified payment method. Options: Authorize / Authorize and Capture |
59+
| Debug Mode | website | Enable or disable Debug Mode. Options: Yes / No |
60+
61+
## PayPal Smart Buttons
62+
63+
The PayPal Smart Buttons payment options provide a simple, fast, and secure checkout process for your customer.
64+
65+
See [Payments options]({% link payment-services/payments-options.md %}#paypal-smart-buttons) for more information.
66+
67+
### Configure PayPal Smart Buttons
68+
69+
You can enable and configure the PayPal Smart Buttons payment options within the Admin:
70+
71+
1. On the _Admin_ sidebar, go to **Stores** > _Settings_ > **Configuration**.
72+
1. In the left panel, expand **Sales** and choose **Payment Methods**.
73+
1. Expand the _Recommended Solutions_ section.
74+
1. In the _Payment Services_ section, expand the _PayPal Smart Buttons_ section.
75+
1. Edit the _Title_ field to change the name of the payment method as shown during checkout.
76+
1. Select **Authorize** or **Authorize and Capture** to [set the payment action]({% link payment-services/onboard-payments.md %}#set-payment-services-as-payment-method).
77+
1. Select **No** in the _Display Pay Later Message_ dropdown to disable the [Pay Later messaging]({% link payment-services/payments-options.md %}#pay-later-button) (if desired).
78+
1. Select **Yes** in the _Debug Mode_ dropdown to enable debug mode, or **No** to disable it.
79+
1. Click <span class="btn">Save Config</span> to save your changes.
80+
81+
#### Configuration options
82+
83+
| Field | Scope | Description |
84+
|---|---|---|
85+
| Title | store view | Add the text to be displayed as the title for this payment option in the Payment Method view during checkout. Options: text field |
86+
| Payment Action | website | The [payment action]({% link configuration/sales/payment-methods.md %}#payment-actions) for the specified payment method. Options: Authorize / Authorize and Capture |
87+
| Display Pay Later Message | website | Enable or disable the Pay Later messaging in the shopping cart, product page, mini-cart, and during the checkout flow. Options: Yes / No |
88+
| Debug Mode | website | Enable or disable Debug Mode. options: Yes / No |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Financial reporting
3+
sections:
4+
- title: Payouts report
5+
content: This topic includes reporting for cross-referencing orders and payments or reconciling accounts.
6+
url: /payment-services/payouts.html
7+
8+
- title: Order payment status report
9+
content: This topic includes reporting for quickly viewing the payment status of orders to identify potential issues.
10+
url: /payment-services/order-payment-status.html
11+
---
12+
13+
Payment Services for {{ site.data.var.ee }} and {{ site.data.var.ce }} offers you comprehensive reporting so that you can get a clear view of your store's orders and payments.
14+
15+
Our cash flow management reports---Payouts and Order payment status---synchronize payment details with order info to give you full transparency of processed volume, payment balance, and detailed reporting on a transaction level for financial reconciliation.
16+
17+
{% include grid.html sections=page.sections%}

src/payment-services/index.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Payment Services
3+
---
4+
5+
Payment Services for {{ site.data.var.ee }} and {{ site.data.var.ce }} is your turnkey self-service solution, including sandbox testing and a simple setup, for providing robust and secure payment processing for your Commerce websites.
6+
7+
Whether you are a small business, mid-market contender, or large enterprise, our payments solution will help you reduce operational overhead, increase revenue, and give you useful tools to improve the entire shopper experience.
8+
9+
Payment Services is:
10+
11+
* Easy to set up and maintain
12+
* Designed to maximize your profit
13+
* Safe and secure
14+
* Designed to meet all your payments needs
15+
* Self-contained within the Admin
16+
17+
## Features
18+
19+
{:.bs-callout-info}
20+
Some of the features mentioned here may not yet be available for the Early Adopter Program (EAP).
21+
22+
Payment Services is your one-stop-shop for online checkout (from settlement and refunds to getting paid). We provide powerful tools to give you the insight and control you need to create the best experience for your buyers.
23+
24+
* [**Onboarding**]({% link payment-services/onboard-payments.md %})---Our process guides you through commercial signup, technical configuration, entitlements, sandbox environment configuration, and live payment enablement.
25+
* [**Payment checkout**]({% link payment-services/configure-payments.md %})---Use pertinent local and region-specific payment methods to best serve your customers.
26+
* [**Cash flow management**]({% link payment-services/financial-reporting.md %})---Synchronize payment details with orders to get full transparency to the processed volume, payment balance, and detailed transaction-level reporting for financial reconciliation.
27+
* **Transparent pricing**---Pricing is clear and upfront; what you see is what you get.
28+
29+
## Availability
30+
31+
Payment Services is available for some supported Magento versions.
32+
33+
See [Lifecycle policy](https://devdocs.magento.com/release/lifecycle-policy.html) and [Upcoming releases](https://devdocs.magento.com/release/) for more release and version-specific information.
34+
35+
## Get started
36+
37+
Onboarding and setting up Payment Services is completed in just a few steps:
38+
39+
1. Get the [Payment Services extension]({% link payment-services/install-payments.md %}).
40+
1. Connect your Magento instance to Magento Commerce Services.
41+
1. Onboard and set up the sandbox service.
42+
1. Enable Payment Services as your payment method and start processing test payments.
43+
1. Complete merchant onboarding to enable live payments for your Magento website(s).
44+
1. Activate Payment Services in live mode to begin processing live payments.
45+
46+
See [Onboard Payment Services]({% link payment-services/onboard-payments.md %}) to get the full instructions and start the onboarding process.
47+
48+
## Support
49+
50+
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.
51+
52+
* [DevDocs](https://devdocs.magento.com/payment-services/index.html)---See our Payment Services-related developer documentation.
53+
* [User guide]({% link payment-services/index.md %})---See our Payment Services-related merchant documentation.
54+
* [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.
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Install Payment Services
3+
---
4+
5+
Installing the Payment Services extension for Adobe Commerce and Magento Open Source is a prerequisite step for using Payment Services.
6+
7+
See the [install instructions in our developer documentation](https://devdocs.magento.com/payment-services/install-payments.html) for detailed information on installing the Payments Services extension.
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Manage Payment Services
3+
sections:
4+
- title: Refunds
5+
content: This topic includes information about refunds and the credit memo process.
6+
url: /payment-services/refunds.html
7+
8+
- title: Voids
9+
content: This topic includes information about voids.
10+
url: /payment-services/voids.html
11+
---
12+
13+
With Payment Services, you can use refunds and voids to manage your orders, just like for any other payment solution.
14+
15+
{% include grid.html sections=page.sections%}

0 commit comments

Comments
 (0)