Menu
Feedback
Start here
Tutorials


Payment solutions
Customer Credit - Getting Started
2. Configuring Customer Credit
Configuring Customer Credit

After installing the Customer Credit app, you must perform the following settings:

First access

To perform the initial Customer Credit settings, follow the steps below:

  1. In the VTEX Admin, go to Apps > Customer Credit > Settings, or type Settings in the search bar at the top of the page.
  2. In the Pending section, one or more of the settings listed below may be displayed:

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAFUlEQVR4nGPw9PSsqq7+//9/XX0jACbfBscoqW/oAAAAAElFTkSuQmCC","img":{"src":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_1.JPG","width":1139,"height":266,"type":"jpg"}}

App settings

Then, still on the same VTEX Admin screen(Apps > Customer Credit > Settings), you should check the following settings options:

Tolerance

Activating this option allows a purchase to be completed even if its value exceeds the customer's available credit limit. When creating an account, it is possible to register an excess credit percentage (tolerance) for each customer.

For example, for an account created with a credit limit of $1,000.00 and a tolerance of 10%, the customer will be able to place an order with a maximum value of $1,100.00 using Customer Credit as a payment method. If the customer wishes to use the credit to pay for an order worth $1,250.00, the system will not allow the purchase to be completed.

Tolerance values are configured in decimal numbers, with 0 representing 0% and 1 representing 100%. Example: to use a tolerance of 5%, the value to be configured is 0.05.

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAFklEQVR4nGOQlJRcv379mzfvOrsnAAAkywbDuZmxIwAAAABJRU5ErkJggg==","img":{"src":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_2.JPG","width":517,"height":139,"type":"jpg"}}

Automatic account creation

This option allows any store customer to use Customer Credit as a payment method, even if you have not previously created an account for them in the Customer Credit app. When activating this functionality, you must also define the initial credit limit that can be used for orders placed by customers without a Customer Credit account.

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAFUlEQVR4nGPQ0dZxdHJW19Dcv/8gABKuBAFMrWKoAAAAAElFTkSuQmCC","img":{"src":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_3.JPG","width":703,"height":208,"type":"jpg"}}

My Credits page

By installing the My Credits page, you will allow customers to view and manage information about the credits and titles available in their account.

The customer can access this page on your store's website at My account > My Credits.

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAFklEQVR4nGM4dPjw16+fX737wcCsDgA+PQggATnznwAAAABJRU5ErkJggg==","img":{"src":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_4.JPG","width":542,"height":158,"type":"jpg"}}

Payment Instructions

This configuration allows you to insert instructions related to payment in the invoices issued by Customer Credit. To edit the message to be displayed in the invoice, enter the information in the test box and click Update.

The message registered in this configuration will be replicated on all invoices issued for all Customer Credit accounts. It is not possible to configure a unique message for each specific customer or invoice.

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAFUlEQVR4nGOorq4WFJe/devO////ASTaB0amM4z4AAAAAElFTkSuQmCC","img":{"src":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_5.JPG","width":1146,"height":267,"type":"jpg"}}

Identifying Information

This option allows you to select which store identification information should be displayed at the top of issued invoices.

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAFUlEQVR4nGOIio7+/ee/jrZOVHQ0ACgWBZq9yYM7AAAAAElFTkSuQmCC","img":{"src":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_6.JPG","width":1145,"height":265,"type":"jpg"}}

{"base64":"  ","img":{"width":1308,"height":234,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":31312,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_7.JPG"}}

Payment conditions

Once the Customer Credit settings are completed, it is necessary to indicate which term and installment options will be available to be displayed to customers on the Checkout screen.

To create payment conditions for Customer Credit invoices, follow the steps below:

  1. In the VTEX Admin, go to Store Settings > Payment > Settings, or type Settings in the search bar at the top of the page.
  2. On the Payment Conditions tab, click the + button.
  3. Select the option Customer Credit.
  4. Fill in the field Condition name with a name of your choice for identification.
  5. Enable the condition in the Status field.
  6. In Configure Due Date and Installment Rules, indicate the number of installments, due period (in days) and the simple interest rate to be applied to each installment. To create more than one payment condition, click Add new condition.

{"base64":"  ","img":{"width":1458,"height":777,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":76363,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/setting-up-the-app_8.JPG"}}

It is not possible to set an interest rate for a payment condition created with just a single installment.

Contributors
4
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 4 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
1. Installing Customer Credit
« Previous
3. Creating Customer Credit accounts
Next »
Contributors
4
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 4 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback