canonical: https://jentic.com/apis/vtex.local/giftcard-hub-api

# Vtex Giftcard Hub API

>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The Gift Card Hub API allows interactions with all Gift card providers regist. The API exposes 15 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list all gift card providers, get a gift card provider by id. Covers 15 operations with apiKey authentication.

## Scope

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

## Capabilities

- List all gift card providers
- Get a gift card provider by ID
- Create or update a gift card provider by ID
- Delete a gift card provider by ID
- Monitor Giftcard Hub API operational status and events

## Use cases

### Payments Operations

Use the Giftcard Hub API to perform payments operations programmatically. The API provides 15 endpoints covering core functionality including list all gift card providers, get a gift card provider by id, create or update a gift card provider by id.

Example prompt: Call GET `/api/giftcardproviders` to list all gift card providers

### Automated Provider Management

Automate provider operations by combining multiple Giftcard Hub API endpoints. Agents can get a gift card provider by id and then create or update a gift card provider by id in a single workflow.

Example prompt: Call GET `/api/giftcardproviders/{giftCardProviderId}` to get a gift card provider by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Giftcard Hub 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.

Example prompt: Search Jentic for 'list all gift card providers', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/giftcardproviders` | List all gift card providers |
| GET | `/api/giftcardproviders/{giftCardProviderId}` | Get a gift card provider by ID |
| PUT | `/api/giftcardproviders/{giftCardProviderId}` | Create or update a gift card provider by ID |
| DELETE | `/api/giftcardproviders/{giftCardProviderId}` | Delete a gift card provider by ID |
| POST | `/api/giftcardproviders/{giftCardProviderId}/giftcards` | Create a gift card at a gift card provider |
| POST | `/api/giftcardproviders/{giftCardProviderId}/giftcards/_search` | Get a gift card from a gift card provider |
| GET | `/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}` | Get a gift card from a gift card provider by ID |
| POST | `/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions` | Create a gift card transaction |

## Key resources

- **Provider** — Operations related to Provider
- **Transaction** — Operations related to Transaction

## Why Jentic

- **Setup:** Wiring the VTEX Giftcard Hub API by hand means setting both the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, resolving the account and environment host template, and managing the gift card provider calls yourself. Through Jentic you install once, import the Giftcard Hub API from the API Directory, store the key pair once, and your agent calls it.
- **Permission scoping:** The Giftcard Hub API puts the provider id in the URL path (`/api/giftcardproviders/{giftCardProviderId}`), so a rule can pin your agent to reading and searching gift cards for one provider. You choose the operations it may call, so destructive ones like provider deletion are not included unless you add them.
- **Credential handling:** Your VTEX AppKey and AppToken are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list gift card providers' or 'search gift cards', and Jentic returns the matching Giftcard Hub API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Giftcard Hub API use?

The Giftcard Hub API uses an API key passed in the `X-VTEX-API-AppKey` 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 list all gift card providers with the Giftcard Hub API?

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

### What are the rate limits for the Giftcard Hub 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 list all gift card providers through Jentic?

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

### How many endpoints does the Giftcard Hub API have?

The Giftcard Hub API exposes 15 endpoints covering provider, transaction operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Giftcard Hub API operations and credentials the agent may use. Since the provider id sits in the URL path (`/api/giftcardproviders/{giftCardProviderId}`), you can pin the agent to reading and searching gift cards for a single provider and allow only calls like GET `/api/giftcardproviders` and its gift card lookups. Destructive operations such as DELETE `/api/giftcardproviders/{giftCardProviderId}` stay off unless you explicitly add them to what the agent is permitted to call.