Cashfree Payments Orders API

openapi: 3.2.0
info:
  version: '2025-01-01'
  title: Cashfree Payment Gateway APIs Authorize Orders API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    email: developers@cashfree.com
    name: API Support
    url: https://discord.com/invite/QdZkNSxXsB
  description: Cashfree's Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
servers:
- url: https://sandbox.cashfree.com/pg
  description: Sandbox server
- url: https://api.cashfree.com/pg
  description: Production server
tags:
- name: Orders
  description: Collection of APIs to handle orders.
paths:
  /orders:
    post:
      summary: Create Order
      x-mcp:
        enabled: true
        config:
          elicitation:
            $ref: '#/components/x-elicitationConfig/createOrder'
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      description: "### 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"
      tags:
      - Orders
      operationId: PGCreateOrder
      deprecated: false
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateOrderRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEntity'
          headers:
            x-api-version:
              $ref: '#/components/headers/x-api-version'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-retry:
              $ref: '#/components/headers/x-ratelimit-retry'
            x-ratelimit-type:
              $ref: '#/components/headers/x-ratelimit-type'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
            x-idempotency-key:
              $ref: '#/components/headers/x-idempotency-key'
            x-idempotency-replayed:
              $ref: '#/components/headers/x-idempotency-replayed'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '409':
          $ref: '#/components/responses/Response409'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /orders/{order_id}:
    get:
      summary: Get Order
      x-mcp:
        enabled: true
      description: "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"
      tags:
      - Orders
      operationId: PGFetchOrder
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/orderIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEntity'
          headers:
            x-api-version:
              $ref: '#/components/headers/x-api-version'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-retry:
              $ref: '#/components/headers/x-ratelimit-retry'
            x-ratelimit-type:
              $ref: '#/components/headers/x-ratelimit-type'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
            x-idempotency-key:
              $ref: '#/components/headers/x-idempotency-key'
            x-idempotency-replayed:
              $ref: '#/components/headers/x-idempotency-replayed'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '409':
          $ref: '#/components/responses/Response409'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
    patch:
      summary: Terminate Order
      description: Use this API to terminate the order that was created at Cashfree's using the `order_id`.
      tags:
      - Orders
      operationId: PGTerminateOrder
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/orderIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/TerminateOrderRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEntity'
          headers:
            x-api-version:
              $ref: '#/components/headers/x-api-version'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-retry:
              $ref: '#/components/headers/x-ratelimit-retry'
            x-ratelimit-type:
              $ref: '#/components/headers/x-ratelimit-type'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
            x-idempotency-key:
              $ref: '#/components/headers/x-idempotency-key'
            x-idempotency-replayed:
              $ref: '#/components/headers/x-idempotency-replayed'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '409':
          $ref: '#/components/responses/Response409'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /orders/{order_id}/extended:
    get:
      summary: Get Order Extended
      x-mcp:
        enabled: true
      description: 'Use this API to fetch the order related data like address,cart,offers,customer details etc using the Cashfree''s `order_id`.

        ## When to use this API

        - To get the extended data associated with order.

        - Once the order is PAID

        - Once your customer returns to `return_url`

        '
      tags:
      - Orders
      operationId: PGFetchOrderExtendedData
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/orderIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderExtendedDataEntity'
          headers:
            x-api-version:
              $ref: '#/components/headers/x-api-version'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-retry:
              $ref: '#/components/headers/x-ratelimit-retry'
            x-ratelimit-type:
              $ref: '#/components/headers/x-ratelimit-type'
            x-request-id:
              $ref: '#/components/headers/x-request-id'
            x-idempotency-key:
              $ref: '#/components/headers/x-idempotency-key'
            x-idempotency-replayed:
              $ref: '#/components/headers/x-idempotency-replayed'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '409':
          $ref: '#/components/responses/Response409'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
components:
  schemas:
    ProductDetails:
      type: object
      description: Specify the required configurations for this feature
      properties:
        enabled:
          type: boolean
          description: Option to enable or disable the feature
        conditions:
          type: array
          description: The conditions array allows to configure rules by adding condition objects with specific parameters for feature configurations.
          items:
            $ref: '#/components/schemas/ProductConditions'
    OfferDetails:
      title: OfferDetails
      description: Offer details and type
      type: object
      example:
        offer_type: DISCOUNT_AND_CASHBACK
        discount_details:
          discount_type: flat
          discount_value: '10'
          max_discount_amount: '10'
        cashback_details:
          cashback_type: percentage
          cashback_value: '20'
          max_cashback_amount: '150'
      properties:
        offer_type:
          type: string
          description: Offer Type for the Offer.
          enum:
          - DISCOUNT
          - CASHBACK
          - DISCOUNT_AND_CASHBACK
          - NO_COST_EMI
          minLength: 3
          maxLength: 50
          example: DISCOUNT_AND_CASHBACK
        discount_details:
          $ref: '#/components/schemas/DiscountDetails'
        cashback_details:
          $ref: '#/components/schemas/CashbackDetails'
      required:
      - offer_type
    OfferValidations:
      title: OfferValidations
      description: Offer validation object
      type: object
      example:
        min_amount: 10
        payment_method:
          wallet:
            issuer: paytm
        max_allowed: 2
      properties:
        min_amount:
          type: number
          description: Minimum Amount for Offer to be Applicable
          minimum: 1
          example: 1
        max_allowed:
          type: number
          description: Maximum Amount for Offer to be Applicable
          minimum: 1
          example: 1
        payment_method:
          example:
            wallet:
              issuer: paytm
          oneOf:
          - $ref: '#/components/schemas/OfferAll'
          - $ref: '#/components/schemas/OfferCard'
          - $ref: '#/components/schemas/OfferNB'
          - $ref: '#/components/schemas/OfferWallet'
          - $ref: '#/components/schemas/OfferUPI'
          - $ref: '#/components/schemas/OfferPaylater'
          - $ref: '#/components/schemas/OfferEMI'
      required:
      - max_allowed
      - payment_method
    IdempotencyError:
      title: IdempotencyError
      description: Error when idempotency fails. Different request body with the same idempotent key
      example:
        message: something is not found
        code: request_invalid
        type: idempotency_error
      type: object
      properties:
        message:
          type: string
        help:
          type: string
        code:
          type: string
        type:
          type: string
          enum:
          - idempotency_error
          description: idempotency_error
    OfferAll:
      title: All Offers
      description: returns all offers
      example:
        all: {}
      type: object
      properties:
        all:
          $ref: '#/components/schemas/AllOffers'
      required:
      - all
    AddressDetails:
      title: AddressDetails
      description: Address associated with the customer.
      type: object
      example:
        name: Aditya Keshri
        address_line_one: MK Building
        address_line_two: Test Address
        country: India
        country_code: IN
        state: Karnataka
        state_code: KA
        city: Bangalore
        pin_code: '560034'
        phone: +91 1118911189
        email: test@cashfree.com
      properties:
        name:
          type: string
          description: Full Name of the customer associated with the address.
        address_line_one:
          type: string
          description: First line of the address.
        address_line_two:
          type: string
          description: Second line of the address.
        country:
          type: string
          description: Country Name.
        country_code:
          type: string
          description: Country Code.
        state:
          type: string
          description: State Name.
        state_code:
          type: string
          description: State Code.
        city:
          type: string
          description: City Name.
        pin_code:
          type: string
          description: Pin Code/Zip Code.
        phone:
          type: string
          description: Customer Phone Number.
        email:
          type: string
          description: Cutomer Email Address.
    TerminalData:
      description: Terminal Data in the create order response
      example:
        agent_mobile_number: '9876543214'
        cf_terminal_id: 1838
        merchant_terminal_id: ahdsgadjhgfaj7137e
        terminal_type: STOREFRONT
      properties:
        agent_mobile_number:
          type: string
        cf_terminal_id:
          type: integer
        merchant_terminal_id:
          type: string
        terminal_type:
          type: string
      title: TerminalData
      type: object
    CustomerDetailsResponse:
      title: CustomerDetailsResponse
      description: The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.
      example:
        customer_id: 7112AAA812234
        customer_email: john@cashfree.com
        customer_phone: '9908734801'
        customer_name: John Doe
        customer_bank_account_number: '1518121112'
        customer_bank_ifsc: XITI0000001
        customer_bank_code: 3333
        customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
      type: object
      properties:
        customer_id:
          type: string
          description: A unique identifier for the customer. Use alphanumeric values only.
          minLength: 3
          maxLength: 50
        customer_email:
          type: string
          description: Customer email address.
          minLength: 3
          maxLength: 100
        customer_phone:
          type: string
          description: Customer phone number.
          minLength: 10
          maxLength: 10
        customer_name:
          type: string
          description: Name of the customer.
          minLength: 3
          maxLength: 100
        customer_bank_account_number:
          type: string
          description: Customer bank account. Required if you want to do a bank account check (TPV)
          minLength: 3
          maxLength: 20
        customer_bank_ifsc:
          type: string
          description: Customer bank IFSC. Required if you want to do a bank account check (TPV)
        customer_bank_code:
          type: number
          description: Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)
        customer_uid:
          type: string
          description: Customer identifier at Cashfree. You will get this when you create/get customer
    OfferTnc:
      title: OfferMeta
      type: object
      description: Offer terms and condition object
      example:
        offer_tnc_type: text
        offer_tnc_value: TnC for the Offer.
      properties:
        offer_tnc_type:
          type: string
          description: TnC Type for the Offer. It can be either `text` or `link`
          enum:
          - text
          - link
          minLength: 3
          maxLength: 50
          example: text
        offer_tnc_value:
          type: string
          description: TnC for the Offer.
          minLength: 3
          maxLength: 100
          example: Lorem ipsum dolor sit amet, consectetur adipiscing elit
      required:
      - offer_tnc_type
      - offer_tnc_value
    CardArray:
      title: card array
      description: short code for credit card, debit card, prepaid card
      type: string
      example: dc
    OfferMeta:
      title: OfferMeta
      type: object
      description: Offer meta details object
      example:
        offer_title: some title
        offer_description: some offer description
        offer_code: CFTESTOFFER
        offer_start_time: '2023-03-21T08:09:51Z'
        offer_end_time: '2023-03-29T08:09:51Z'
      properties:
        offer_title:
          type: string
          description: Title for the Offer.
          minLength: 3
          maxLength: 50
          example: Test Offer
        offer_description:
          type: string
          description: Description for the Offer.
          minLength: 3
          maxLength: 100
          example: Lorem ipsum dolor sit amet, consectetur adipiscing elit
        offer_code:
          type: string
          description: Unique identifier for the Offer.
          minLength: 1
          maxLength: 45
          example: CFTESTOFFER
        offer_start_time:
          type: string
          description: Start Time for the Offer
          minLength: 3
          maxLength: 20
          example: '2023-03-21T08:09:51Z'
        offer_end_time:
          type: string
          description: Expiry Time for the Offer
          example: '2023-03-29T08:09:51Z'
      required:
      - offer_title
      - offer_description
      - offer_code
      - offer_start_time
      - offer_end_time
    BadRequestError:
      title: BadRequestError
      description: Invalid request received from client
      example:
        message: bad URL, please check API documentation
        code: request_failed
        type: invalid_request_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        help:
          type: string
        type:
          type: string
          enum:
          - invalid_request_error
    ProductConditionsEntity:
      type: object
      properties:
        action:
          type: string
          description: The Action key in the conditions array specifies whether a condition is allowed or denied for the specified rule or feature
        key:
          type: string
          description: key of the condition
          maxLength: 50
        values:
          type: array
          description: Values set for the condition
          maxItems: 10
          items:
            type: string
    CartAddress:
      title: CartAddress
      description: Address given for cart details.
      properties:
        full_name:
          type: string
        country:
          type: string
        city:
          type: string
        state:
          type: string
        pincode:
          type: string
        address_1:
          type: string
        address_2:
          type: string
    OrderEntity:
      title: OrderEntity
      type: object
      description: The complete order entity
      example:
        $ref: '#/components/examples/order_entity_list_example/value/0'
      properties:
        cf_order_id:
          type: string
          description: unique id generated by cashfree for your order
        order_id:
          type: string
          description: order_id sent during the api request
        entity:
          type: string
          description: Type of the entity.
        order_currency:
          type: string
          description: Currency of the order. Example INR
        order_amount:
          type: number
        order_status:
          type: string
          description: "Possible values are \n- `ACTIVE`: Order does not have a sucessful transaction yet\n- `PAID`: Order is PAID with one successful transaction\n- `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order.\n`TERMINATED`: Order terminated\n`TERMINATION_REQUESTED`: Order termination requested"
        payment_session_id:
          type: string
        order_expiry_time:
          type: string
          format: date-time
        order_note:
          type: string
          description: Additional note for order
        created_at:
          type: string
          format: date-time
          description: When the order was created at cashfree's server
          example: '2022-08-16T14:45:38+05:30'
        order_splits:
          type: array
          items:
            $ref: '#/components/schemas/VendorSplit'
        customer_details:
          $ref: '#/components/schemas/CustomerDetailsResponse'
        order_meta:
          $ref: '#/components/schemas/OrderMeta'
        order_tags:
          $ref: '#/components/schemas/OrderTags'
        cart_details:
          $ref: '#/components/schemas/CartDetailsEntity'
        terminal_data:
          $ref: '#/components/schemas/TerminalData'
        products:
          type: object
          description: Configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account
          properties:
            one_click_checkout:
              $ref: '#/components/schemas/ProductDetailsEntity'
            verify_pay:
              $ref: '#/components/schemas/ProductDetailsEntity'
    DiscountDetails:
      title: DiscountDetails
      description: detils of the discount object of offer
      example:
        discount_type: flat
        discount_value: '10'
        max_discount_amount: '10'
      type: object
      properties:
        discount_type:
          type: string
          description: Type of discount
          enum:
          - flat
          - percentage
          minLength: 3
          maxLength: 50
        discount_value:
          type: number
          format: float64
          description: Value of Discount.
        max_discount_amount:
          type: number
          format: float64
          description: Maximum Value of Discount allowed.
      required:
      - discount_type
      - discount_value
      - max_discount_amount
    ProductConditions:
      type: object
      properties:
        action:
          type: string
          description: The Action key in the conditions array specifies whether a condition should "ALLOW" or "DENY" the specified rule or feature
        key:
          type: string
          description: Specify what you're trying to configure, such as "features"
          maxLength: 50
        values:
          type: array
          description: Define the values you need to set within the conditions in this array, such as "checkoutCollectAddress", "checkoutAuthenticate"
          maxItems: 10
          items:
            type: string
    TerminalDetails:
      description: Use this if you are creating an order for cashfree's softPOS
      example:
        added_on: '2023-08-04T13:12:58+05:30'
        cf_terminal_id: '31051123'
        last_updated_on: '2023-09-06T14:07:00+05:30'
        terminal_address: Banglore
        terminal_id: terminal-123
        terminal_name: test
        terminal_note: POS vertical
        terminal_phone_no: '6309291183'
        terminal_status: ACTIVE
        terminal_type: SPOS
      properties:
        added_on:
          description: date time at which terminal is added
          type: string
        cf_terminal_id:
          description: Cashfree terminal id, this is a required parameter when you do not provide the terminal phone number.
          type: string
        last_updated_on:
          description: last instant when this terminal was updated
          type: string
        terminal_address:
          description: location of terminal
          type: string
        terminal_id:
          description: terminal id for merchant reference
          maxLength: 100
          minLength: 3
          type: string
        terminal_name:
          description: name of terminal/agent/storefront
          type: string
        terminal_note:
          description: note given by merchant while creating the terminal
          type: string
        terminal_phone_no:
          description: mobile num of the terminal/agent/storefront,This is a required parameter when you do not provide the cf_terminal_id.
          type: string
        terminal_status:
          description: status of terminal active/inactive
          type: string
        terminal_type:
          description: To identify the type of terminal product in use, in this case it is SPOS.
          maxLength: 10
          minLength: 4
          type: string
      required:
      - terminal_type
      title: Terminal
      type: object
    CreateOrderRequest:
      title: CreateOrderRequest
      description: Request body to create an order at cashfree
      type: object
      properties:
        order_id:
          type: string
          description: Order identifier present in your system. Alphanumeric, '_' and '-' only
          minLength: 3
          maxLength: 45
          example: your-order-id
        order_amount:
          type: number
          description: Bill amount for the order. Provide upto two decimals. 10.15 means Rs 10 and 15 paisa
          format: double
          example: 10.15
          minimum: 1
        order_currency:
          type: string
          description: Currency for the order. INR if left empty. Contact care@cashfree.com to enable new currencies.
          example: INR
        cart_details:
          allOf:
          - $ref: '#/components/schemas/CartDetails'
        customer_details:
          allOf:
          - $ref: '#/components/schemas/CustomerDetails'
          example:
            customer_id: 7112AAA812234
            customer_email: john@cashfree.com
            customer_phone: '9908734801'
        terminal:
          allOf:
          - $ref: '#/components/schemas/TerminalDetails'
          example:
            terminal_phone_no: '6309291183'
            terminal_id: terminal-1212
            terminal_type: SPOS
        order_meta:
          allOf:
          - $ref: '#/components/schemas/OrderMeta'
          example:
            return_url: https://www.cashfree.com/devstudio/thankyou
            payment_methods: cc,dc
        order_expiry_time:
          type: string
          format: ISO8601
          description: Time after which the order expires. Customers will not be able to make the payment beyond the time specified here. We store timestamps in IST, but you can provide them in a valid ISO 8601 time format. Example 2021-07-02T10:20:12+05:30 for IST, 2021-07-02T10:20:12Z for UTC
          example: '2021-07-02T10:20:12+05:30'
        order_note:
          type: string
          description: Order note for reference.
          example: Test order
          minLength: 3
          maxLength: 200
        order_tags:
          allOf:
          - $ref: '#/components/schemas/OrderTags'
          example:
            name: John Doe
            city: Bangalore
        order_splits:
          type: array
          description: If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.
          items:
            $ref: '#/components/schemas/VendorSplit'
          example:
          - amount: 10
            vendor: john
        products:
          title: products
          type: object
          description: Use this to set configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account
          properties:
            one_click_checkout:
              allOf:
              - $ref: '#/components/schemas/ProductDetails'
            verify_pay:
              allOf:
              - $ref: '#/components/schemas/ProductDetails'
      required:
      - order_amount
      - order_currency
      - customer_details
    AuthenticationError:
      title: AuthenticationError
      description: Error if api keys are wrong
      example:
        message: authentication Failed
        code: request_failed
        type: authentication_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        type:
          type: string
          description: authentication_error
    TerminateOrderRequest:
      title: TerminateOrderRequest
      description: Request to terminate an active order at Cashfree
      example:
        order_status: TERMINATED
      type: object
      properties:
        order_status:
          type: string
          description: 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.
      required:
      - order_status
    ApiError409:
      title: ApiError409
      description: duplicate request
      example:
        message: order with same id is already present
        code: order_already_exists
        type: invalid_request_error
      type: object
      properties:
        message:
          type: string
        help:
          type: string
        code:
          type: string
        type:
          type: string
          enum:
          - invalid_request_error
          description: invalid_request_error
    OfferCard:
      title: Card Offer
      description: Offers related to cards
      example:
        card:
          type:
          - cc
          bank_name: hdfc bank
          scheme_name:
          - visa
      type: object
      properties:
        card:
          title: Card Offer
          type: object
          properties:
            type:
              type: array
              items:
                $ref: '#/components/schemas/CardArray'
            bank_name:
              type: string
              description: Bank Name of Card.
              minLength: 3
              maxLength: 100
              example: hdfc bank
            scheme_name:
              type: array
              items:
                $ref: '#/components/schemas/SchemeArray'
          required:
          - type
          - bank_name
          - scheme_name
      required:
      - card
    ExtendedCartDetails:
      title: CartDetails
      description: The cart details that are necessary like shipping address, billing address and more.
      type: object
      properties:
        name:
          type: string
          description: Name of the cart.
        items:
          type: array
          items:
            $ref: '#/components/schemas/CartItem'
    OfferPaylater:
      tit

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cashfree/refs/heads/main/openapi/cashfree-orders-api-openapi.yml