Skip to main content

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.

Use MCP to investigate order state

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.

StageOrderPaymentNext action
Draft or finalizedInttegro.OrderStatuses.PreparingInttegro.PaymentStatuses.RequiresActionInttegro.PaymentNextActionTypes.Execute
Payment startedInttegro.OrderStatuses.RequiresPaymentInttegro.PaymentStatuses.RequiresActionInttegro.PaymentNextActionTypes.ConfirmPayment
OTP confirmedInttegro.OrderStatuses.RequiresPaymentInttegro.PaymentStatuses.RequiresActionInttegro.PaymentNextActionTypes.AuthorizePayment
Payment successfulInttegro.OrderStatuses.PaidInttegro.PaymentStatuses.Paidnull
FulfilledInttegro.OrderStatuses.CompletedInttegro.PaymentStatuses.Paidnull

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

executePayment to

true

during creation. When confirmation is required, collect the OTP and call Confirm a payment.

Complete fulfillment​

After delivering the goods or service, call Complete an order. The order moves from

Inttegro.OrderStatuses.Paid

to Inttegro.OrderStatuses.Completed

. Completion is terminal.

Handle other outcomes