PaymentSummary

Version 2024-04-01

📘

Important

The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.

Overview

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

Fields

FieldDescription
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

valuedescription
NOT_STARTEDPayment has not started processing
CREATEDPayment is in progress
CLIENT_ACTION_REQUIREDClient must complete actions before payment confirmation
READY_FOR_CONFIRMATIONPayment is ready for confirmation
IN_PROGRESSPayment is in progress
AUTHORIZEDPayment has been authorized
CAPTUREDPayment has been captured
CANCELLEDPayment was cancelled
SUCCESSPayment succeeded
FAILEDPayment failed