VTvtex
Account

Close an account

Changed on

Closes a customer credit account.

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.

delete/api/creditcontrol/accounts/{creditAccountId}

Request

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.

Request body

documentstring

Account owner document.

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

Document type.

emailstring

Account owner email.

Example request

{
  "document": "32222222222",
  "documentType": "CPF",
  "email": "email@domain.com"
}

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.

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

Document type.

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

  • 25c08deef792Revision changes
    • breaking

      request property was restricted to a list of enum values

    • warning

      added the new CNPJ enum value to the response property for the response status

    • warning

      added the new CPF enum value to the response property for the response status

    • warning

      added the new Other enum value to the response property for the response status

    • 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

    • info

      response property description deprecated

  • c8735f67eb83Revision changes
    • info

      the request property default value 99999999999 was removed

    • info

      the request property default value CPF was removed

    • info

      the request property default value email@domain.com was removed

    • info

      added the media type application/json for the response with the status