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

idstringRequired

The payment collection's ID

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

typeORDER_EDITRequired

The type of the payment collection

statusPaymentCollectionStatusRequired

The type of the payment collection

descriptionnull | stringRequired

Description of the payment collection

amountnumberRequired

Amount of the payment collection.

authorized_amountnull | numberRequired

Authorized amount of the payment collection.

region_idstringRequired

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

regionRegionRequired

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

currency_codestringRequired

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

currencyCurrencyRequired

The details of the currency this payment collection is associated with.

payment_sessionsPaymentSession[]Required

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

paymentsPayment[]Required

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

metadataRecord<string, unknown>Required

An optional key-value map with additional details

created_bystringRequired

The ID of the user that created the payment collection.