Giftcard API

Name: Giftcard API API
Brand: Giftcard API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey11 EndpointsREST

For Agents

Programmatically create a gift card, get a gift card by id. Covers 11 operations with apiKey authentication.

Use for: I need to a gift card, I want to a gift card by id, Search for all gift cards, Find all a gift card transaction

Connect the Giftcard API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Giftcard 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 Giftcard API API.

Create a gift card

Get a gift card by ID

List all gift cards

Query and filter Giftcard API records by parameters

Monitor Giftcard API operational status and events

GET STARTED

Start building with Giftcard API API

Explore with Jentic

View OpenAPI Document

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

>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/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 is a payment method configured as a cash value associated with a clien. The API exposes 11 endpoints secured with apiKey authentication.

Use Cases

Patterns agents use Giftcard API API for, with concrete tasks.

★ Payments Operations

Use the Giftcard API to perform payments operations programmatically. The API provides 11 endpoints covering core functionality including create a gift card, get a gift card by id, list all gift cards.

Call POST /giftcards to create a gift card

Automated Gift Card Management

Automate gift card operations by combining multiple Giftcard API endpoints. Agents can get a gift card by id and then list all gift cards in a single workflow.

Call GET /giftcards/{giftCardId} to get a gift card by id, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Giftcard 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 'create a gift card', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

11 endpoints — >ℹ️ check the new [payments onboarding guide](https://developers.

METHOD

PATH

DESCRIPTION

POST

/giftcards

Create a gift card

GET

/giftcards/{giftCardId}

Get a gift card by ID

POST

/giftcards/_search

List all gift cards

POST

/giftcards/{giftCardId}/transactions

Create a gift card transaction

GET

/giftcards/{giftCardId}/transactions

List all gift card transactions

GET

/giftcards/{giftCardId}/transactions/{transactionId}

Get a gift card transaction by ID

GET

/giftcards/{giftCardId}/transactions/{transactionId}/authorization

Get a gift card transaction authorization

POST

/giftcards/{giftCardId}/transactions/{transactionId}/cancellations

Cancel a gift card transaction

POST

/giftcards

Create a gift card

GET

/giftcards/{giftCardId}

Get a gift card by ID

POST

/giftcards/_search

List all gift cards

POST

/giftcards/{giftCardId}/transactions

Create a gift card transaction

GET

/giftcards/{giftCardId}/transactions

List all gift card transactions

Why though Jentic?

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

Credential isolation

Giftcard 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., 'create a gift card') and Jentic returns the matching Giftcard API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Giftcard 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 Giftcard API API through Jentic.

What authentication does the Giftcard API use?

The Giftcard 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 create a gift card with the Giftcard API?

Yes. Use the POST /giftcards endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Giftcard 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 create a gift card through Jentic?

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

How many endpoints does the Giftcard API have?

The Giftcard API exposes 11 endpoints covering gift card, transactions operations.