iugu is a VTEX partner solution that offers the following payment options through transparent checkout: credit card, pix and bank slip. Furthermore, it is possible to carry out recurrence and split payment operations (receivables and transactions) between marketplaces.
To add iugu to your store, follow the steps below:
- In the VTEX Admin, go to Store Settings > Payment > Providers, or type Providers in the search bar at the top of the page.
- On the providers screen, click the
New Provider
button. - Type the name iugu in the search bar and click on the name of the provider.
- In the App key and App token fields, enter the information provided by iugu (Account ID and API Key).
- If you wish to modify the identification name to be displayed for the iugu provider on the VTEX Admin screen, enter the information in the Name field in Basic Information.
- In Payment Control, select whether you want to activate the provider in a test environment by clicking Enable test mode.
- If you wish to use the bank slip as a payment method, in Provider fields, fill in the field Prazo de vencimento do boleto (em dias) with the same value configured in your customer area on the iugu portal.
- Click
Save
.
Setting up payment conditions
To process credit card, pix and bank slip payment methods with iugu in your store, follow the steps below:
- In the VTEX Admin, go to Store Settings > Payment > Settings, or type Settings in the search bar at the top of the page.
- In the Payment Conditions tab, click on the
+
button. - Click on the desired payment method (credit card brand name, pix or bank slip).
- Fill the Condition name field with a name of your choice for identification.
- Activate the condition in the Status field.
- In Process with provider select the iugu option.
- For credit card payments, select whether you want to use an anti-fraud system by selecting the Use anti-fraud solution option. It is also possible to configure whether credit card payments should be made in full or in installments (with and without interest).
- If you wish, you can also configure special payment conditions.
- Click
Save
.
After following the indicated steps, iugu provider may take up to 10 minutes to appear at your store's checkout as a payment option.
Before carrying out transactions by credit card, PIX or bank slip with iugu in your store, check whether these payment methods are already enabled in your customer area on the iugu portal.
Setting up split payment on the marketplace with iugu
To process payments on marketplace with split payment with iugu it is necessary to register sellers of your store with the same CNPJ (seller identification number) in the VTEX Admin and in your customer area on the iugu portal.
Find out more about creating sellers on VTEX at Adding a seller and access iugu documentation to create subaccounts (sellers) via area of client or API.
Enable payout split with iugu
To enable payout split with iugu in your store, follow the steps below:
- In the VTEX Admin, go to Store Settings > Payment > Providers, or type Providers in the search bar at the top of the page.
- Type the name iugu in the search bar and click on the name of the provider.
- In Details, click on the
Edit
button. - In Payment control, select the option Enable payout split and send payment recipients and indicate the Accountable for payment processing charges and Accountable for chargebacks (marketplace, sellers or marketplaces and sellers).
- Click
Save
.
The payout split option is not available for use in a test environment.
After following the steps indicated, the payout split functionality with the iugu provider may take up to 10 minutes to be activated in your store.
To define specific commissions for each seller in your store, access Marketplace > Sellers> Management in the VTEX Admin, select the desired seller and enter the commission values in Commissions.
Setting up recurrence with iugu
To make recurrence available as a special payment condition through iugu, it is necessary:
- Enable recurrence mode in the VTEX Admin.
- Configure credit card or bank slip payment methods in the VTEX Admin and iugu.
- Configure the subscriptions functionality in your store.