{ "opencollection": "1.0.0", "info": { "name": "Cashfree Payment Gateway APIs Authorize Orders API", "version": "2025-01-01" }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Create Order", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox.cashfree.com/pg/orders", "headers": [ { "name": "x-api-version", "value": "2025-01-01" }, { "name": "x-request-id", "value": "4dfb9780-46fe-11ee-be56-0242ac120002" }, { "name": "x-idempotency-key", "value": "47bf8872-46fe-11ee-be56-0242ac120002" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "### Order\nAn order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for.\nUse this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. \nYou can use the `payment_sessions_id` to create a transaction for the order.\n" }, { "info": { "name": "Get Order", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.cashfree.com/pg/orders/:order_id", "headers": [ { "name": "x-api-version", "value": "2025-01-01" }, { "name": "x-request-id", "value": "4dfb9780-46fe-11ee-be56-0242ac120002" }, { "name": "x-idempotency-key", "value": "47bf8872-46fe-11ee-be56-0242ac120002" } ], "params": [ { "name": "order_id", "value": "your-order-id", "type": "path", "description": "The id which uniquely identifies your order" } ], "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "Use this API to fetch the order that was created at Cashfree's using the `order_id`. \n## When to use this API\n- To check the status of your order\n- Once the order is PAID\n- Once your customer returns to `return_url`\n" }, { "info": { "name": "Terminate Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://sandbox.cashfree.com/pg/orders/:order_id", "headers": [ { "name": "x-api-version", "value": "2025-01-01" }, { "name": "x-request-id", "value": "4dfb9780-46fe-11ee-be56-0242ac120002" }, { "name": "x-idempotency-key", "value": "47bf8872-46fe-11ee-be56-0242ac120002" } ], "params": [ { "name": "order_id", "value": "your-order-id", "type": "path", "description": "The id which uniquely identifies your order" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "Use this API to terminate the order that was created at Cashfree's using the `order_id`." }, { "info": { "name": "Get Order Extended", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox.cashfree.com/pg/orders/:order_id/extended", "headers": [ { "name": "x-api-version", "value": "2025-01-01" }, { "name": "x-request-id", "value": "4dfb9780-46fe-11ee-be56-0242ac120002" }, { "name": "x-idempotency-key", "value": "47bf8872-46fe-11ee-be56-0242ac120002" } ], "params": [ { "name": "order_id", "value": "your-order-id", "type": "path", "description": "The id which uniquely identifies your order" } ], "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "Use this API to fetch the order related data like address,cart,offers,customer details etc using the Cashfree's `order_id`.\n## When to use this API\n- To get the extended data associated with order.\n- Once the order is PAID\n- Once your customer returns to `return_url`\n" } ] } ], "bundled": true }