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 Process API

The Transaction Process API from VTEX — 8 operation(s) for transaction process.

Documentation Provider Profile APIs.io OpenAPI GitHub

VTEX Transaction Process 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 Process. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 8 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}.

9 operations 8 paths 24 schemas 3 GET1 PATCH5 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 Process 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 9

Across 8 paths, the API surfaces 9 operations — 3 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Transaction Process 9
POST
/api/pvt/transactions
VTex 1. Start a new transaction
1.Createanewtransaction 2 params body → 200
POST
/api/pub/transactions/{transactionId}/payments
VTex 2.1 Send payments information public
2.SendPaymentsPublic 4 params body → 201
POST
/api/pvt/transactions/{transactionId}/payments
VTex 2.2 Send payments with saved credit card
2.SendPaymentsWithSavedCreditCard 3 params body → 200
POST
/api/pvt/transactions/{transactionId}/additional-data
VTex 3. Send additional data
3.SendAdditionalData 3 params body → 200
PATCH
/api/pvt/transactions/{transactionId}/additional-data
VTex 3.1 Update additional data (optional)
3.1UpdateAdditionalData 3 params body → 200
POST
/api/pvt/transactions/{transactionId}/authorization-request
VTex 4. Authorize new transaction
4.Doauthorization 3 params body → 200
GET
/api/pvt/transactions/{transactionId}
VTex Get transaction details
TransactionDetails 3 params → 200
GET
/api/pvt/transactions/{transactionId}/payments/{paymentId}
VTex Get payment details
PaymentDetails 4 params → 200
GET
/api/pvt/transactions/{transactionId}/settlements
VTex Get transaction settlement details
TransactionSettlementDetails 3 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are TransactionDetailsResponse (45 properties), StartTransactionResponse (44 properties), SettleResponse (11 properties), 2.SendPaymentsWithSavedCreditCardRequest (9 properties). Each schema is shown below with its type and property counts.

Payment1
object
Object containing the transaction settlement reference route.
1 property 1 required
PaymentDetailsResponse
object
Payment details information.
36 required
2.SendPaymentsWithSavedCreditCardRequest
object
Send payments with saved credit card request body information.
9 properties 9 required
4.DoauthorizationRequest
object
Authorize new transaction request body information.
3 properties 3 required
Transaction
object
Transaction information.
2 properties 2 required
Refunds
object
Object containing the reference route of transaction refunds.
1 property 1 required
Self
object
Object containing the payment system reference route.
1 property 1 required
TransactionDetailsResponse
object
Transaction details response body information.
45 properties 45 required
Cancellations
object
Object containing the reference route of transaction cancellations.
1 property 1 required
Fields1
object
Payment parameters information.
2 properties 2 required
Fields
object
Fields information.
8 properties 8 required
Action
object
Actions information.
6 properties 6 required
Request
object
Requests information.
3 properties 3 required
SettleResponse
object
Transaction response body information.
11 properties 11 required
Payments
object
Object containing the reference route of transaction payments.
1 property 1 required
2.SendPaymentsPublicRequest
object
Send payments information public request body information.
9 properties 9 required
TransactionSettlementDetails
object
Transaction settlement details response body information.
2 properties 2 required
Interactions
object
Object containing the reference route of transaction interactions.
1 property 1 required
Settlements
object
Object containing the reference route of transaction settlements.
1 property 1 required
Capabilities
object
Object containing the reference route of transaction capabilities.
1 property 1 required
Field
object
Transaction parameters information.
2 properties 2 required
1.CreateanewtransactionRequest
object
New transaction request body information.
5 properties 4 required
Fields3
object
Fields information.
8 properties 8 required
StartTransactionResponse
object
New transaction response body information.
44 properties 44 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-transaction-process-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 Process
← Back to V APIs
API Details
ID
vtex:vtex-transaction-process-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-process-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-transaction-process-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 Process 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.