Customer Credit API

With Customer Credit your store can enable credit payments through the checkout. You can also control invoices and the credit limits of your clients.

Learn more about Customer Credit in our Help Center article.

All requests need the authorization header.

Additionally, you can find more information on installment payments for an order in the customData field found in the Get Order endpoint of the Orders API. This includes the number of installments, amount and due dates.

This API allows two kinds of authorization:

1. Authorization header containing the VTEX ID authentication token.
2. VTEX Appkey and Apptoken headers.

Use this page to mock Customer Credit API in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Customer Credit API, which will allow you to keep building and testing even if the actual API you isn't currently available.