VTvtex
Account

Open an account

Changed on

Opens a customer credit account on your store.

⚠️ This request should only be used if you do not have an account yet registered. If you already have an account (open or closed) and want to create or modify an account, go to Update account information endpoint.

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:

ProductCategoryResource
Credit ControlMainMain Access
Credit ControlChecking AccountsCreate 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.

post/api/creditcontrol/accounts

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

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.

Request body

documentstring required

Account owner document.

documentType'CPF' | 'CNPJ' | 'Other' required

Document type.

emailstring required

Account owner email.

creditLimitstring required

Maximum credit amount on the account.

descriptionstring required

This field is deprecated.

tolerancestring 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.

Example request

{
  "document": "11111111111",
  "documentType": "CPF",
  "email": "test@test.com",
  "creditLimit": "1100",
  "description": "Not applicable.",
  "tolerance": "0.2"
}

Response

OK

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.

Changes

  • 0cfe5b381175Revision changes
    • warning

      the optional response header Connection removed for the status 200

    • warning

      the optional response header Content-Length removed for the status 200

    • warning

      the optional response header Date removed for the status 200

    • warning

      the optional response header Server removed for the status 200

    • warning

      the optional response header X-CDNIgnore removed for the status 200

    • warning

      the optional response header X-Powered-by-VTEX-Janus-Edge removed for the status 200

    • warning

      the optional response header X-Track removed for the status 200

    • warning

      the optional response header X-Translate removed for the status 200

    • warning

      the optional response header X-Translate-BackEnd removed for the status 200

    • warning

      the optional response header X-VTEX-Janus-Router-Backend-App removed for the status 200

  • 25c08deef792Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      request property deprecated

    • info

      added the new CNPJ enum value to the request property

    • info

      added the new CPF enum value to the request property

    • info

      added the new Other enum value to the request property