How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VTEX

VTEX Transaction API

The Transaction API from VTEX — 13 operation(s) for transaction.

Documentation Provider Profile APIs.io OpenAPI GitHub

VTEX Transaction API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 13 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

19 operations 13 paths 24 schemas 11 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Transaction API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 19

Across 13 paths, the API surfaces 19 operations — 11 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Transaction 19
POST
/api/giftcardproviders/{giftCardProviderId}/giftcards
VTex Create GiftCard in GiftCard Provider
CreateGiftCardinGiftCardProvider 3 params body → 200
POST
/api/giftcardproviders/{giftCardProviderId}/giftcards/_search
VTex Get GiftCard from GiftCard Provider
GetGiftCardfromGiftCardProvider 4 params body → 200
GET
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}
VTex Get GiftCard from GiftCard Provider by ID
GetGiftCardfromGiftCardProviderbyID 4 params → 200
GET
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions
VTex List All GiftCard Transactions
ListAllGiftCardTransactions 4 params → 200
POST
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions
VTex Create GiftCard Transaction
CreateGiftCardTransaction 4 params body → 200
GET
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId}
VTex Get GiftCard Transaction by ID
GetGiftCardTransactionbyID 5 params → 200
GET
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/authorization
VTex Get GiftCard Transaction Authorization
GetGiftCardAuthorizationTransaction 5 params → 200
GET
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements
VTex List All GiftCard Transactions Settlements
ListAllGiftCardSettlementTransactions 5 params → 200
POST
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements
VTex Settle GiftCard Transaction
CreateGiftCardSettlementTransaction 5 params body → 200
GET
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations
VTex List All GiftCard Transactions Cancellations
ListAllGiftCardCancellationTransactions 5 params → 200
POST
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations
VTex Cancel GiftCard Transaction
CreateGiftCardCancellationTransaction 5 params body → 200
GET
/giftcards/{giftCardId}/transactions
VTex List all gift card transactions
GetGiftCardTransactions 3 params → 200
POST
/giftcards/{giftCardId}/transactions
VTex Create a gift card transaction
CreateGiftCardTransaction 3 params body → 200
GET
/giftcards/{giftCardId}/transactions/{transactionId}
VTex Get a gift card transaction by ID
GetGiftCardTransactionbyID 4 params → 200
GET
/giftcards/{giftCardId}/transactions/{transactionId}/authorization
VTex Get a gift card transaction authorization
GetTransactionAuthorizations 4 params → 200
GET
/giftcards/{giftCardId}/transactions/{transactionId}/cancellations
VTex List all gift card transactions cancellations
GetTransactionCancellations 4 params → 200
POST
/giftcards/{giftCardId}/transactions/{transactionId}/cancellations
VTex Cancel a gift card transaction
CancelGiftCardTransaction 4 params body → 200
GET
/giftcards/{giftCardId}/transactions/{transactionId}/settlements
VTex List all gift card transactions settlements
GetTransactionSettlements 4 params → 200
POST
/giftcards/{giftCardId}/transactions/{transactionId}/settlements
VTex Settle a gift card transaction
SettleGiftCardTransaction 4 params body → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Shipping (10 properties), Item1 (10 properties), Item2 (10 properties), CreateGiftCardinGiftCardProviderRequest (9 properties). Each schema is shown below with its type and property counts.

ClientProfile
object
Client profile information.
7 properties 7 required
response7
object
3 properties 3 required
Shipping
object
Shipping information.
10 properties 10 required
Cart1_2
object
6 properties 6 required
CreateGiftCardTransactionRequest_2
object
7 properties 6 required
CreateGiftCardCancellationTransactionRequest
object
2 properties 2 required
CreateGiftCardTransactionRequest
object
7 properties 7 required
response3
object
2 properties 2 required
Self
object
Object that carries an auto reference of the transaction (on its API).
1 property 1 required
Cart
object
Cart information.
8 properties
OrderInfo
object
Order information.
5 properties
Item
object
Items information.
6 properties
response6
object
3 properties 3 required
GiftCardTransactionRequest
object
2 properties 2 required
CreateGiftCardinGiftCardProviderRequest
object
9 properties 8 required
PriceTag
object
2 properties 2 required
GetGiftCardfromGiftCardProviderRequest
object
2 properties 2 required
Cart1
object
Cart information.
6 properties 6 required
Item2
object
10 properties 10 required
Item1
object
Items information.
10 properties 10 required
Client
object
Client information.
3 properties
ClientProfile_2
object
Client Profile information.
7 properties 7 required
OrderInfo_2
object
5 properties
response5
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-transaction-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
AE Profile APIs.io
VTEX Addresses API
AE Profile APIs.io
VTEX Anti-Fraud Flow API
AE Profile APIs.io
VTEX App Keys API
AE Profile APIs.io
VTEX Attachment API
AE Profile APIs.io
VTEX Authentication API
AE Profile APIs.io
VTEX Autocomplete API
AE Profile APIs.io
VTEX Brand API
AE Profile APIs.io
VTEX Bulk Import API
AE Profile APIs.io
VTEX Carriers API
AE Profile APIs.io
VTEX Cart Attachments API
AE Profile APIs.io
VTEX Category API
AE Profile APIs.io
#Transaction
← Back to V APIs
API Details
ID
vtex:vtex-transaction-api
Base URL
https://{providerApiEndpoint}
Docs
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
Provider
VTEX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vtex-transaction-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-transaction-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of VTEX Transaction API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.