canonical: https://jentic.com/apis/swaggerhub.visanetperu/api-merchant

# Visanetperu API Merchant

**API merchant** *Version 1.0* - Merchant Data. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically retrievetotal, retrievemerchant. Covers 4 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- RetrieveTotal
- RetrieveMerchant
- Query merchant
- update
- Monitor API Merchant operational status and events

## Use cases

### Developer Tools Operations

Use the API Merchant to perform developer tools operations programmatically. The API provides 4 endpoints covering core functionality including retrievetotal, retrievemerchant, query merchant.

Example prompt: Call GET /getTotal/{operation} to retrievetotal

### Automated Merchant API Management

Automate merchant API operations by combining multiple API Merchant endpoints. Agents can retrievemerchant and then query merchant in a single workflow.

Example prompt: Call GET /list/{operation}/{initPage}/{finalPage} to retrievemerchant, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Merchant 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.

Example prompt: Search Jentic for 'retrievetotal', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /getTotal/{operation} | RetrieveTotal |
| GET | /list/{operation}/{initPage}/{finalPage} | RetrieveMerchant |
| POST | /querybyRUC | Query merchant |
| POST | /update | update |

## Key resources

- **Merchant API** — RESTful API for Visanet Merchant Information

## Why Jentic

- **Setup:** Wiring the API Merchant by hand means obtaining an access token from Niubiz api.security, passing it in the Authorization header, and coding its listing and lookup calls against its vnforapps.com host yourself. Through Jentic you install once, import the API Merchant from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The API Merchant puts the operation and page bounds in the URL path (/list/{operation}/{initPage}/{finalPage}) while lookups take a RUC in the body, so limit the agent to the operations it needs, such as reading a total with GET /getTotal/{operation}. You choose the operations it may call, so updating a merchant with POST /update is not included unless you add it.
- **Credential handling:** Your Niubiz access token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get the total for an operation' or 'look up a merchant by RUC', and Jentic returns the matching API Merchant operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the API Merchant use?

The API Merchant uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I retrievetotal with the API Merchant?

Yes. Use the GET /getTotal/{operation} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API Merchant?

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 retrievetotal through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retrievetotal'. Jentic returns the matching API Merchant operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API Merchant have?

The API Merchant exposes 4 endpoints covering merchant API operations.

### Can I limit what my agent is allowed to do with the API Merchant?

Yes. Because Jentic One is self-hosted, you set the rules that decide which API Merchant operations your agent may call, so you can allow read-only calls like GET /getTotal/{operation} for totals and GET /list/{operation}/{initPage}/{finalPage} for merchant listings while withholding the rest. Lookups such as POST /querybyRUC and writes like POST /update are only available if you explicitly add them. Your Niubiz access token is stored encrypted by your own instance and injected at execution time, never entering the agent's prompt or logs.