vtex.local – Customer-Credit-API

OpenAPI apis-guru

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 .

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 endpoint of the Orders API. This includes the number of installments, amount and due dates.

This API allows two kinds of authorization:

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

Homepage: https://api.apis.guru/v2/specs/vtex.local:Customer-Credit-API/1.0.json
Provider: vtex.local:Customer-Credit-API / Customer-Credit-API
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/openapi.yaml

Tools (28)

Extracted live via the executor SDK.

account.accountstatements

Get the account statements.
account.addanaccountHolder
account.cancelaPreAuthorization
account.changecreditlimitofanAccount

Increase the credit limit of an account.
account.changetoleranceofanaccount

Increase the credit limit of a checking account.
account.closeanAccount

Closes an account.
account.createaPreAuthorization
account.createaPreAuthorizationUsingid
account.createorUpdateSettlement

Debit a value from checking account.
account.decreasebalanceofanaccount

Create a debit value updating the account BALANCE.
account.deleteanaccountholder
account.openanAccount

Open an account.
account.openorChangeAccount

Open or Change an account.
account.partialorTotalRefundaSettlement

Refund a value from a already settled transaction.
account.retrieveaAccountbyId

Retrieve an account by id.
account.searchallaccounts
account.updateemailanddescriptionofaaccount

Update a checking account.
invoices.cancelInvoice

Changes invoice's status from ancells invoice by specified Id.
invoices.changeInvoice

Updates invoice's attributes status, paymentLink and observation.
invoices.markaninvoiceasPaid

Pay an invoice.
invoices.postponeaninvoice

Postpone an invoice.
invoices.retrieveInvoicebyId

Returns associated data for the specified Invoice Id, like status and value, for example.
invoices.searchallinvoices

Returns all invoices according to the informed query params in the request.
invoices.searchallinvoicesofaAccount

Returns associated invoices by specified creditAccountId, the param that identifies a client in VTEX's system.
storeConfiguration.createorchangestoreconfiguration

Create or change store configuration data.
storeConfiguration.retrievestoreconfiguration

Get store configuration data.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools