PaymentCollection
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.
Properties
id
stringRequiredThe payment collection's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
The type of the payment collection
The type of the payment collection
description
null | stringRequiredDescription of the payment collection
amount
numberRequiredAmount of the payment collection.
authorized_amount
null | numberRequiredAuthorized amount of the payment collection.
region_id
stringRequiredThe ID of the region this payment collection is associated with.
The details of the region this payment collection is associated with.
currency_code
stringRequiredThe three character ISO code for the currency this payment collection is associated with.
The details of the currency this payment collection is associated with.
The details of the payment sessions created as part of the payment collection.
The details of the payments created as part of the payment collection.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
created_by
stringRequiredThe ID of the user that created the payment collection.
Was this section helpful?