Order lifecycle
Every order moves through a predictable sequence of statuses as it progresses from creation to payment completion. Understanding these transitions helps you build accurate UI states and debug payment flows with confidence.
An authenticated AI agent can inspect live order state, compare recent orders, show governed order analytics, or render an order card while you debug lifecycle questions.
MCP tools: list_orders, get_order, get_order_analytics or render_order_card
Status transitions
Orders and payments have separate state. Read both after every operation; do not infer one from the other.
Move the order forward
Create and finalize
Call Create an order. A draft order has no hosted
invoice. Set finalize
to true to seal it and generate
the invoice, or finalize it later. Before payment starts, use Update an
order to replace mutable details.
Start payment
Call Pay for an order, or set
true
during creation. When confirmation is required, collect the OTP and call Confirm a payment.
- Read
payment.nextAction.typeto decide what the customer must do next. - Use
payment.nextAction.confirmPayment.expiresAtfor the OTP countdown. - After confirmation, wait for provider authorization and continue polling Look up an order.
- Fulfill only when
statusisInttegro.OrderStatuses.Paid.
Complete fulfillment
After delivering the goods or service, call Complete an order. The order moves from
Inttegro.OrderStatuses.Paidto Inttegro.OrderStatuses.Completed
. Completion is terminal.
Handle other outcomes
- If
payment.statusisInttegro.PaymentStatuses.Failed, show the failure and let the customer retry. The order normally remainsInttegro.OrderStatuses.RequiresPayment. - A canceled order has
statusset toInttegro.OrderStatuses.Canceledand cannot restart payment. - An expired order has
statusset toInttegro.OrderStatuses.Expired. Create a new order instead of reviving stale prices or inventory decisions.
Related resources
- Orders API - Complete order endpoint documentation
- Accept a payment - Step-by-step payment guide with code examples
- Product: Orders - High-level overview of the Orders API