v50

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

Account

Create or update settlement

Creates an invoice or update its value for an order placed in the store that used customer credit as a payment method.

ℹ️ If payment for the order is made in installments, you can create an invoice for each installment. The first invoice will be due in 30 days, and subsequent invoices will be due 30 days after the previous invoice.

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	Statements	Create Statements

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}/transactions/{transactionId}/settlement

Path parameters

creditAccountIdstring required

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

Credit account identification.

transactionIdstring required

Example:B2E754DCD7304D22866CB6F221CF0FEB

Pre-authorization 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

valuenumber required

Value to be settled in the invoice.

Example request

{
  "value": 49.95
}

Response

valuenumber required

Invoice value.

idstring required

Identification of the pre-authorization generated when creating the order. This number plus the information -01 indicates the number of the invoice created.