Menu
Feedback
Start here
Tutorials


Payment solutions
Customer Credit - Getting Started
3. Creating Customer Credit accounts
Creating Customer Credit accounts

The next step is to create accounts for the customers you want to offer credit to in your store. Accounts can be created in three different ways:

Accounts created in the Customer Credit app have no relationship or share data with the customer base registered in the store's Master Data entities. For a customer to be able to use Customer Credit as a payment method, their account must be registered by the merchant in the app even if the customer already has an account in the store.

Create accounts individually

To register a new customer in Customer Credit, follow the steps below:

  1. In the VTEX Admin, access Apps > Customer Credit > Accounts, or type Accounts in the search bar at the top of the page.
  2. On the Accounts screen, click the NEW button.
  3. In Identification, select the Document type and fill in the Document and Email fields with the information of the customer you want to register.
  4. In Credit, enter the Credit Limit (BRL) and Tolerance values that you want to make available to the customer.
  5. Click Confirm.

Filling in the Email field is mandatory, as the VTEX platform uses this information to authenticate the customer's access to the credit limits of their account. For more information about data protection, visit SmartCheckout Security.

From this moment on, the new account created will be displayed on the Accounts screen.

{"base64":"  ","img":{"width":1537,"height":542,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":48596,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/creating-accounts_1.JPG"}}

Create multiple accounts (bulk import)

To create multiple accounts at the same time (in bulk) in Customer Credit, you can use a template spreadsheet in CSV (Comma Separated Value) format containing each customer's information. Follow the steps below to create multiple accounts:

  1. In the VTEX Admin, access Apps > Customer Credit > Accounts, or type Accounts in the search bar at the top of the page.
  2. On the Accounts screen, click the IMPORT button.
  3. In Do you want to create or update accounts?, select the Create option and click CONTINUE.
  4. Click on DOWNLOAD TEMPLATE. A spreadsheet template in .csv format will be sent to your device (computer, cell phone or tablet).
  5. Fill in each line:

{"base64":"  ","img":{"width":865,"height":347,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":28352,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tracks/customer-credit-getting-started/creating-accounts_2.JPG"}}

From this moment on, new accounts created via the .csv spreadsheet will be available on the Accounts screen.

It is also possible to track previous processes of creating multiple accounts, identifying whether the accounts were created correctly. To check this information, click on Import History on the Accounts screen.

Update multiple accounts (bulk import)

To update information, such as document, document type, email, credit limit and tolerance, in multiple accounts at the same time, you can also use the bulk import functionality.

The procedure is similar to create multiple accounts. However, you must already have the .csv spreadsheet downloaded and filled out on your device (computer, cell phone or tablet). Follow the steps below to update customer information:

  1. In the VTEX Admin, access Apps > Customer Credit > Accounts, or type Accounts in the search bar at the top of the page.
  2. On the Accounts screen, click the IMPORT button.
  3. In Do you want to create or update accounts?, select the Update option and click CONTINUE.
  4. Insert or select the .csv spreadsheet in the space Drop your CSV here or choose a file here.
  5. Click on the IMPORT FILE button.
  6. After the spreadsheet is loaded into Admin, check on the Accounts screen whether the information was updated correctly in each customer's accounts.

Create account via API

You can also create accounts for your customers in Customer Credit through the endpoint POST - Open an account.

For more information about Customer Credit API endpoints, visit Customer Credit API - Overview.

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)
2. Configuring Customer Credit
« Previous
4. Managing 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