Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 1.95 KB

File metadata and controls

38 lines (35 loc) · 1.95 KB

PaymentCollection

Properties

Name Type Description Notes
id String The payment collection's ID
type TypeEnum The type of the payment collection
status StatusEnum The type of the payment collection
description String Description of the payment collection
amount Integer Amount of the payment collection.
authorizedAmount Integer Authorized amount of the payment collection.
regionId String The region's ID
region Region [optional]
currencyCode String The 3 character ISO code for the currency.
currency Currency [optional]
paymentSessions List<PaymentSession> Available if the relation `payment_sessions` is expanded. [optional]
payments List<Payment> Available if the relation `payments` is expanded. [optional]
createdBy String The ID of the user that created the payment collection.
createdAt OffsetDateTime The date with timezone at which the resource was created.
updatedAt OffsetDateTime The date with timezone at which the resource was updated.
deletedAt OffsetDateTime The date with timezone at which the resource was deleted.
metadata Object An optional key-value map with additional details

Enum: TypeEnum

Name Value
ORDER_EDIT "order_edit"

Enum: StatusEnum

Name Value
NOT_PAID "not_paid"
AWAITING "awaiting"
AUTHORIZED "authorized"
PARTIALLY_AUTHORIZED "partially_authorized"
CANCELED "canceled"