PaymentDetails

Overview

Details about a payment made for an order or specific line item.

Field Description

aliases ([Alias])

Aliases referencing a related entity such as a charge in an external payment system.

amount (Money ^required)

The payment amount.

createdAt (String)

The Date Time in ISO 8601 format when the payment was created.

id (ID)

A unique identifier to represent the payment. It is not acceptable for multiple payments to have the same ID within a single list of payments.

payer (Payer)

The person or entity making the payment.

paymentMethod (PaymentMethod ^required)

The payment method associated with the payment.

state (String)

The current state of the payment.

The value is constrained to one of the following

value	description
NOT_STARTED	The payment has not started processing.
CREATED	The payment is created.
FAILED	The payment processing failed.
AUTHORIZED	The payment has been authorized.
CAPTURED	The payment has been captured.
CLIENT_ACTION_REQUIRED	Client needs to complete the actions before the charge can be confirmed (authorize/capture)
READY_FOR_CONFIRMATION	The charge is ready for confirmation (authorize/capture).
IN_PROGRESS	The payment is in progress.
SUCCESS	The payment has succeeded.
CANCELLED	The payment transfer is cancelled.

updatedAt (String)

The Date Time in ISO 8601 format when the payment was last updated.