v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-28250234.8 KB

Account

Retrieve an account by ID

Retrieves a customer credit account by the credit account identification.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Credit Control	Main	Main Access
Credit Control	Checking Accounts	Read Checking Accounts

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/creditcontrol/accounts/{creditAccountId}

Path parameters

creditAccountIdstring required

Example:01bce461-9g03-12ds-8217-b3d39271e15b

Credit account identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

idstring required

Credit customer account identification.

balancenumber required

Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.

documentstring required

Account owner document.

statusstring required

Credit customer account status.

documentTypestring required

Document type. Possible values: CPF, CNPJ or Other.

creditLimitnumber required

Maximum credit amount on the account.

updatedAtstring required

Date of the last update made to the account.

createdAtstring required

Account creation date.

descriptionstring

This field is deprecated.

availableCreditnumber required

Credit amount available on the account.

preAuthorizedCreditnumber required

Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.

emailstring required

Account owner email.

tolerancenumber required

Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of 0.30 indicates that the account owner can use up to 30% above the account's original maximum credit amount.

availableBalancenumber required

Balance available for use on the account.