Create, update, or delete a list of payment sessions of a Payment Collections. If a payment session is not provided in the sessions array, it's deleted.
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request POST 'https://api.medusa-commerce.com/store/payment-collections//sessions/batch' \
--header'Content-Type: application/json' \
--data-raw''
Response Response Example
200 - Example 1
Request
Path Params
id
string
required
The ID of the Payment Collection.
Body Params application/json
sessions
array [object {3}]
required
Payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted.
provider_id
string
required
The ID of the Payment Provider.
amount
integer
required
The payment amount
session_id
string
optional
The ID of the Payment Session to be updated. If no ID is provided, a new payment session is created.
Examples
Responses
🟢200OK
application/json
Body
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.
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.
