Skip to content

Latest commit

 

History

History
28 lines (26 loc) · 2.08 KB

File metadata and controls

28 lines (26 loc) · 2.08 KB

PaymentSession

Properties

Name Type Description Notes
id String The payment session's ID
cartId String The id of the Cart that the Payment Session is created for.
cart Cart [optional]
providerId String The id of the Payment Provider that is responsible for the Payment Session
isSelected Boolean A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.
isInitiated Boolean A flag to indicate if a communication with the third party provider has been initiated.
status StatusEnum Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.
data Object The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.
idempotencyKey String Randomly generated key used to continue the completion of a cart in case of failure.
amount Integer The amount that the Payment Session has been authorized for.
paymentAuthorizedAt OffsetDateTime The date with timezone at which the Payment Session was authorized.
createdAt OffsetDateTime The date with timezone at which the resource was created.
updatedAt OffsetDateTime The date with timezone at which the resource was updated.

Enum: StatusEnum

Name Value
AUTHORIZED "authorized"
PENDING "pending"
REQUIRES_MORE "requires_more"
ERROR "error"
CANCELED "canceled"