Synchrony Digital Buy Extension Development User Guide

(1)

October 13, 2020 1:05 PM

1. Extension

Synchrony Digital Buy (Extension) Overview:

(2)

October 13, 2020 1:05 PM

Table of Contents

1. Extension ... 1

2. Installation/Upgrading ... 5

2.1. Installation Through Composer ...5

2.2. Network Considerations ...5

3. Configuration ... 6

3.1. Navigating to the Configuration Settings...6

3.2 Configuration Details ...6

3.2.1 API Credentials ... 6

3.2.1.1 Production ... 7

Digital Buy Revolving API Merchant ID ... 7

Digital Buy Revolving API Password ... 8

Digital Buy Installment API Merchant ID ... 8

Digital Buy Installment API Password ... 8

Buy Service API Username ... 8

Buy Service API Password ... 8

Buy Service API Merchant ID ... 8

Proxy Enable (Yes/No) ... 8

3.2.1.2 Sandbox ... 8

Digital Buy Revolving API Merchant ID ... 9

Digital Buy Revolving API Password ... 9

Digital Buy Installment API Merchant ID ... 9

Digital Buy Installment API Password ... 9

Buy Service API Username ... 9

Buy Service API Password ... 9

Buy Service API Merchant ID ... 9

Proxy Enable (Yes/No) ... 9

3.2.2 Synchrony Digital Buy Revolving Payment ... 9

Enable Synchrony Digital Buy Revolving Payment... 10

Title ... 10

Payment Action ... 11

Sort Order ... 11

Digital Buy Available in Cart ... 11

Cart Button Image URL ... 11

Add address match note to payment form ... 11

Cart Button Image Alt Text ... 11

Default Promo Code ... 12

3.2.3 Synchrony Digital Buy Installment Payment ... 12

Enable Synchrony Digital Buy Installment Payment ... 12

Title ... 12

Payment Action ... 12

Sort Order ... 13

Product Group Code ... 13

3.2.4 Common Payment Settings... 13

Payment Applicable From ... 13

(3)

October 13, 2020 1:05 PM

Prohibited Product Attributes Sets ... 13

Address Passed to Digital Buy Modals ... 13

Add Address Match Note to Payment Form ... 14

3.2.5 Revolving Payment Marketing ... 14

Apply Now URL ... 14

Header and Footer Links ... 14

Link CMS Page... 14

Enable Header Link ... 14

Enable Footer Link ... 14

Product Pages & Checkout ... 14

Ad Strategy ... 14

Enabled ... 14

Display Area ... 15

Min Amount ... 15

Static Block ... 15

Start Date (YYYY-MM-DD) ... 15

End Date (YYYY-MM-DD) ... 15

3.2.6 Advanced Settings ... 15

Module Version (X.X.X) ... 15

API Request Timeout ... 15

Digital Buy API ... 15

Production Authentication API Endpoint ... 15

Sandbox Authentication API Endpoint ... 16

Production Status Inquiry API Endpoint ... 16

Sandbox Status Inquiry API Endpoint ... 16

Production Capture API End Point ... 16

Sandbox Capture API End Point ... 16

Buy Service API ... 16

Production Buy Service API Endpoint ... 16

Buy Service Merchant ID ... 16

Buy Service Client Value ... 16

Buy Service Partner Code Value ... 17

4 Synchrony Promotions ... 17

4.2 Promotion Management ... 17

4.3 General Information Regarding Promotions ... 18

4.4 Adding a Promotion Rule ... 18

(4)

October 13, 2020 1:05 PM

5 Order Management of Synchrony Digital Buy Orders ... 21

5.2 Invoicing ... 22

5.3 Credit Memos & Refunds ... 22

5.4 Transactions ... 23

6 Digital Buy Customer Experience ... 24

6.2 Account Lookup ... 24

6.2.1 By First, Last, Zip Code, SSN ... 24

6.2.2 By Card Information ... 25

6.2.3 Applying for a Synchrony Credit Card ... 26

6.3 From Cart ... 27

(5)

October 13, 2020 1:05 PM

2. Installation/Upgrading

The official Synchrony Digital Buy Extension release is distributed through Magento Marketplace.

It’s recommended to install extension by adding corresponding composer package dependency via command-line interface (CLI). Alternatively, extension can be installed via Extension

Manager from Magento Admin Panel. Early adopters should install provided archive with extension as a local composer package artifact.

2.1. Installation Through Composer

Latest instructions on how to install/update Magento Marketplace extension via CLI could be found in official Magento documentation here:

https://devdocs.magento.com/extensions/install/

A bit more specific guide in case of Magento Cloud could be found here:

https://devdocs.magento.com/guides/v2.3/cloud/howtos/install-components.html Composer command to add extension package would be as follows:

composer require synchrony/digital-buy-magento2-module:1.0.0

Make sure to update package version to current stable release version number. 2.2. Network Considerations

By default, the extension is performing server-to-server outbound connections to the following domains: 1. buy.syf.com 2. ubuy.syf.com 3. svcs.syf.com 4. usvcs.syf.com 5. www.b2bcreditservices.com 6. iwww.b2bcreditservices.com

(6)

October 13, 2020 1:05 PM

3. Configuration

3.1. Navigating to the Configuration Settings

The Synchrony Digital Buy Extension configuration settings can be found under the Magento Payment Methods configuration section in the backend administration area.

1. Login to the backend administration dashboard as a Magento admin user.

2. In the main left-hand navigation, click on Stores > Configuration to navigate to the Magento settings area.

3. In the Settings configuration area, select Sales > Payment Methods from the left-hand navigation.

4. In the Payment Method configuration, scroll down to the “Synchrony Digital Buy” method and click the “Configure” button to view the available configuration sections for the payment method.

5. You should see the below configuration section. If you do not, make sure you have the Store View dropdown in the upper-left set to the Default or Website scope.

3.2 Configuration Details 3.2.1 API Credentials

(7)

October 13, 2020 1:05 PM

Use Sandbox

This toggles weather or not the payment method should use the Synchrony sandbox servers. Setting this to “Yes” will allow you to test the payment method in development environments.

3.2.1.1 Production

(8)

October 13, 2020 1:05 PM

Your Digital Buy merchant ID / username. This will be provided to you by your Synchrony account representative.

Digital Buy Revolving API Password

Your Digital Buy password. This will be provided to you by your Synchrony account representative.

Digital Buy Installment API Merchant ID

Digital Buy Installment API Password

Buy Service API Username

Merchant Web Services username. This will be provided to you by your Synchrony account representative.

Buy Service API Password

Your Web Services password. This will be provided to you by your Synchrony account representative.

Buy Service API Merchant ID

Your Web Services password. This will be provided to you by your Synchrony account representative. (Leave empty if same as for Digital Buy API (Revolving or Installment) Proxy Enable (Yes/No)

To be used if you run Magento through a proxy.

(9)

October 13, 2020 1:05 PM

Digital Buy Revolving API Merchant ID

Digital Buy Revolving API Password

Digital Buy Installment API Merchant ID

Digital Buy Installment API Password

Buy Service API Username

Merchant Web Services username. This will be provided to you by your Synchrony account representative.

Buy Service API Password

Your Web Services password. This will be provided to you by your Synchrony account representative.

Buy Service API Merchant ID

Your Web Services password. This will be provided to you by your Synchrony account representative. (Leave empty if same as for Digital Buy API (Revolving or Installment) Proxy Enable (Yes/No)

(10)

October 13, 2020 1:05 PM

Enable Synchrony Digital Buy Revolving Payment

Enable or disable the extension entirely. Disabling the extension will not alter any existing Digital Buy orders that are already in the system, but it will prevent them from being captured or refunded if they are in an authorized-only state.

Title

(11)

October 13, 2020 1:05 PM

Payment Action

The Digital Buy payment method can be configured in two ways: • Authorize Only

• Authorize and Capture

The first, Authorize Only, will not capture payment at the time of the order. Instead, payment will need to be manually captured in the form of an invoice.

Authorize and Capture mode will capture the funds immediately at the time of the order.

Sort Order

The location in which the Synchrony Digital Buy method will be seen next to other payment methods that are configured when the customer is on the Payment Method screen in checkout.

Digital Buy Available in Cart

Setting this to yes will display a button in the cart that allows customers to initiate payment directly from the cart screen. This can speed up the checkout process. Cart Button Image URL

The full URL to a custom image that will be used in the cart as the button (above). If nothing is specified in this field, the default Synchrony Digital Buy button image will be used.

Add address match note to payment form

Limit the availability of the payment method to customers whose billing address matches specific countries. By default, all countries are allowed.

Cart Button Image Alt Text

(12)

October 13, 2020 1:05 PM

Default Promo Code

The default Synchrony promotion code. This will be provided to you by your Synchrony account manager.

3.2.3 Synchrony Digital Buy Installment Payment

Enable Synchrony Digital Buy Installment Payment

Enable or disable the extension entirely. Disabling the extension will not alter any existing Digital Buy orders that are already in the system, but it will prevent them from being captured or refunded if they are in an authorized-only state.

Title

This text is what is used on the payment method section of checkout. Default is Installment (Synchrony) but can easily be changed with approval from SYF Digital Marketing team.

Payment Action

The Digital Buy payment method can be configured in two ways: • Authorize Only

• Authorize and Capture

The first, Authorize Only, will not capture payment at the time of the order. Instead, payment will need to be manually captured in the form of an invoice.

(13)

October 13, 2020 1:05 PM

Sort Order

The location in which the Synchrony Digital Buy method will be seen next to other payment methods that are configured when the customer is on the Payment Method screen in checkout.

Product Group Code

This will be provided to you by your Synchrony account manager. 3.2.4 Common Payment Settings

Payment Applicable From All Allowed Countries (Default) Countries Payment Applicable From

If the above configuration value is set to “Specific Countries” then the countries it should be limited to should be selected here. If the billing address is not one of these countries, then the payment method will not be available.

Prohibited Product Attributes Sets

Payment method won't be available if cart contains products with selected attribute sets to be excluded from Synchrony Financing eligibility.

Address Passed to Digital Buy Modals

(14)

October 13, 2020 1:05 PM

Add Address Match Note to Payment Form

Adds a small note on the Payment Method step of checkout reminding customers to make sure that the address they enter matches what the address associated with their Synchrony credit card.

3.2.5 Revolving Payment Marketing Apply Now URL

URL for Apply Now links Header and Footer Links

Link CMS Page

CMS page the links should lead to. Default “Financing”. Enable Header Link

Display link to financial page as part of website header (next to sign in link) Enable Footer Link

Display link to financial page as part of website footer (footer links list) Product Pages & Checkout

Ad Strategy

Block content strategy, "Value prop message" will display selected static block content, "Monthly payment message" will calculate monthly payment and display terms based on promo type

Enabled

(15)

October 13, 2020 1:05 PM

Display Area

Where pricing information should be displayed. Product Details Page (PDP, Checkout or BOTH.

Min Amount

Minimum product price or purchase amount to display the block Static Block

Which static block to use (referenced by identifier). Dropdown contains various Magento and Synchrony static blocks contained in Magento admin and deployed with Digital Buy extension.

Start Date (YYYY-MM-DD)

Display block from this date, optional End Date (YYYY-MM-DD)

Stop displaying block after this date, optional

3.2.6 Advanced Settings

Module Version (X.X.X) API Request Timeout

The number of seconds until API requests time out. Increasing the values can help if you are seeing frequent timeouts however it’s not recommended you increase this value past 15 seconds.

Digital Buy API

Production Authentication API Endpoint

(16)

October 13, 2020 1:05 PM

Sandbox Authentication API Endpoint

Allows you to over-ride the sandbox API endpoint for the Digital Buy Authentication service.

Production Status Inquiry API Endpoint

Allows you to over-ride the production API endpoint for the Digital Buy status inquiry service.

Sandbox Status Inquiry API Endpoint

Allows you to over-ride the sandbox API endpoint for the Digital Buy status inquiry service.

Production Capture API End Point

Allows you to over-ride the Production Capture API End Point. Sandbox Capture API End Point

Allows you to over-ride the Sandbox Capture API End Point.

Buy Service API

Production Buy Service API Endpoint Sandbox Buy Service API Endpoint Buy Service Merchant ID

Optional value to pass along with transactions. Will be provided by your Synchrony account representative.

Buy Service Client Value

(17)

October 13, 2020 1:05 PM

Buy Service Partner Code Value

Optional value to pass along with transactions. Will be provided by your Synchrony account representative.

4 Synchrony Promotions

Configuring Synchrony promotions is done through the Magento backend with the assistance of your Synchrony account representative. It’s extremely important to ensure that promotions are configured correctly to prevent errors from occurring during the customer sales experience. Working with your Synchrony account representative to validate your promotion setup is a critical step in ensuring that your store is properly setup.

4.2 Promotion Management

1. Login to the backend administration dashboard as a Magento admin user.

2. In the main left-hand navigation, click on Stores > Configuration to navigate to the Magento settings area.

(18)

October 13, 2020 1:05 PM

4.3 General Information Regarding Promotions

Synchrony Promotions are not Magento promotions but a custom rule that allows for fine-tuned control over what Synchrony promotional disclosures are applied to what products in the customer’s cart.

Configuration of promotions must be done in a way in that there can never be more than 3 promotional codes applied in the cart. Failure to ensure this will result in the customer experiencing an error and the merchant administrator receiving an email notification. WARNING: Magento typically supports Partial Invoicing (being able to invoice line item or partial quantity of an order. Due to regulatory limitations, if more than one Synchrony promotion applies to an order, the order will not be able to be partially invoiced. The same goes for refunding.

(19)

October 13, 2020 1:05 PM

Rule Name

A simple name for the rule. This is displayed only to the merchant administrators in the backend. It is displayed on the promotion list screen that displays all promotions in the system and also on the order detail screen when viewing an individual order. Providing it a descriptive name is recommended.

(20)

October 13, 2020 1:05 PM

Description

A small description of what the promotion is configured to be applied to. Code

The promotional code. This will be provided to you by your Synchrony account manager. Active

Is the promotion active. Websites

What websites is the promotion applicable to? Customer Groups

What customer groups will the promotion be applicable to. Typically, all groups would be recommended unless there is a specific need to target a specific group.

From

The date the promotion code is valid from. A date in the past would be recommended for most.

To

The date the promotion code is valid until. A date far in the future would be recommended for most.

Priority

The priority value for the promotion. When multiple promotion rules match for a single item in the cart, the one with the LOWEST priority value is used.

(21)

October 13, 2020 1:05 PM

Please refer to the Magento documentation for how Conditions work. 4.4.3 Actions

Please refer to the Magento documentation for how Actions work.

5 Order Management of Synchrony Digital Buy Orders

(22)

October 13, 2020 1:05 PM

There are a few notable limitations that are applicable to orders made with the Synchrony Digital Buymethod. The most notable of which is that due to regulatory limitations, if more than one Synchrony promotion applies to an order, the order will not be able to be partially invoiced.

5.2 Invoicing

1. Login to the Admin Dashboard as a Magento admin user 2. Go to Sales > Orders page

3. Open an order which has not yet been captured 4. Click “Invoice”

a. Note: The Invoice button does not appear for orders placed with the “Authorize and Capture” payment action.

5. If you need to generate a partial invoice, do the following:

a. In the Items to Invoice section, update the Qty to Invoice column to include only specific items on the invoice.

b. Then click “Update Qty’s”.

6. If an online payment method was used for the order, set the Amount to the appropriate option.

7. To notify customers by email when the invoice is generated, do the following: a. Mark the “Email Copy of Invoice” checkbox

b. Enter any “Invoice Comments”. To include the comments in the notification email, mark the “Append Comments” checkbox

8. When complete, click “Submit Invoice” at the bottom of the page

WARNING: Due to regulatory limitations, if more than one Synchrony promotion applies to an order, the order will not be able to be partially invoiced.

5.3 Credit Memos & Refunds

A credit memo is a document that shows the amount that is owed to the customer. The amount can be applied toward a purchase or refunded to the customer.

1. Login to the Admin Dashboard as a Magento admin user 2. Go to Sales > Orders page

3. Open an order which has been captured 4. Switch to the “Invoices” tab

5. In the upper right corner, click “Credit Memo”.

a. Note: The button appears only after an order is invoiced. 6. Do one of the following:

(23)

October 13, 2020 1:05 PM

b. If the product will not be returned to inventory, leave the checkbox blank c. The “Return to Stock” checkbox appears only if inventory Stock Options are

set to “Decrease Stock When Order Is Placed.” 7. Complete the following:

a. In the “Qty to Refund” box, enter the number of items to be returned. Then press the “Enter” key to record the change. The Update Qty’s button

becomes active

b. Enter 0 for the “Qty to Refund” of any items that are not to be refunded c. Click “Update Qty’s” button to recalculate the total. (The amount to be

credited cannot exceed the maximum amount that is available for refund.) 8. Step 8: In the “Refund Totals” section do the following, as applicable:

a. In the “Refund Shipping” field, enter any amount that is to be refunded from the shipping fee. This field initially displays the total shipping amount from the order that is available for refund. It is equal to the full shipping amount from the order, less any shipping amount that has already been refunded. Like the quantity, the amount can be reduced but not increased.

b. In the “Adjustment Refund” field, enter a value to be added to the total amount refunded as an additional refund that does not apply to any part of the order (shipping, items, or tax). The amount entered cannot raise the total refund higher than the paid amount.

c. In the “Adjustment Fee” field, enter a value to be subtracted from the total amount refunded. This amount is not subtracted from a specific section of the order such as shipping, items, or tax.

d. If the purchase was paid with store credit, mark the “Refund to Store Credit” checkbox. The amount will be credited to the customer’s account balance. e. To add a comment, enter the text in the “Credit Memo Comments” box. f. To send an email notification to the customer, mark the “Email Copy of

Credit Memo” checkbox.

g. To include the comments, you have entered in the email, mark the “Append Comments” checkbox.

9. Step 9: Click “Refund”

WARNING: Due to regulatory limitations, if more than one Synchrony promotion applies to an order, refunds can only be done for the entire order.

5.4 Transactions

(24)

October 13, 2020 1:05 PM

6 Digital Buy Customer Experience

The Synchrony Digital Buy experience differs from standard payment methods in the way the customer is moved through the checkout flow. It more resembles the PayPal experience in that it moves the customer out of the typical checkout flow to the Digital Buy experience and before returning the customer back to the Magento checkout flow.

The checkout experience differs slightly based on where it was initiated from (cart or regular checkout) but the first step of the Digital Buy experience (Account Lookup) is the same regardless.

6.2 Account Lookup

The Synchrony Digital Buy payment method does not allow for standard credit card entry on the payment step of Magento.

Instead, the user looks up the account which results in a token that’s used by Magento to transact against. The account lookup can be done in one of two ways on the initial Digital Buy screen:

6.2.1 By First, Last, Zip Code, SSN

(25)

October 13, 2020 1:05 PM

6.2.2 By Card Information

(26)

October 13, 2020 1:05 PM

6.2.3 Applying for a Synchrony Credit Card

In the event that a custom has no account with Synchrony, the Digital Buy payment method allows them to apply for a credit card through the Digital Buy experience.

(27)

October 13, 2020 1:05 PM

Upon application completion, the customer will be notified if they have been denied (in which case they will be sent back to the cart) or approved, in which case they are returned to the checkout flow (their new card will be used for the purchase).

NOTE: This is used for checkout purposes. The extension will NEVER store any type of card information used by the customer in the account lookup or order.

6.3 From Cart

This is the customer flow when initiating the Synchrony Digital Buy experience directly from the Cart:

a. The customer will click on the Synchrony Private Label Credit Card button image in the cart. This image can be configured in the Magento backend.

b. The customer is sent into the Digital Buy experience to lookup their account information (see above section).

c. Upon a successful lookup, the user will click continue and be sent into the Checkout flow.

d. Once in the checkout flow, the customer can update their shipping information. They can update their billing information as well, however it MUST match what Synchrony has on file. The customer will then click the Continue to Payment button. e. The customer enters into the Digital Buy experience again to confirm any

promotions that might apply to this order. Once they click accept, they are returned to the checkout flow.

(28)

October 13, 2020 1:05 PM

6.4 From Checkout

This is the customer flow when initiating the Synchrony Digital Buy experience through the standard Checkout flow:

a. The customer will proceed through the Checkout flow as normal.

a. The customer will be able to either login (and select a shipping address from their address book) or proceed as a guest (and fill in the shipping address information manually).

b. When presented with the Payment method, they will select the

Synchrony Digital Buymethod and click the Continue to Payment button. b. The customer is sent into the Digital Buy experience to lookup their account

information (see above section).

c. Upon a successful lookup, the user will click continue and be sent into the Promotional Disclosure screen.

d. The customer then confirms any promotions that might apply to this order. Once they click accept, they are returned to the checkout flow.