OrderDisplayFinancialStatus
Represents the order's current financial status.
Anchor to Valid valuesValid values
- Anchor to AUTHORIZEDAUTHORIZED•
Displayed as Authorized. The payment provider has validated the customer's payment information. This status appears only for manual payment capture and indicates payments should be captured before the authorization period expires.
- Anchor to EXPIREDEXPIRED•
Displayed as Expired. Payment wasn't captured before the payment provider's deadline on an authorized order. Some payment providers use this status to indicate failed payment processing.
- Anchor to PAIDPAID•
Displayed as Paid. Payment was automatically or manually captured, or the order was marked as paid.
- Anchor to PARTIALLY_PAIDPARTIALLY_PAID•
Displayed as Partially paid. A payment was manually captured for the order with an amount less than the full order value.
- Anchor to PARTIALLY_REFUNDEDPARTIALLY_REFUNDED•
Displayed as Partially refunded. The amount refunded to a customer is less than the full amount paid for an order.
- Anchor to PENDINGPENDING•
Displayed as Pending. Orders have this status when the payment provider needs time to complete the payment, or when manual payment methods are being used.
- Anchor to REFUNDEDREFUNDED•
Displayed as Refunded. The full amount paid for an order was refunded to the customer.
- Anchor to VOIDEDVOIDED•
Displayed as Voided. An unpaid (payment authorized but not captured) order was manually canceled.
Anchor to FieldsFields
- •OBJECT
The financial status of the order that can be shown to the merchant. This field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes.