Account

Decrease balance of an account

Changed on Nov 27, 2023

Creates a debit value updating the account balance.

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	Edit credits

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.

put/api/creditcontrol/accounts/{creditAccountId}/statements/{statementId}

Request

Base URL
https://apiexamples.vtexcommercestable.com.br
Auth
- API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
- or API key in header VtexIdclientAutCookie
TypeScript
https://skmtc.dev/vtex/apis/customer-credit-api/docs/api/creditcontrol/accounts/:creditAccountId/statements/:statementId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

creditAccountIdstring required

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

Credit account identification.

statementIdstring required

Example:451924c579a6759cf6e112a

Statement identification. This is the same transactionId value obtained from the Account statements endpoint response body.

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

valuestring required

Value to be debited from the account balance.

Example request

{
  "value": "-15"
}

Response