Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

PaymentCollectionDTO

The payment collection details.

idstring
The ID of the payment collection.
currency_codestring
The ISO 3 character currency code of the payment sessions and payments associated with payment collection.
region_idstring
The id of the associated region.
amountBigNumberValue
The total amount to be authorized and captured.
statusPaymentCollectionStatus
The status of the payment collection.
payment_providersPaymentProviderDTO[]
The payment provider used to process the associated payment sessions and payments.
authorized_amountBigNumberValueOptional
The amount authorized within the associated payment sessions.
refunded_amountBigNumberValueOptional
The amount refunded within the associated payments.
captured_amountBigNumberValueOptional
The amount captured within the associated payments.
completed_atstring | DateOptional
When the payment collection was completed.
created_atstring | DateOptional
When the payment collection was created.
updated_atstring | DateOptional
When the payment collection was updated.
metadataRecord<string, unknown>Optional
Holds custom data in key-value pairs.
payment_sessionsPaymentSessionDTO[]Optional
The associated payment sessions.
paymentsPaymentDTO[]Optional
The associated payments.
Was this page helpful?
Edit this page