Payment States

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.

• AuthAndCapture
• AuthorizePayment
• CapturePayment
• CreatePayment
• CreditPayment
• DeclinePayment
• RequestCheck
• RequestPayment
• VoidPayment

| | Pending | An authorization request has been sent to the card issuer or fraud check and is awaiting verification before it can be captured. |

• AuthAndCapture
• AuthorizePayment
• CapturePayment
• DeclinePayment
• VoidPayment

| | 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). |

• CapturePayment
• ClosePaymentAuth
• DeclinePayment
• InvoicePayment
• VoidPayment

| | AuthorizePending | A request has been made to authorize a valid payment method, but it has not yet been fully processed. |

• AuthAndCapture
• AuthorizePayment
• Rollback

| | 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. |

• CreditPayment
• DeclinePayment
• Rollback
• VoidPayment

| | 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. |

• CapturePayment
• Rollback

| | 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. |

• AuthAndCapture
• AuthorizePayment
• CapturePayment
• Rollback
• VoidPayment

| | Voided | The payment was canceled before being completely captured, so the customer will not be charged for the amount. |

• Rollback

| | VoidPending | A request has been made to void the payment amount, but it has not yet been fully processed. |

• VoidPayment
• Rollback

| | 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. |

• CreditPayment
• Rollback

| | 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. |

• CreditPayment
• Rollback

| | PaymentRequested | A new purchase order payment has been initiated but not yet authorized. |

• AuthorizePayment
• VoidPayment

| | Invoiced | A valid purchase order payment has been authorized and is ready to be captured. |

• CapturePayment
• ClosePaymentAuth
• VoidPayment

|

​

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.

​

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.

• A new payment can be added on the order.

| | RequestCheck |

• A check has a New status.

| | RequestPayment |

• A purchase order has a New status.

| | AuthorizePayment |

• A credit card has a New or Declined status.
• A purchase order has a PaymentRequested status.
• Any payment has an AuthorizePending status.

| | InvoicePayment |

• A purchase order has an Authorized status.

| | ClosePaymentAuth |

• A purchase order has an Authorized or Invoiced status, and the amount requested exceeds the amount collected.

| | AuthAndCapture |

• An external payment has a New status.
• A credit card has a New or Declined status.
• Any payment has an AuthorizePending status.

| | CapturePayment |

• Any payment has a CapturePending status.
• An external payment has a New, Authorized, or Pending status.
• A check has a Pending or Declined status.
• A credit card has an Authorized status.
• A purchase order has an Authorized or Invoiced status.
• A PayPal Express payment has a New, Authorized, or Pending status.
• A store credit has a New status.

| | CreditPayment |

• A payment has a Collected status.
• The payment is a check or store credit.
• The payment has a Credited or CreditPending status, and the amount collected exceeds the amount credited.

| | VoidPayment | Note:  This action cannot occur for any payment type that has a Null status.

• Any payment has a VoidPending status.
• An external payment has a New, Authorized, or Pending status.
• A credit card has a New, Pending or Authorized status.
• A credit card has a Collected status and the last interaction is a manual interaction.
• A check has a New, Pending, Authorized, or Collected status.
• A store credit has a New, Pending, or Authorized status.
• A PayPal Express payment has a New status.
• A purchase order has a New, Pending, PaymentRequested, Authorized, or Invoiced status, and there is no amount collected on the payment.

| | DeclinePayment |

• A check has a Pending status.
• A credit card has an Authorized status.
• An external payment has an Authorized status.

| | Rollback |

• The last non-rollbacked interaction on a payment is a manual interaction, and that interaction is not the first one performed on a payment.

|