There are a number of statuses that individual payments may be, as well as order-level rollup statuses that summarize the states of all payments on the order. These states are associated with particular actions that are possible to perform during that state.
The following table lists all payment-level statuses and the available payment actions for each status. These statuses are reflected in payment object data when interfacing with order data via API, and apply individually to each payment method.
To learn more about the payment actions, refer to the corresponding table on actions.
|Payment Status||Available Actions|
Order Payment Rollup Status
However, there is also an order-level payment rollup status that summarizes the overall payment status across all payments that belong to the order even if they are in different individual statuses of their own. This status is displayed on the order details page of the Admin UI as well as order object data in the API.
This order-level status determines whether or not a shipment is able to be fulfilled. A shipment can only be fulfilled if the order payment status is Pending, Paid, Pending and Errored, or Paid and Errored. If the status is Unpaid or Errored, then all shipments on the order will be blocked from being fulfilled through either API or the Fulfiller UI regardless of any individual shipment's current state.
For more information on this behavior and how to opt out, see the fulfillment documentation.
These rollup statuses are:
|Order Payment Status||Description|
|Unpaid||There are no valid payments on the order and no balance has been collected.|
|Pending||There are valid payments on the order to collect the entire order balance.|
|Paid||There is zero balance remaining across all payment methods on the order.|
|Pending And Errored||There are pending payments as well as payments with errors of the type Void or Credit.|
|Paid And Errored||The order is fully collected but there are Credit errors.|
|Errored||Something is wrong with the payments on the order and at least one valid payment is still needed to cover the order balance. Not every payment has to be errored to trigger this status - for example, if a single payment failure means that there isn't enough payment to cover the order balance, the order will enter this Errored state.|
The exact workflow that a payment goes through to reach the above statuses differs depending on the payment type. Credit cards, gateway gift cards, and third-party payment methods use the below workflow:
Store credit and store gift cards follow a simpler process:
Checks follow their own unique workflow:
Purchase orders also have a unique workflow:
The following table lists the available payment actions and describes when they can occur.
|Action||Can Occur When Any of the Following are True|
|VoidPayment||Note: This action cannot occur for any payment type that has a Null status.|