curl--location-g--request GET '{{BASE_URL}}/store/payment-collections/'
Response Response Example
200 - Example 1
Request
Path Params
id
stringÂ
required
The ID of the PaymentCollection.
Query Params
fields
stringÂ
optional
Comma-separated fields that should be expanded in the returned payment collection.
expand
stringÂ
optional
Comma-separated relations that should be expanded in the returned payment collection.
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.