Skip to main content
Skip to main content

PaymentCollectionDTO

The payment collection details.

idstringRequired
The ID of the payment collection.
currency_codestringRequired
The ISO 3 character currency code of the payment sessions and payments associated with payment collection.
region_idstringRequired
The id of the associated region.
amountBigNumberValueRequired
The total amount to be authorized and captured.
The status of the payment collection.
payment_providersPaymentProviderDTO[]Required
The payment provider used to process the associated payment sessions and payments.
authorized_amountBigNumberValue
The amount authorized within the associated payment sessions.
refunded_amountBigNumberValue
The amount refunded within the associated payments.
completed_atstring | Date
When the payment collection was completed.
created_atstring | Date
When the payment collection was created.
updated_atstring | Date
When the payment collection was updated.
metadataRecord<string, unknown>
Holds custom data in key-value pairs.
payment_sessionsPaymentSessionDTO[]
The associated payment sessions.
paymentsPaymentDTO[]
The associated payments.
Was this section helpful?