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 Payment Flow API

The Payment Flow API from VTEX — 6 operation(s) for payment flow.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

6 operations 6 paths 16 schemas 1 GET5 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 Payment Flow 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 6

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

Payment Flow 6
GET
/manifest
VTex List Payment Provider Manifest
Manifest 2 params → 200
POST
/payments
VTex Create payment
CreatePayment 4 params body → 200400500
POST
/payments/{paymentId}/cancellations
VTex Cancel payment
CancelPayment 5 params body → 200500501
POST
/payments/{paymentId}/settlements
VTex Settle payment
SettlePayment 5 params body → 200500
POST
/payments/{paymentId}/refunds
VTex Refund payment
RefundPayment 5 params body → 200500501
POST
/payments/{paymentId}/inbound/{action}
VTex Inbound request (BETA)
InboundRequest(BETA) 6 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Success-Approved (21 properties), RefundPayment (12 properties), SettlePayment (11 properties), InboundRequest_BETA_Request (9 properties). Each schema is shown below with its type and property counts.

Success3
object
Refund payment response body information.
7 properties 6 required
Success2
object
Settle payment response body information.
7 properties 6 required
ResponseData
object
Response data information.
3 properties 3 required
RequestData
object
Request data information.
1 property 1 required
Fail-BadRequest
object
Bad request information.
3 properties 3 required
InboundRequest_BETA_Request
object
Inbound request information.
9 properties 7 required
Fail-GenericError3
object
Internal server error information.
6 properties 6 required
Fail-GenericError1
object
Cancellation failure information.
5 properties 5 required
SettlePayment
object
Settle payment request body information.
11 properties 5 required
RefundPayment
object
Refund payment request body information.
12 properties 6 required
Success-Approved
object
Create payment response body information.
21 properties 9 required
Success1
object
Cancel payment response body information.
6 properties 5 required
Fail-GenericError2
object
Internal server error information.
6 properties 6 required
CancelPaymentRequest
object
Cancel payment request body information.
9 properties 3 required
Success-Manifest
object
Payment provider manifest response body information.
4 properties 1 required
Success4
object
Inbound Request response body information.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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