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
commercetools

commercetools Payments API

Track payment transactions and PSP interactions associated with orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

commercetools Payments API is one of 19 APIs that commercetools publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

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

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.{region}.commercetools.com.

4 operations 2 paths 10 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.{region}.commercetools.com
Authentication
HTTP Bearer
Contact
commercetools Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

commercetools Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained from the commercetools authentication service at https://auth.{region}.commercetools.com/oauth/token using client credentials f…

Paths & Operations 4

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

Payments 4

Track payment transactions and PSP interactions associated with orders.

GET
/{projectKey}/payments
List payments
listPayments 5 params → 200401
POST
/{projectKey}/payments
Create a payment
createPayment 1 param body → 201400
GET
/{projectKey}/payments/{id}
Get a payment by ID
getPaymentById 3 params → 200404
POST
/{projectKey}/payments/{id}
Update a payment by ID
updatePaymentById 2 params body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Payment (11 properties), PaymentDraft (6 properties), Transaction (6 properties), PaymentPagedQueryResponse (5 properties). Each schema is shown below with its type and property counts.

PaymentStatus
object
The current status of a payment including PSP-specific state information.
3 properties
Reference
object
A reference to another resource by its typeId and id.
2 properties 2 required
Transaction
object
A single financial transaction within a payment (authorization, charge, refund, etc.).
6 properties 4 required
PaymentUpdate
object
Request body for updating a payment.
2 properties 2 required
LocalizedString
object
A map of locale keys to string values used for multilingual content. Keys follow IETF language tag format (e.g., 'en', 'de', 'en-US').
Money
object
A monetary value with currency code and amount in the smallest currency unit.
3 properties 2 required
Payment
object
A payment resource tracking financial transactions and PSP interactions for an order.
11 properties 5 required
PaymentPagedQueryResponse
object
Paginated response containing a list of payments.
5 properties 5 required
PaymentDraft
object
Request body for creating a new payment.
6 properties 1 required
PaymentMethodInfo
object
Information about the payment method and PSP used for a payment.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

commercetools-payments-api-openapi.yml Raw ↑

Other APIs commercetools publishes across the network.

Commercetools GraphQL API
AE Profile APIs.io
Commercetools TypeScript SDK
AE Profile APIs.io
Commercetools Java SDK
AE Profile APIs.io
Commercetools Checkout API
AE Profile APIs.io
Commercetools Merchant Center Customizations API
AE Profile APIs.io
commercetools Carts API
AE Profile APIs.io
commercetools Categories API
AE Profile APIs.io
commercetools ChangeHistory API
AE Profile APIs.io
commercetools Customers API
AE Profile APIs.io
commercetools ImportContainers API
AE Profile APIs.io
commercetools ImportOperations API
AE Profile APIs.io
commercetools Inventory API
AE Profile APIs.io
#Payments
← Back to C APIs
API Details
ID
commercetools:commercetools-payments-api
Base URL
https://api.{region}.commercetools.com
Docs
https://docs.commercetools.com/api
Provider
commercetools
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=commercetools-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/commercetools-payments-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 commercetools Payments 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.