Medusa
Store API
Admin API
Medusa
  • Getting Started
  • Auth
  • Carts
  • Customers
  • Gift Cards
  • Orders
  • Order Edits
  • Payment Collections
    • Authorize Payment SessionPOST
    • Authorize Payment SessionsPOST
    • Refresh a Payment SessionPOST
    • Get a PaymentCollectionGET
    • Manage Payment SessionsPOST
    • Create a Payment SessionPOST
  • Products
  • Product Variants
  • Product Tags
  • Product Categories
  • Product Collections
  • Product Types
  • Regions
  • Returns
  • Return Reasons
  • Shipping Options
  • Swaps
logoPowered by Apidog
  1. Payment Collections

Create a Payment Session

POST/store/payment-collections/{id}/sessions

Create a Payment Session for a payment provider in a Payment Collection.

Request

Path Params
id
string 
required

The ID of the Payment Collection.

Body Params application/json
provider_id
string 
required

The ID of the Payment Provider.

Example
{
  "provider_id": "string"
}

Request samples

Responses

OK(200)
Client Error or Multiple Errors(400)
User is not authorized. Must log in first(401)
Not Found Error(404)
Invalid State Error(409)
Invalid Request Error(422)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
The payment collection's details.
payment_collection
object (Payment Collection) 
required

A payment collection allows grouping and managing a list of payments at one. This can be helpful when making additional payment for order edits or integrating installment payments.

id
string 
required

The payment collection's ID

Example:
paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
description
string  | null 
required

Description of the payment collection

amount
integer 
required

Amount of the payment collection.

authorized_amount
integer  | null 
required

Authorized amount of the payment collection.

region_id
string 
required

The ID of the region this payment collection is associated with.

Example:
reg_01G1G5V26T9H8Y0M4JNE3YGA4G
created_by
string 
required

The ID of the user that created the payment collection.

created_at
string <date-time>
required

The date with timezone at which the resource was created.

updated_at
string <date-time>
required

The date with timezone at which the resource was updated.

deleted_at
string <date-time> | null 
required

The date with timezone at which the resource was deleted.

type
enum<string> 
required

The type of the payment collection

Allowed value:
order_edit
status
enum<string> 
required

The type of the payment collection

Allowed values:
not_paidawaitingauthorizedpartially_authorizedcanceled
currency_code
string 
required

The three character ISO code for the currency this payment collection is associated with.

Example:
usd
metadata
object  | null 
required

An optional key-value map with additional details

Example:
{"car":"white"}
currency
object (Currency) 
optional

Currency

payments
array[object (Payment) {19}] 
optional

The details of the payments created as part of the payment collection.

region
object (Region) 
optional

A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.

payment_sessions
array[object (Payment Session) {13}] 
optional

The details of the payment sessions created as part of the payment collection.

Example
Not configured
Last modified: a year ago