PaymentSummary

Overview

A summary of one or more payments. Contains the minimum information required to represent payments.

Fields

Field Description

amount (Money ^required)

The total payment amount.

paymentMethodDisplayString (String ^required)

A customer friendly representation of the payment method. E.g. 'Visa ending in 1234'. If there are multiple associated payment methods an appropriate summary should be provided. E.g. 'Multiple payment methods used'

state (String)

The state of the payment. If there are multiple payments with varying states an appropriate aggregate state can be provided. E.g. If payment 1 is AUTHORIZED and payment 2 is IN_PROGRESS, an appropriate aggregate could be IN_PROGRESS.

The value is constrained to one of the following

value	description
NOT_STARTED	The payment has not started processing.
CREATED	The payment is in progress.
CLIENT_ACTION_REQUIRED	The client needs to complete actions before the payment can be confirmed.
READY_FOR_CONFIRMATION	The payment is ready for confirmation.
IN_PROGRESS	The payment is in progress.
AUTHORIZED	The payment has been authorized.
CAPTURED	The Payment has been captured.
CANCELLED	The payment was cancelled.
SUCCESS	The payment succeeded.
FAILED	The payment failed.