On VTEX, you can integrate with the easypay payment provider. Your store can sell using easypay, MBWay, and MultiBanco through this provider.

To use easypay, you need to:

• Install the easypay app
• Configure the easypay app
• Configure the easypay webhook
• Configure the easypay affiliation
• Configure payment with Apple Pay on easypay (optional)

If you are a marketplace or seller, read Configuring payment with easypay in a marketplace or Configuring payment with easypay seller.

To install the easypay app, follow the steps below:

1. In the VTEX IO CLI, run the command vtex login accountname to log in to your account.
2. Install the easypay app using the vtex install easypaypartnerpt.payment-provider-easypay command.

After installing the easypay app, you need to configure it. To access the settings screen, follow the steps below:

1. In the VTEX Admin, go to Extensions Hub > App Management, or type App Management in the search bar at the top of the page.
2. Find the Easypay Payment Provider app and click Settings.

Configuration is divided in four sections:

• easypay credentials (required)
• Payment (required)
• easypay checkout customization (required)
• Sandbox mode

You must set up the following configurations in the easypay environment. easypay controls these settings, therefore, VTEX does not guarantee that the steps below will be permanently updated. Use this document as a reference and check your easypay environment for up-to-date information.

The information in this section must be completed.

Key ID e Key Value: easypay key value and ID.

Merchant account UID: identification of the merchant account where purchase amounts from store sales will be deposited. If there is no separate merchant account, you can use the "Account UID" of the payment account.

Margin account UID: identification of the margin account.

This field should only be completed if the store is a marketplace and splits payments. Learn more in the Configuring payment with easypay in a marketplace article.

Refund account ID and Refund account key: If there is no specific refund account, the Key ID value must be entered in the Refund account ID field, and the Key value in the Refund account key.

In this section, you must indicate whether your store will use asynchronous and/or synchronous payments. See the easypay documentation to check the available payment methods and their identification acronyms.

Accepted asynchronous payment types: asynchronous payment methods available to the customer. Only enter the acronyms of the asynchronous payment types, separated by commas without periods or spaces.

Example:

Correct	Incorrect
mb,dd,vi	mb, dd, vi

If you complete this field, you must also complete the Expiration days for asynchronous payments field.

Accepted synchronous payment types: synchronous payment methods available to the customer. Only enter the acronyms of the synchronous payment types, separated by commas without periods or spaces.

Example:

Correct	Incorrect
cc,mbw	cc, mbw

Expiration days for asynchronous payments: expiration period, in days, for asynchronous payments. Only enter the desired number of days.

Example:

Correct	Incorrect
10	10 days, Dec, or 05/10/2023

easypay has a native checkout layout configured in the app. See below:

If you want to customize easypay's native checkout, complete one or more fields in this section:

• Checkout logo URL: logo displayed at the easypay checkout. Enter the link to the image you want to use
• Checkout background color: background color. Enter the HEX code of the desired color. Native default: #ffffff.
• Checkout accent color: highlight color, button pattern, and input borders. Enter the HEX code of the desired color. Native default: #0d71f9.
• Checkout error color: error message color. Enter the HEX code of the desired color. Native default: #ff151f.
• Checkout input background color: input background color. Enter the HEX code of the desired color. Native default: transparent.
• Checkout input border color: input border color. Enter the HEX code of the desired color. Native default: the same color used in the accent color.
• Checkout input border radius: allows you to define the rounded borders of the inputs. Enter the desired value in pixels (numbers only). Native default: 50 pixels.

Example:

Correct	Incorrect
35	35px

• Checkout button background color: background color of the buttons. Enter the HEX code of the desired color. Native default: the same color used in the accent color.
• Checkout button border radius: allows you to set the rounded borders of the buttons. Enter the desired value in pixels (numbers only). Native default: 50 pixels.

Example:

Correct	Incorrect
30	30px

• Checkout button box shadow: option to enable or disable the button shadow.

• Checkout font family: fonts used in texts. Enter the generic family name, web-safe font, or font link. Native default: Overpass. Example, correct: sans-serif, verdana, ou https://fonts.gstatic.com/s/overpass/v12/qFda35WCmI96Ajtm83upeyoaX6QPnlo6_PPbM5qKl8Kuo8AzesE.woff2

• Checkout base font size: allows you to set the font size in the root element. Enter the desired value in pixels (numbers only). Native default: 10 pixels.

Example:

Correct	Incorrect
11	11px

Do not use fonts over 12 pixels, as they can blur the layout.

To enable the development test environment, select the Enable sandbox mode option. You must use test credentials.

After completing the configuration fields, click Save.

To configure the easypay webhook, follow the steps below:

https://{your-account-name}.myvtex.com/_v/easypaypartnerpt.payment-provider-easypay/webhook

To configure the easypay affiliation, follow the steps below:

1. In the VTEX Admin, go to Store Settings > Payment > Providers, or type Providers in the search bar at the top of the page.
2. On the providers screen, click the New Provider button.
3. Type the name easypay in the search bar and click on the name of the provider.
4. Complete the Application Key and Application Token fields with your easypay account information.
5. In Payment Settlement, select the Use Payment Behavior Recommended by Payment Processor option.
6. In Enable payout split and sending payment recipients?, select Yes.
7. Click Save.

To process payments with Apple Pay on easypay, you must first perform configurations to enable your store in the Apple Pay environment. Learn more at Setting up Merchant ID in Apple Pay.

To configure other payment methods that easypay will process, read the Configuring payment conditions article.

To set special conditions for payment methods, read Configuring payment special conditions.

After following the instructions, it can take up to 10 minutes for the easypay connector to be displayed as a payment option at your store checkout.