Product Guides

Life Cycle

Learn about the different statuses acquired during the checkout flow for our Orders.

Suggest Edits

Pre-authorization is True

📘

Note:

  • The ATTEMPTED status is currently unavailable. Orders will proceed directly from CREATED to PENDING, skipping the ATTEMPTED status.
  • The transitions from CREATED to CANCELLED and PENDING to CANCELLED are also not available at this time.
  • The diagram illustrates the status flow planned for implementation in future updates.

The figure below shows the life cycle of an Order when the Pre-authorization is set to true.

Figure: Order Life Cycle

Figure: Order Life Cycle

The table below list the various statuses that our Orders can have during its life cycle.

StatusDescription
CREATEDWhen the Create Order request is successfully received by Plural.
ATTEMPTEDWhen the payment on a pending order fails, order acquire this status.
PENDINGWhen the order is linked against a payment request.

Note: To link a payment use the order_id generated in our Create Payment API and create a payment request. This successfully links your payment against the order.
AUTHORIZEDWhen the payment is received successfully. The money is blocked by the issuer at payer account and waiting for the partner authorization to credit to the partner bank account or customer account.

Note: When pre-authorization is enabled, you have the option to either capture or cancel a payment settlement to your account.
  1. Capture Order: Integrate with our Capture Order API to complete the payment for an order. For instance, you can secure the payment once the product or service has been successfully provided to the purchaser. Subsequently, the funds are transferred to the partner’s bank account.
  2. Cancel Order: Utilize the Cancel Order API to revoke the payment for an order. For example, if the product or service fails to reach the buyer, you can annul the payment. The refunded amount will then be credited back to the customer’s account.
PROCESSEDWhen the payment is received successfully. The money is debited from the payer account and credited to the partner bank account successfully.
CANCELLEDWhen the payment is cancelled using our Cancel Order API.
FAILEDPayment acceptance failed for reasons such as maximum retries for OTP verification etc.
FULLY_REFUNDEDWhen the payment is completely refunded. The money is debited from the partner bank account and credited to the customer's bank account.
PARTIALLY_REFUNDEDWhen the partial refund is successful. The money is debited from the partner bank account and credited to the customer's bank account.

Pre-authorization is False

📘

Note:

  • The ATTEMPTED status is currently unavailable. Orders will proceed directly from CREATED to PENDING, skipping the ATTEMPTED status.
  • The transitions from CREATED to CANCELLED and PENDING to CANCELLED are also not available at this time.
  • The diagram illustrates the status flow planned for implementation in future updates.

The figure below shows the life cycle of an Order when the Pre-authorization is set to false.

Figure: Order Life Cycle(PreAuth is false)

Figure: Order Life Cycle(PreAuth is false)

The table below list the various statuses that our Orders can have during its life cycle.

StatusDescription
CREATEDWhen the Create Order request is successfully received by Plural.
ATTEMPTEDWhen the payment on a pending order fails, order acquire this status.
PENDINGWhen the order is linked against a payment request.

Note: To link a payment use the order_id generated in our Create Payment API and create a payment request. This successfully links your payment against the order.
PROCESSEDWhen the payment is received successfully. The money is debited from the payer account and credited to the partner bank account successfully.
CANCELLEDWhen the payment is cancelled using our Cancel Order API.
FAILEDPayment acceptance failed for reasons such as maximum retries for OTP verification etc.
FULLY_REFUNDEDWhen the payment is completely refunded. The money is debited from the partner bank account and credited to the customer's bank account.
PARTIALLY_REFUNDEDWhen the partial refund is successful. The money is debited from the partner bank account and credited to the customer's bank account.

Updated about 1 month ago