Order and Installment statuses

In CrediPay, we work with two main status flows: one for Orders, and another one for Installments. Find below a description of each of flows:

Orders

1. Created: Once the POST v1/orders endpoint is called successfully, a new order will be created in CrediPay, with the Created status.
2. Finalized: The integrator should call the POST v1/orders/{orderId}/finalize endpoint once the order is confirmed and ready to be shipped. This will cause the order to move to the Finalized status. In some scenarios this might not be needed, make sure to align with your CrediPay representantive.
3. Captured: This is the last status of the order flow and it happens once an Invoice is attached to the order via the POST v1/invoices. After that, the Installment entities are created and their status flow start. From this point onwards, an order cannot be cancelled.
4. Cancelled: An order may be cancelled through the POST v1/orders/{orderId}/cancel endpoint. A cancelled order will not take up any credit limit, and may not be "uncancelled".

Installments

In the Installment status flow, no endpoint calls from the integrator are required. An installment has 2 main statuses:

1. FundingSuccess: The amount related to that installment's advancement has been disbursed to the seller. When that's the case, there will also be a funded_at timestamp.
2. Settled: The buyer has paid CrediPay, in a timestamp stored in the settled_at field. This means that the full Order and Status lifecycle has reached its end.

PS: Any other installment status means that it is being internally processed by CrediPay and it has not yet been disbursed to the seller