PaymentCollectionDTO
The payment collection details.
id
stringRequiredThe ID of the payment collection.
currency_code
stringRequiredThe ISO 3 character currency code of the payment sessions and payments associated with payment collection.
region_id
stringRequiredThe id of the associated region.
The total amount to be authorized and captured.
The status of the payment collection.
The payment provider used to process the associated payment sessions and payments.
authorized_amount
BigNumberValueThe amount authorized within the associated payment sessions.
refunded_amount
BigNumberValueThe amount refunded within the associated payments.
completed_at
string | DateWhen the payment collection was completed.
created_at
string | DateWhen the payment collection was created.
updated_at
string | DateWhen the payment collection was updated.
metadata
Record<string, unknown>Holds custom data in key-value pairs.
The associated payment sessions.
The associated payments.
Was this section helpful?