The Order Payment Summary object represents one or more payments that use the same payment method and are associated with the same order summary. The order payment summary’s values are the sums of the values of the included payments. Unlike most summary objects, there’s no corresponding Order Payment object.
Required Editions
| View supported editions. |
This table lists the fields on the Order Payment Summary object.
| Field Label | Description |
|---|---|
| Authorization Reversed | The amount of the order payment summary that has been authorized. |
| Authorized | The authorized amount of the order payment summary that has been reversed. |
| Available to Capture |
The amount of the order payment summary that is available to be captured. Available to Capture = Authorized - (Authorization Reversed + Pending Authorization Reversal) - (Captured + Pending Capture). This value is zero if negative. |
| Available to Refund |
The amount of the order payment summary that is available to be refunded. Available to Refund = Captured – (Refunded Amount + Pending Capture Amount + Pending Refund Amount) |
| Balance | The total balance of all payments associated with the order payment summary. |
| Captured | The amount of the order payment summary that has been captured. |
| Full Name | The full name of the payment method user. |
| Last Payment Gateway Log | The most recent payment gateway log associated with the order payment summary. |
| Last Payment Gateway Message | The most recent message received from the payment gateway associated with the order payment summary. |
| Method | The name of the order payment summary. |
| Order Summary | The order summary associated with the order payment summary. |
| Payment Method | The payment method associated with the order payment summary. |
| Pending Authorization Amount | The amount of the order payment summary that is pending authorization. |
| Pending Authorization Reversal | The authorized amount of the order payment summary that is pending reversal. |
| Pending Capture | The amount of the order payment summary that is pending capture. |
| Pending Refund | The amount of the order payment summary that is pending refund. |
| Refunded | The amount of the order payment summary that has been reversed. |
| Type | The payment method type associated with the order payment summary, for example, credit card, check, or gift card. |