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

Medusa Payment Collections API

A payment collection is one or more payments of an order. They're also used for outstanding payments due to order exchanges or claims.Every purchase or request for payment starts with a payment collection.A payment collection holds the payment sessions used to authorize the payment amount, and the payments to be captured / refunded.These API routes allow admin users to manage payment collections.

Medusa Payment Collections API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Collections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

6 operations 6 paths 21 schemas 1 DELETE5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Medusa Payment Collections API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 6

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

Payment Collections 6

A payment collection is one or more payments of an order. They're also used for outstanding payments due to order exchanges or claims. Every purchase or request for payment starts…

POST
/admin/payment-collections
Create Payment Collection
PostPaymentCollections 1 param body → 200400401404409422500
DELETE
/admin/payment-collections/{id}
Delete a Payment Collection
DeletePaymentCollectionsId 1 param → 200400401404409422500
POST
/admin/payment-collections/{id}/mark-as-paid
Mark a Payment Collection as Paid
PostPaymentCollectionsIdMarkAsPaid 2 params body → 200400401404409422500
POST
/admin/payment-collections/{id}/payment-sessions
Initialize Payment Session in Payment Collection
PostPaymentCollectionsIdPaymentSessions 2 params body → 200400401404409422500
POST
/store/payment-collections
Create Payment Collection
PostPaymentCollections 4 params body → 200400401404409422500
POST
/store/payment-collections/{id}/payment-sessions
Initialize Payment Session of a Payment Collection
PostPaymentCollectionsIdPaymentSessions 5 params body → 200400401404409422500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are AdminPayment (16 properties), BasePayment (16 properties), StorePaymentCollection (14 properties), AdminPaymentCollection (14 properties). Each schema is shown below with its type and property counts.

BaseRefund
object
The refund's details.
8 properties 4 required
AdminDeletePaymentCollectionResponse
object
The result of deleting the payment collection.
3 properties 3 required
BaseRefundReason
object
The refund reason's details.
7 properties 5 required
AdminInitializePaymentSession
object
The details of the payment session to initialize in the payment collection.
2 properties 1 required
Error
object
3 properties
AdminCreatePaymentCollection
object
The payment collection's details.
2 properties 2 required
BaseCapture
object
The details of a captured payment.
5 properties 4 required
AdminPayment
object
The payment's details.
16 properties 4 required
AdminPaymentCollectionResponse
object
The payment collection's details.
1 property 1 required
AdminRefund
object
The refund's details.
8 properties 4 required
BasePayment
object
The payment's details.
16 properties 4 required
AdminPaymentCollection
object
The payment collection's details.
14 properties 5 required
AdminPaymentSession
object
The payment session's details.
10 properties 6 required
AdminMarkPaymentCollectionAsPaid
object
The payment details.
2 properties 1 required
AdminPaymentProvider
object
The payment provider's details.
2 properties 2 required
StoreCreatePaymentCollection
object
The details of the payment collection to create.
1 property 1 required
StorePaymentSession
object
The payment session's details.
10 properties 6 required
StorePaymentProvider
object
The payment provider's details
1 property 1 required
StorePaymentCollectionResponse
object
The payment collection's details.
1 property 1 required
StorePaymentCollection
object
The payment collection's details.
14 properties 5 required
StoreInitializePaymentSession
object
The payment session's details.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-payment-collections-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Payment Collections 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.