Terminate Order

Client app ID. You can find your app id in the Merchant Dashboard.

Client secret key. You can find your secret in the Merchant Dashboard.

API version to be used. Format is in YYYY-MM-DD

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

The id which uniquely identifies your order

To terminate an order, pass order_status as "TERMINATED". Please note, order might not be terminated - confirm with the order_status in response. "TERMINATION_REQUESTED" states that the request is recieved and we are working on it. If the order terminates successfully, status will change to "TERMINATED". Incase there's any active transaction which moved to success - order might not get terminated.

unique id generated by cashfree for your order

order_id sent during the api request

Type of the entity.

Currency of the order. Example INR

Possible values are

• ACTIVE: Order does not have a sucessful transaction yet
• PAID: Order is PAID with one successful transaction
• EXPIRED: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order. TERMINATED: Order terminated TERMINATION_REQUESTED: Order termination requested

Additional note for order

When the order was created at cashfree's server

The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.

Optional meta details to control how the customer pays and how payment journey completes

Custom Tags in thr form of {"key":"value"} which can be passed for an order. A maximum of 10 tags can be added

Cart Details in the Order Entity Response