Customer Credit API

Name: Customer Credit API API
Brand: Customer Credit API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey25 EndpointsREST

For Agents

Programmatically search all invoices, retrieve invoice by id. Covers 25 operations with apiKey authentication.

Connect the Customer Credit API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Customer Credit API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Customer Credit API API.

Search all invoices

Retrieve invoice by ID

Change invoice

Cancel invoice

Mark an invoice as paid

GET STARTED

Start building with Customer Credit API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Customer Credit API, keeping it validated and agent-ready.

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](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs). Additionally, you can find more information on installment paym. The API exposes 25 endpoints secured with apiKey authentication.

Use Cases

Patterns agents use Customer Credit API API for, with concrete tasks.

★ Payments Operations

Use the Customer Credit API to perform payments operations programmatically. The API provides 25 endpoints covering core functionality including search all invoices, retrieve invoice by id, change invoice.

Call GET /api/creditcontrol/invoices to search all invoices

Automated Invoices Management

Automate invoices operations by combining multiple Customer Credit API endpoints. Agents can retrieve invoice by id and then change invoice in a single workflow.

Call GET /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId} to retrieve invoice by id, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Customer Credit API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Search Jentic for 'search all invoices', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

25 endpoints — with customer credit your store can enable **credit payments** through the checkout.

METHOD

PATH

DESCRIPTION

GET

/api/creditcontrol/invoices

Search all invoices

GET

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Retrieve invoice by ID

PUT

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Change invoice

DELETE

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Cancel invoice

GET

/api/creditcontrol/accounts/{creditAccountId}/invoices

Retrieve invoices by Customer Credit account ID

POST

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments

Mark an invoice as paid

PUT

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/postponement

Postpone an invoice

POST

/api/creditcontrol/accounts

Open an account

GET

/api/creditcontrol/invoices

Search all invoices

GET

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Retrieve invoice by ID

PUT

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Change invoice

DELETE

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Cancel invoice

GET

/api/creditcontrol/accounts/{creditAccountId}/invoices

Retrieve invoices by Customer Credit account ID

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Customer Credit API apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'search all invoices') and Jentic returns the matching Customer Credit API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Customer Credit API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stripe

Alternative payments API

Choose Stripe when you need a different approach to payments operations

Alternative

Adyen

Alternative payments API

Choose Adyen when you need a different approach to payments operations

Complementary

Square

Complementary payments API

Choose Square when you need a complementary approach to payments operations

Complementary

Paypal

Complementary payments API

Choose Paypal when you need a complementary approach to payments operations

FAQs

Specific to using Customer Credit API API through Jentic.

What authentication does the Customer Credit API use?

The Customer Credit API uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in the MAXsystem vault and injected at execution time, so raw secrets never enter the agent context.

Can I search all invoices with the Customer Credit API?

Yes. Use the GET /api/creditcontrol/invoices endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Customer Credit API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

How do I search all invoices through Jentic?

Install the Jentic SDK with pip install jentic, authenticate at https://app.jentic.com/sign-up, then search for 'search all invoices'. Jentic returns the matching Customer Credit API operation with its input schema. Load the schema and execute the call — credentials are injected automatically.

How many endpoints does the Customer Credit API have?

The Customer Credit API exposes 25 endpoints covering invoices, account, store configuration operations.