Get Order
Use this API to fetch the order that was created at Cashfreeās using the order_id
.
When to use this API
- To check the status of your order
- Once the order is PAID
- Once your customer returns to
return_url
Authorizations
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.
Headers
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.
Path Parameters
The id which uniquely identifies your order
Response
The complete order entity
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 yetPAID
: Order is PAID with one successful transactionEXPIRED
: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order.TERMINATED
: Order terminatedTERMINATION_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
Was this page helpful?