PaymentSummaryInput
Version 2024-04-01
Overview
A summary of one or more payments. Contains the minimum information required to represent payments.
Arguments
Argument | Description |
---|---|
amount (MoneyInput 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 (PaymentStateInput) | The current 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. |
Updated about 2 months ago