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.
Payment Statuses
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.
| Payment Status | Description | Available Actions |
|---|---|---|
| New | A payment method has been created but authorization or capture has not yet been attempted. |
|
| Pending | An authorization request has been sent to the card issuer or fraud check and is awaiting verification before it can be captured. |
|
| Authorized | An authorization has been created against a valid payment method, meaning funds are reserved on the customer's account to be captured at a later time (typically when goods are shipped or a shipment is marked as fulfilled). |
|
| AuthorizePending | A request has been made to authorize a valid payment method, but it has not yet been fully processed. |
|
| Collected | Funds have been captured from the customer's pre-authorized payment method. You can configure whether you want to capture funds during order placement or fulfillment in your payment type settings. |
|
| CapturePending | A request has been made to capture the full or partial payment amount from the customer's pre-authorized payment method, but it has not yet been fully processed. |
|
| Declined | An error was experienced with the payment information, such as the card information not being valid or a check not clearing. You can re-attempt authorization or capture if the error is fixed. |
|
| Voided | The payment was canceled before being completely captured, so the customer will not be charged for the amount. |
|
| VoidPending | A request has been made to void the payment amount, but it has not yet been fully processed. |
|
| Credited | A full or partial amount was returned to the payment after a capture was performed, such as if the customer wanted to change the the card they paid with. In that case, the original charged card would be credited before creating a new payment for the preferred card. |
|
| CreditPending | A request has been made to return the full or partial amount to the payment method after a capture was performed, but it has not yet been fully processed. |
|
| PaymentRequested | A new purchase order payment has been initiated but not yet authorized. |
|
| Invoiced | A valid purchase order payment has been authorized and is ready to be captured. |
|
Pending Payment Statuses
The "Pending" statuses are useful for asynchronous payment integrations in which Kibo won't know the status of an authorization, capture, void, or credit immediately. When the payment gateway response indicates isPending=true after initiating one of these actions, then the payment will be moved into the appropriate state:
- AuthorizePending
- CapturePending
- VoidPending
- CreditPending
The authorized, collected, and credited amounts will not be updated in the order payment data until it moves into a successful state. You can use the Perform Payment Action API call to manually move the payment to a successful state if needed.
Order Payment Rollup Status
An order-level payment rollup status 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. Any shipment can only be fulfilled if its order payment status is Pending, Paid, Pending and Errored, or Paid and Errored. For more information on this behavior and how to opt out, see the fulfillment documentation.
| Order Payment Status | Description |
|---|---|
| Unpaid | There are no valid payments on the order and no balance has been collected, including if the only payment on the order is in the AuthorizePending state. |
| Pending | There are valid payments on the order to collect the entire order balance, including if the only payment on the order is in the CapturePending state. |
| 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. |
Payment Workflows
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:
Payment Actions
The following table lists all possible payment actions and describes when they can occur. These correspond with both the Admin UI actions and the Perform Payment Action API call.
| Action | Can Occur When Any of the Following are True |
|---|---|
| CreatePayment |
|
| RequestCheck |
|
| RequestPayment |
|
| AuthorizePayment |
|
| InvoicePayment |
|
| ClosePaymentAuth |
|
| AuthAndCapture |
|
| CapturePayment |
|
| CreditPayment |
|
| VoidPayment | Note: This action cannot occur for any payment type that has a Null status.
|
| DeclinePayment |
|
| Rollback |
|