openapi: 3.0.0
info:
  version: '2026-01-01'
  title: Cashfree Payment Gateway APIs
  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.
externalDocs:
  url: https://api.cashfree.com/pg
  description: This url will have the information of all the APIs.
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.
- name: Payments
  description: Collection of APIs to handle payments.
- name: Refunds
  description: Collection of APIs to handle refunds.
- name: Settlements
  description: Collection of APIs to handle settlements.
- name: Payment Links
  description: Collection of APIs to handle payment links.
- name: Token Vault
  description: Collection of APIs to use Cashfree's token Vault. This helps you save cards and tokenize them in a PCI complaint
    manner. We support creation of network tokens which can be used across acquiring banks.
- name: softPOS
  description: Collection of APIs to manage softPOS' agent and order.
- name: Offers
  description: Collection of APIs to handle offers.
- name: Eligibility
  description: Collection of APIs to check eligibile entities - payment methods, offer, affordibility.
- name: Settlement Reconciliation
  description: Collection of APIs to handle settlements.
- name: PG Reconciliation
  description: Collection of APIs to handle reconciliation.
- name: Customers
  description: Collection of APIs to handle customers.
- name: Easy-Split
  description: Collection of APIs to handle Easy-Split.
- name: Simulation
  description: Collection of APIs to handle simulation.
- name: Disputes
  description: Collection of APIs to handle disputes.
- name: Utilities
  description: Collection of APIs for utility requirement.
- name: Downtimes
  description: Collection of APIs for managing downtimes.
components:
  securitySchemes:
    XClientID:
      type: apiKey
      in: header
      name: x-client-id
      description: Client app ID. You can find your app id in the [Merchant Dashboard](https://merchant.cashfree.com/auth/login/pg/developers/api-keys?env=prod).
    XClientSecret:
      type: apiKey
      in: header
      name: x-client-secret
      description: Client secret key. You can find your secret key in the [Merchant Dashboard](https://merchant.cashfree.com/auth/login/pg/developers/api-keys?env=prod).
    XClientSignatureHeader:
      type: apiKey
      in: header
      name: x-client-signature
      description: Use this if you do not want to pass the secret key and instead want to use signature.
    XPartnerAPIKey:
      type: apiKey
      in: header
      name: x-partner-apikey
      description: If you are partner and you are making an api call on behalf of a merchant.
    XPartnerMerchantID:
      type: apiKey
      in: header
      name: x-partner-merchantid
      description: If you are partner use this to specify the merchant ID if you don't have the merchant client app ID.
  schemas:
    CardDowntimeCardTypeEnum:
      type: string
      description: Card type affected by a downtime incident.
      enum:
      - CREDIT_CARD
      - DEBIT_CARD
      - ALL_CARDS
    CardDowntimeCardNetworkEnum:
      type: string
      description: Card network affected by a downtime incident.
      enum:
      - VISA
      - MASTERCARD
      - RUPAY
      - MAESTRO
      - AMEX
      - ALL_NETWORKS
    PGCreatePAR200Response:
      title: PGCreatePAR200Response
      description: The Payment Account Reference (PAR) for a card.
      type: object
      properties:
        par:
          type: string
          description: PAR for plain card sent in request.
          example: V0010014623022637739353641436
    FetchActiveEcosystemDowntimes200Response:
      title: FetchActiveEcosystemDowntimes200Response
      description: Active downtime incidents, with their count.
      type: object
      properties:
        count:
          type: integer
          example: 4
        incidents:
          type: array
          items:
            $ref: '#/components/schemas/IncidentObject'
    VendorRecon200Response:
      title: VendorRecon200Response
      description: A paginated list of vendor reconciliation records, with amounts, fees, taxes and settlement details.
      type: object
      properties:
        cursor:
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              amount:
                type: number
                format: float64
              settlement_eligibility_time:
                type: string
              merchant_order_id:
                type: string
              tx_time:
                type: string
              settlement_id:
                type: integer
              settled:
                type: boolean
              fee:
                type: string
              tax:
                type: string
              entity_id:
                type: string
              type:
                type: string
              merchant_vendor_id:
                type: string
              added_on_time:
                type: string
              settlement_time:
                type: string
              settlement_utr:
                type: string
              currency:
                type: string
              debit:
                type: string
              credit:
                type: string
              refund_arn:
                type: string
        limit:
          type: integer
    VendorReconRequest:
      title: VendorReconRequest
      description: Request body to fetch vendor reconciliation details.
      type: object
      properties:
        pagination:
          type: object
          description: The merchant can set pagination limits based on their use case. The minimum limit is 10. Pagination
            will fetch a set of records, and the next set of records can be generated using the cursor provided in response
            to the first request for all reconciliation APIs.
          properties:
            limit:
              type: integer
              description: 'Set the minimum or maximum limit for the number of filtered data. Minimum value: 10, Maximum value:
                100.'
            cursor:
              type: string
              description: Specifies from where the next set of records should be fetched.
          required:
          - limit
        filters:
          type: object
          description: Specify the filters for the desired use case.
          properties:
            settlement_id:
              type: integer
              format: int32
              description: Specify the Settlement ID for which you want to fetch the order details. Relevant for "View Split
                Order Details Using Settlement ID".
            merchant_vendor_id:
              type: string
              description: Specify the Vendor ID for which you want to fetch the recon details. Relevant for "Vendor Recon
                Using Vendor ID & Time Interval".
            start_date:
              type: string
              description: Start date for fetching reconciliation details. Relevant for "Vendor Recon for a Time Period" and
                "Vendor Recon Using Vendor ID & Time Interval".
            end_date:
              type: string
              description: End date for fetching reconciliation details. Relevant for "Vendor Recon for a Time Period" and
                "Vendor Recon Using Vendor ID & Time Interval".
      required:
      - pagination
      - filters
      example:
        pagination:
          limit: 100
          cursor: null
        filters:
          merchant_vendor_id: test01
          start_date: '2024-09-01T00:00:00Z'
          end_date: '2024-09-26T23:59:59Z'
    UploadTerminalDocsEntity:
      title: UploadTerminalDocsEntity
      description: A document uploaded for a terminal, with its type, value and status.
      type: object
      example:
        cf_terminal_id: 1838
        doc_type: PHOTOGRAPH
        doc_value: docs/20260/1838/ymGCq-GIRphoto1
        status: ACTIVE
      properties:
        cf_terminal_id:
          type: integer
        doc_type:
          type: string
        doc_value:
          type: string
        status:
          type: string
    AllOffers:
      title: All Offers
      type: object
      description: All offers applicable.
    ApiError:
      title: ApiError
      description: Error at Cashfree's server.
      example:
        message: internal Server Error
        help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
          https://bit.ly/4eeZYO9'
        code: internal_error
        type: api_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        help:
          type: string
        type:
          type: string
          enum:
          - api_error
          description: api_error.
    ApiError404:
      title: ApiError404
      description: Error when resource requested is not found.
      example:
        message: something is not found
        help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
          https://bit.ly/4eeZYO9'
        code: something_not_found
        type: invalid_request_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        help:
          type: string
        type:
          type: string
          enum:
          - invalid_request_error
          description: invalid_request_error.
    ApiError409:
      title: ApiError409
      description: duplicate request.
      example:
        message: order with same id is already present
        help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
          https://bit.ly/4eeZYO9'
        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.
    ApiError502:
      title: ApiError502
      description: Error when there is error at partner bank.
      example:
        message: something is not found
        help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
          https://bit.ly/4eeZYO9'
        code: bank_processing_failure
        type: api_error
      type: object
      properties:
        message:
          type: string
        help:
          type: string
        code:
          type: string
          description: |
            `bank_processing_failure` will be returned here to denote failure at bank.
        type:
          type: string
          enum:
          - api_error
          description: api_error.
    App:
      title: App
      description: App payment method.
      example:
        channel: link
        provider: gpay
        phone: '8474090552'
      type: object
      properties:
        channel:
          type: string
          description: Specify the channel through which the payment must be processed.
        provider:
          type: string
          enum:
          - gpay
          - phonepe
          - ola
          - paytm
          - amazon
          - airtel
          - freecharge
          - mobikwik
          - jio
          description: Specify the provider through which the payment must be processed.
        phone:
          type: string
          description: Customer phone number associated with a wallet for payment.
      required:
      - channel
      - provider
      - phone
    AppPaymentMethod:
      title: AppPaymentMethod
      description: App payment method.
      type: object
      properties:
        app:
          $ref: '#/components/schemas/App'
      required:
      - app
    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.
    AuthorizationInPaymentsEntity:
      title: AuthorizationInPayments
      description: If preauth enabled for account you will get this body.
      example:
        action: CAPTURE
        status: PENDING
        captured_amount: 100
        start_time: '2022-02-09T18:04:34+05:30'
        end_time: '2022-02-19T18:04:34+05:30'
        approve_by: '2022-02-09T18:04:34+05:30'
        action_reference: '6595231908096894505959'
        action_time: '2022-08-03T16:09:51'
      type: object
      properties:
        action:
          type: string
          enum:
          - CAPTURE
          - VOID
          description: One of CAPTURE or VOID.
        status:
          type: string
          enum:
          - SUCCESS
          - PENDING
          description: One of SUCCESS or PENDING.
        captured_amount:
          type: number
          description: The captured amount for this authorization request.
        start_time:
          type: string
          description: Start time of this authorization hold (only for UPI).
        end_time:
          type: string
          description: End time of this authorization hold (only for UPI).
        approve_by:
          type: string
          description: Approve by time as passed in the authorization request (only for UPI).
        action_reference:
          type: string
          description: CAPTURE or VOID reference number based on action.
        action_time:
          type: string
          description: Time of action (CAPTURE or VOID).
    AuthorizeOrderRequest:
      title: AuthorizeOrderRequest
      description: Request body to capture or void a pre-authorised payment.
      example:
        action: CAPTURE
        amount: 100
      type: object
      properties:
        action:
          type: string
          description: Type of authorisation to run. Available options are `CAPTURE`, `VOID`.
        amount:
          type: number
          description: The amount you want to capture. This is required only when action is `CAPTURE`.
      required:
      - action
    BadRequestError:
      title: BadRequestError
      description: Invalid request received from client.
      example:
        message: bad URL, please check API documentation
        help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
          https://bit.ly/4eeZYO9'
        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
    Card:
      title: Card
      description: The card payment object can be used to make payments using a plain card, a card saved with Cashfree, an
        externally saved card, or an external Alt ID for guest checkout transactions. Refer to the examples in the Sample
        Request section for different payloads, and refer [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault#token-vault)
        for more details on tokenisation.
      required:
      - channel
      example:
        channel: link
        card_number: '4111111111111111'
        card_holder_name: Tushar Gupta
        card_expiry_mm: '06'
        card_expiry_yy: '22'
        card_cvv: '900'
        address_line_one: Address line 1
        address_line_two: Address line 2
        city: Minnehaha
        zip_code: '57109'
        country: United States
        country_code: US
        state: South Dakota
        state_code: SD
      type: object
      properties:
        channel:
          type: string
          enum:
          - link
          - post
          description: The channel for card payments can be "link" or "post". Use "post" to request [Native OTP](https://www.cashfree.com/docs/payments/features/native-otp)
            authentication, where the merchant must render the Native OTP UI to collect the OTP. Otherwise, use link for the
            redirection flow.
        card_number:
          type: string
          description: Customer’s card number for plain card transactions, or token number for external token transactions,
            or Alt ID number for external Alt ID transactions.
        card_holder_name:
          type: string
          description: Name on the customer’s card. Optional for external token or external Alt ID transactions.
        card_expiry_mm:
          type: string
          description: Card expiry month for plain card transactions, or token expiry month for external token transactions,
            or Alt ID expiry month for external Alt ID transactions.
        card_expiry_yy:
          type: string
          description: Card expiry year for plain card transactions, or token expiry year for external token transactions
            and Alt ID expiry year for external Alt ID transactions.
        card_cvv:
          type: string
          description: CVV mentioned on the card. Mandatory for plain card and external Alt ID transactions; optional for
            saved card transactions.
        instrument_id:
          type: string
          description: Instrument ID of the saved card, as received in response from [Fetch All Saved Card Instrument API](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/get-all).
            Required only when making payments using cards saved with Cashfree.
        cryptogram:
          type: string
          description: Cryptogram received from the card network. Required only for external token or external Alt ID transactions;
            provided by the merchant’s token requestor.
        token_requestor_id:
          type: string
          description: Token Requestor ID (TRID) issued by the respective card network. Required only for external token transactions;
            provided by the merchant’s token requestor.
        token_reference_id:
          type: string
          description: Token Reference ID, required only for external Alt ID transactions for Diners; provided by the merchant’s
            token requestor.
        token_type:
          enum:
          - NETWORK_GC_TOKEN
          type: string
          description: Token type enum. Mandatory only for external Alt ID transactions.
        card_display:
          type: string
          description: Last 4 digits of original card number, required only for external token or external Alt ID transactions,
            used for bookkeeping purposes.
        card_bank_name:
          type: string
          enum:
          - Kotak
          - ICICI
          - RBL
          - BOB
          - Standard Chartered
          description: One of ["Kotak", "ICICI", "RBL", "BOB", "Standard Chartered"]. Card bank name, required for EMI payments.
            This is the bank user has selected for EMI.
        address_line_one:
          type: string
          description: First line of the address.
        address_line_two:
          type: string
          description: Second line of the address.
        city:
          type: string
          description: City Name.
        zip_code:
          type: string
          description: Pin Code/Zip Code.
        country:
          type: string
          description: Country Name.
        country_code:
          type: string
          description: Country Code. Should be in ISO 2 format (ie. US for United States).
        state:
          type: string
          description: State Name.
        state_code:
          type: string
          description: State Code. Should be in ISO 2 format (ie. FL for Florida).
        emi_tenure:
          type: integer
          description: EMI tenure selected by the user.
        par:
          type: string
          description: Par received from network.
    CardArray:
      title: card array
      description: short code for credit card, debit card, prepaid card.
      type: string
      example: dc
    CardEMI:
      title: CardEMI
      description: Payment method for card EMI.
      required:
      - channel
      - card_number
      - card_expiry_mm
      - card_expiry_yy
      - card_cvv
      - card_bank_name
      - emi_tenure
      example:
        channel: link
        card_bank_name: hdfc
        card_number: '4111111111111111'
        card_holder_name: Tushar Gupta
        card_expiry_mm: '06'
        card_expiry_yy: '22'
        card_cvv: '900'
        emi_tenure: 3
      type: object
      properties:
        channel:
          type: string
          description: The channel for card payments will always be "link".
        card_number:
          type: string
          description: Customer card number.
        card_holder_name:
          type: string
          description: Customer name mentioned on the card.
        card_expiry_mm:
          type: string
          description: Card expiry month.
        card_expiry_yy:
          type: string
          description: Card expiry year.
        card_cvv:
          type: string
          description: CVV mentioned on the card.
        card_alias:
          type: string
          description: Card alias as returned by Cashfree Vault API.
        card_bank_name:
          type: string
          enum:
          - hdfc
          - kotak
          - icici
          - rbl
          - bob
          - standard chartered
          - axis
          - au
          - 'yes'
          - sbi
          - fed
          - hsbc
          - citi
          - amex
          description: Card bank name, required for EMI payments. This is the bank user has selected for EMI. One of ["hdfc,
            "kotak", "icici", "rbl", "bob", "standard chartered", "axis", "au", "yes", "sbi", "fed", "hsbc", "citi", "amex"].
        emi_tenure:
          type: integer
          description: EMI tenure selected by the user.
    CardEMIPaymentMethod:
      title: CardEMIPaymentMethod
      description: Complete card emi payment method.
      type: object
      properties:
        emi:
          $ref: '#/components/schemas/CardEMI'
      required:
      - emi
    CardPaymentMethod:
      title: CardPaymentMethod
      description: Payload for different payment methods is given below.
      type: object
      properties:
        card:
          $ref: '#/components/schemas/Card'
      required:
      - card.
    CardlessEMI:
      title: CardlessEMI
      description: Request body for cardless EMI payment method.
      example:
        channel: link
        provider: kotak
        phone: '7768913241'
        emi_tenure: 3
      type: object
      properties:
        channel:
          type: string
          description: The channel for cardless EMI is always `link`.
        provider:
          type: string
          enum:
          - flexmoney
          - zestmoney
          - hdfc
          - icici
          - cashe
          - idfc
          - kotak
          - snapmint
          - bharatx
          description: One of [`flexmoney`, `zestmoney`, `hdfc`, `icici`, `cashe`, `idfc`, `kotak`, `snapmint`, `bharatx`].
        phone:
          type: string
          description: Customers phone number for this payment instrument. If the customer is not eligible you will receive
            a 400 error with type as 'invalid_request_error' and code as 'invalid_request_error'.
        emi_tenure:
          type: integer
          description: EMI tenure for the selected provider. This is mandatory when provider is one of [`hdfc`, `icici`, `cashe`,
            `idfc`, `kotak`].
    CardlessEMIEntity:
      title: CardlessEMIEntity
      description: cardless EMI object.
      type: object
      properties:
        payment_method:
          type: string
          minLength: 3
          maxLength: 50
          example: idfc
        emi_plans:
          type: array
          items:
            $ref: '#/components/schemas/EMIPlansArray'
      example:
        payment_method: idfc
        emi_plans:
        - tenure: 1
          interest_rate: 10
          currency: INR
          emi: 400
          total_interest: 10
          total_amount: 40
    CardlessEMIPaymentMethod:
      title: CardlessEMIPaymentMethod
      description: cardless EMI payment method object.
      type: object
      properties:
        cardless_emi:
          $ref: '#/components/schemas/CardlessEMI'
      required:
      - cardless_emi
    CardlessEMIQueries:
      title: QueriesObject
      type: object
      description: cardless EMI query object.
      example:
        order_id: orderYB1X69LgzUQWiSxYDF
        amount: 20
        customer_details:
          customer_phone: '93838393833'
      properties:
        order_id:
          type: string
          description: OrderId of the order. Either of `order_id` or `amount` is mandatory.
          minLength: 3
          maxLength: 50
          format: string
          example: orderYB1X69LgzUQWiSxYDF
        amount:
          type: number
          description: Amount of the order. OrderId of the order. Either of `order_id` or `amount` is mandatory.
          minimum: 1
          example: 100
        customer_details:
          allOf:
          - $ref: '#/components/schemas/CustomerDetailsCardlessEMI'
          example:
            customer_details:
              customer_phone: '93838393833'
    CashbackDetails:
      title: CashbackDetails
      description: Cashback detail boject.
      example:
        cashback_type: percentage
        cashback_value: '20'
        max_cashback_amount: '150'
      type: object
      properties:
        cashback_type:
          type: string
          description: Type of discount.
          enum:
          - flat
          - percentage
          minLength: 1
          maxLength: 50
        cashback_value:
          type: number
          format: float64
          description: Value of Discount.
        max_cashback_amount:
          type: number
          format: float64
          description: Maximum Value of Cashback allowed.
      required:
      - cashback_type
      - cashback_value
      - max_cashback_amount
    CreateCustomerRequest:
      title: CreateCustomerRequest
      description: Request body to create a customer.
      type: object
      properties:
        customer_phone:
          type: string
          description: Customer Phone Number.
          minLength: 10
          maxLength: 10
          example: '9999999999'
        customer_email:
          type: string
          description: Customer Email.
          example: example@test.com
        customer_name:
          type: string
          description: Customer Name.
          example: YourCustomer
      required:
      - customer_phone
    SimulateRequest:
      title: SimulateRequest
      description: Request body to simulate a payment.
      type: object
      properties:
        entity:
          type: string
          enum:
          - PAYMENTS
          - SUBS_PAYMENTS
          - VBA_TRANSFER
          description: Entity type should be PAYMENTS, SUBS_PAYMENTS OR VBA_TRANSFER only.
        entity_id:
          type: string
          description: If the entity type is PAYMENTS, the entity_id will be the cf_payment_id. If the entity type is SUBS_PAYMENTS,
            the entity_id will be the payment_id. If the entity type is VBA_TRANSFER, the entity_id will be the vba_account_number.
        entity_simulation:
          $ref: '#/components/schemas/EntitySimulationRequest'
        vba_simulation:
          $ref: '#/components/schemas/VBASimulationRequest'
      required:
      - entity
      - entity_id.
    SimulateSettlementRequest:
      title: SimulateSettlementRequest
      description: Request body to simulate a settlement.
      type: object
      properties:
        merchantOrderIds:
          type: array
          items:
            type: string
          description: A list of orders for which you want to simulate settlement.
        txnTime:
          type: string
          format: ISO8601
          description: The start time (YYYY-MM-DD HH:mm:ss) from which transactions are picked for simulating settlement.
            You can pass a `txnTime` value for up to the last seven days.
        status:
          type: string
          enum:
          - SUCCESS
          - FAILED
          - PENDING
          description: The simulation status. Possible values are SUCCESS, FAILED or PENDING.
        errorReason:
          type: string
          enum:
          - '"Due to some technical issues, your amount will be settled in the next settlement cycle."'
          - '"Bank account details you have provided is not active, write to care@cashfree.com with the updated account details."'
          - '"Due to some technical issues at the bank, your amount will be settled in the next settlement cycle."'
          - '"Beneficiary name you have provided is incorrect, write to care@cashfree.com with the updated details."'
          - '"Unable to settle amount to this beneficiary account, write to care@cashfree.com with the updated account details."'
          - '"Bank account details you have provided are invalid, write to care@cashfree.com with the updated account details."'
          - '"The IFSC you have provided for the bank account is invalid, write to care@cashfree.com with the valid IFSC."'
          description: Specifies the reason for settlement failure. The default value is used if this is not provided. This
            is required only if the status is FAILED.
      required:
      - status.
    SimulateVendorSettlementRequest:
      title: SimulateVendorSettlementRequest
      description: Request body to simulate an Easy Split vendor settlement.
      type: object
      properties:
        merchant_vendor_id:
          type: string
          description: The vendor for which you want to simulate a settlement.
        merchant_order_ids:
          type: array
          items:
            type: string
          description: A list of orders for which you want to simulate a vendor settlement. Provide either `merchant_order_ids`
            or `txn_time`. If you omit both, the API returns a 404 error instead of simulating a settlement.
        txn_time:
          type: string
          description: 'The start time in IST, in the format `YYYY-MM-DD HH:mm:ss`, from which vendor entries are picked for
            simulating settlement. Required when `merchant_order_ids` is not provided, and ignored when it is. Unlike the
            `txnTime` field on the Simulate Settlement API, this field has no 7-day limit. Only transactions strictly after
            this time match, so pass a value earlier than the transaction time. A value equal to the transaction time does
            not match.'
        status:
          type: string
          enum:
          - INITIATED
          - SUCCESS
          - FAILED
          description: The simulation status. Possible values are INITIATED, SUCCESS or FAILED.
        error_reason:
          type: string
          description: Specifies the reason for the settlement failure. Any string value is accepted. The default value is
            used if this is not provided. This is required only if the status is FAILED.
      required:
      - merchant_vendor_id
      - status
    CreateLinkRequest:
      title: CreateLinkRequest
      description: Request body to create a payment link.
      example:
        customer_details:
          customer_email: john@cashfree.com
          customer_name: John Doe
          customer_phone: '9999999999'
        link_amount: 100
        link_auto_reminders: true
        link_currency: INR
        link_expiry_time: '2021-10-14T15:04:05+05:30'
        link_id: my_link_id
        link_meta:
          notify_url: https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net
          return_url: https://www.cashfree.com/devstudio/thankyou
          upi_intent: false
        link_minimum_partial_amount: 20
        link_notes:
          key_1: value_1
          key_2: value_2
        link_notify:
          send_email: true
          send_sms: false
          send_whatsapp: false
        link_partial_payments: true
        link_purpose: Payment for PlayStation 11
        order_splits:
        - vendor_id: Jane
          amount: 1.45
          tags:
            address: Hyderabad
        - vendor_id: Barbie
          amount: 3.45
          tags:
            address: Bengaluru, India
        enable_invoice: true
      type: object
      properties:
        link_id:
          type: string
          description: Unique Identifier (provided by merchant) for the Link. Alphanumeric and only - and _ allowed (50 character
            limit). Use this for other link-related APIs.
          maxLength: 50
        link_amount:
          type: number
          format: double
          description: Amount to be collected using this link. Provide upto two decimals for paise.
        link_currency:
          type: string
          description: Currency for the payment link. Default is INR. Submit [Support Form](https://merchant.cashfree.com/auth/login)
            to enable new currencies.
          minimum: 1
        link_purpose:
          type: string
          description: A brief description for which payment must be collected. This is shown to the customer.
          maxLength: 500
        customer_details:
          $ref: '#/components/schemas/LinkCustomerDetailsEntity'
        link_partial_payments:
          type: boolean
          description: If "true", customer can make partial payments for the link.
        link_minimum_partial_amount:
          type: number
          format: double
          description: Minimum amount in first installment that needs to be paid by the customer if partial payments are enabled.
            This should be less than the link_amount.
        link_expiry_time:
          type: string
          description: Time after which the link expires. Customers will not be able to make the payment beyond the time specified
            here. You can provide them in a valid ISO 8601 time format. Default is 30 days.
        link_notify:
          $ref: '#/components/schemas/LinkNotifyEntity'
        link_auto_reminders:
          type: boolean
          description: If "true", reminders will be sent to customers for collecting payments.
        link_notes:
          $ref: '#/components/schemas/LinkNotesEntity'
        link_meta:
          $ref: '#/components/schemas/LinkMetaResponseEntity'
        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
        enable_invoice:
          type: boolean
          description: Enable or disable invoice generation for this payment link.
          example: true
        subscription:
          $ref: '#/components/schemas/Subscription'
      required:
      - link_amount
      - link_currency
      - customer_details
      - link_purpose.
    CreateOfferRequest:
      title: CreateOfferRequest
      description: Request body to create an offer.
      type: object
      properties:
        offer_meta:
          allOf:
          - $ref: '#/components/schemas/OfferMeta'
          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'
        offer_tnc:
          allOf:
          - $ref: '#/components/schemas/OfferTnc'
          example:
            offer_tnc_type: text
            offer_tnc_value: TnC for the Offer.
        offer_details:
          allOf:
          - $ref: '#/components/schemas/OfferDetails'
          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'
        offer_validations:
          allOf:
          - $ref: '#/components/schemas/OfferValidations'
          example:
            min_amount: 10
            payment_method:
              wallet:
                issuer: paytm
            max_allowed: 2
      required:
      - offer_meta
      - offer_tnc
      - offer_details
      - offer_validations
    CreateOrderRequest:
      title: CreateOrderRequest
      description: Request body to create an order.
      type: object
      properties:
        order_id:
          type: string
          description: Order identifier present in your system. It must be unique for every Create Order API request. Only alphanumeric characters, underscores (_), and hyphens (-) are allowed.
          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. For orders in
            non-INR currency, refer to the [supported currencies and minimum order amount](https://www.cashfree.com/docs/payments/international-payments/ipg/currencies-supported#full-currency-list)
            per currency.
          format: double
          example: 10.15
          minimum: 1
        order_currency:
          type: string
          description: Currency for the order. INR if left empty. For support currency list, refer [here](https://www.cashfree.com/docs/payments/international-payments/ipg/currencies-supported#full-currency-list).
            Submit [Support Form](https://merchant.cashfree.com/auth/login) 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'
        bbps:
          type: object
          description: |
            BBPS-specific details required when creating an order for a BBPS bill payment. Pass this block only for BBPS payments processed through Cashfree's Customer Operating Unit (COU).

            You can provide bill details in one of two ways:

            - **`bills` array**: the standard format that supports single and multiple bill payments. Both prefunding and postfunding (shortfall) Agent Institutions can use this format. Postfunding Agent Institutions must use this format.
            - **Top-level fields** (`bill_fetch_ref_id`, `biller_id`, `agent_id`): supported only for prefunding Agent Institutions for a single bill payment. These fields are retained for backward compatibility. Do not pass these if you are using the `bills` array.

            You cannot send both top-level fields and the `bills` array in the same request. Doing so returns a validation error.

            **Pay Together:** To pay bills across multiple billers in a single order, pass multiple objects in the `bills` array. Each object represents one bill with its own `biller_id`, `agent_id`, and `amount_to_be_paid`. The `amount_to_be_paid` is the actual amount the customer is paying against that bill. This can be less than the bill amount for partial payments or more than the bill amount if the customer is paying overdue charges. For postfunding Agent Institutions, the sum of `amount_to_be_paid` across all bills, minus the sum of `shortfall_amount` across all bills, plus the sum of all `vendor_splits` amounts across all bills, must equal `order_amount`.

            For more details on prefunding and postfunding Agent Institutions, see [BBPS for Customers](/api-reference/other-apis/bbps-cou/overview).
          properties:
            bill_fetch_ref_id:
              type: string
              description: "Reference ID returned from the BBPS Bill Fetch Response API. Required when using top-level fields. Supported only for prefunding Agent Institutions. Do not pass this field if you are using the `bills` array."
              example: b73a14a591874eb3a22296b2dd861511952
            biller_id:
              type: string
              description: "Unique identifier of the biller on the BBPS network. Required when using top-level fields. Supported only for prefunding Agent Institutions. Do not pass this field if you are using the `bills` array."
              example: SWAR00027NAT2J
            agent_id:
              type: string
              description: "Unique ID assigned to the BBPS agent upon registration at NBBL. Required when using top-level fields. Supported only for prefunding Agent Institutions. Do not pass this field if you are using the `bills` array."
              example: CH01CH02INB516193128
            bills:
              type: array
              description: "Array of bill details for the payment. Each object represents one bill. Pass a single object for a standard bill payment or multiple objects for a Pay Together payment across multiple billers. Both prefunding and postfunding Agent Institutions can use this format. Postfunding Agent Institutions must use this format. Each bill must have a unique `biller_id`. Passing more than one bill for the same biller in a single request is not allowed and results in a validation error."
              items:
                type: object
                required:
                  - biller_id
                  - agent_id
                  - amount_to_be_paid
                properties:
                  bill_fetch_ref_id:
                    type: string
                    description: "Reference ID returned from the BBPS Bill Fetch Response API. Required for FETCH_AND_PAY and VALIDATE_AND_PAY flows. Not required for direct payment flows where no bill fetch is performed."
                    example: b73a14a591874eb3a22296b2dd861511952
                  biller_id:
                    type: string
                    description: Unique identifier of the biller on the BBPS network.
                    example: SWAR00027NAT2J
                  agent_id:
                    type: string
                    description: "Unique ID assigned to the BBPS agent upon registration at NBBL. This is provided to you after your onboarding and agent creation at NBBL. Contact your Cashfree account manager if you have not received this."
                    example: CH01CH02INB516193128
                  amount_to_be_paid:
                    type: number
                    description: "The actual amount the customer is paying against this bill in INR. This can differ from the billed amount: it can be less for a partial payment or more if the customer is paying overdue charges. For postfunding Pay Together orders, the sum of `amount_to_be_paid` across all bills, minus the sum of `shortfall_amount` across all bills, plus the sum of all `vendor_splits` amounts across all bills must equal `order_amount`."
                    example: 10.34
                  shortfall_amount:
                    type: number
                    description: "The portion of the bill amount not collected through the payment gateway, to be covered by the Agent Institution's shortfall wallet. For example, if a bill is for 1000 INR and the customer redeemed 200 coins on the Agent Institution's platform, only 800 INR is collected via the payment gateway. The remaining 200 INR is the shortfall amount. This value must match the `shortfall_amount` passed in the `payment_breakdown` field of the [Bill Payment Request API](/api-reference/other-apis/bbps-cou/bill-payment/request). Applicable only for postfunding (shortfall) Agent Institutions."
                    example: 200.00
                  vendor_splits:
                    type: array
                    description: "Per-bill split settlement details. Use this when the Agent Institution wants a portion of the customer's payment to be settled to the vendor account instead of the full amount going to the biller settlement flow. The sum of `vendor_splits` amounts across all bills in the `bills` array must equal the total `order_splits` amount passed at the top level of the Create Order request. Applicable only for postfunding (shortfall) Agent Institutions with split settlement enabled. For BBPS orders, the `order_splits` field supports only `amount`. If you pass `percentage` in `order_splits`, the request fails with a validation error."
                    items:
                      type: object
                      required:
                        - vendor_id
                        - amount
                      properties:
                        vendor_id:
                          type: string
                          description: Unique identifier of the vendor for split settlement.
                          example: VENDOR_001
                        amount:
                          type: number
                          description: Amount to be split to this vendor in INR.
                          example: 5.00
      required:
      - order_amount
      - order_currency
      - customer_details.
    UpdateOrderExtendedRequest:
      title: Update Order Extended
      description: Request body to update extended data for an order.
      type: object
      properties:
        shipment_details:
          type: array
          description: Shipment details, such as the tracking company, tracking number, and tracking URLs, associated with
            the shipping of an order. Either `shipment_details` or `order_delivery_status` is required.
          items:
            $ref: '#/components/schemas/ShipmentDetails'
        order_delivery_status:
          allOf:
          - $ref: '#/components/schemas/OrderDeliveryStatus'
          example:
            status: SHIPPED
            reason: shipped
      required:
      - shipment_details.
    CreateTerminalRequest:
      title: Create Terminal
      description: Request body to create a terminal.
      example:
        terminal_id: someTerminalID
        terminal_name: Jane Doe
        terminal_email: john@cashfree.com
        terminal_meta: null
        terminal_type: STOREFRONT
        terminal_phone_no: '9876543210'
        terminal_note: POS Vertical
        terminal_address: Bangalore
      type: object
      properties:
        terminal_id:
          type: string
          description: merchant’s internal terminal id.
          minLength: 3
          maxLength: 100
        terminal_phone_no:
          type: string
          description: phone number assigned to the terminal.
          minLength: 10
          maxLength: 10
        terminal_name:
          type: string
          description: terminal name to be assigned by merchants.
          minLength: 3
          maxLength: 100
        terminal_address:
          type: string
          description: address of the terminal. required for STOREFRONT.
          minLength: 1
          maxLength: 100
        terminal_email:
          type: string
          description: terminal email ID of the AGENT/STOREFRONT assigned by merchants.
          minLength: 1
          maxLength: 100
        terminal_note:
          type: string
          description: additional note for terminal.
          minLength: 1
          maxLength: 100
        terminal_type:
          type: string
          description: mention the terminal type. possible values - AGENT, STOREFRONT.
          minLength: 1
          maxLength: 100
        terminal_meta:
          type: object
          description: terminal metadata. required field for storefront.
          properties:
            terminal_operator:
              description: name of the STOREFRONT operator.
              type: string
        terminal_vpa_prefix:
          type: string
          description: Merchant's vpa prefix for the terminal.
          minLength: 1
          maxLength: 45
      required:
      - terminal_id
      - terminal_email
      - terminal_type
      - terminal_phone_no
      - terminal_name
    CreateTerminalTransactionRequest:
      title: Create Terminal Transaction
      description: Request body to create a terminal transaction.
      example:
        cf_order_id: '12345'
        cf_terminal_id: 54321
        payment_method: john@cashfree.com
        terminal_phone_no: '9898989898'
        add_invoice: false
      type: object
      properties:
        cf_order_id:
          description: cashfree order ID that was returned while creating an order.
          type: string
        cf_terminal_id:
          description: Cashfree terminal ID, this is a required parameter when you do not provide the terminal phone number.
          type: integer
          format: int64
        payment_method:
          type: string
          description: mention the payment method used for the transaction. possible values - QR_CODE, LINK.
          minLength: 3
          maxLength: 100
        terminal_phone_no:
          type: string
          description: agent mobile number assigned to the terminal. this is a required parameter when you do not provide
            the cf_terminal_id.
          minLength: 10
          maxLength: 10
        add_invoice:
          type: boolean
          description: make it true to have request be sent to create a Dynamic GST QR Code.
      required:
      - cf_order_id
      - payment_method.
    OnboardSoundboxVpaRequest:
      title: Onboard Soundbox Vpa
      description: Request body to onboard a soundbox VPA.
      example:
        vpa: cf.vpa-epos-gamma1018696837085fad68@sim
        cf_terminal_id: 3708
        device_serial_no: abtest123
        merchant_name: merchant-test
        language: English
      type: object
      properties:
        vpa:
          description: Terminal Vpa ,that need to onboard on soundbox.
          type: string
        cf_terminal_id:
          description: Cashfree terminal ID.
          type: integer
          format: int64
        device_serial_no:
          type: string
          description: Device Serial No of soundbox.
        merchant_name:
          type: string
          description: Merchant Name that need to onboard on soundbox.
        language:
          type: string
          description: language of soundbox,currently English, Hindi, Tamil.
      required:
      - vpa
      - cf_terminal_id
      - device_serial_no.
    UpdateSoundboxVpaRequest:
      title: Update Soundbox Vpa
      description: Request body to update a soundbox VPA.
      example:
        vpa: cf.vpa-epos-gamma1018696837085fad68@sim
        cf_terminal_id: 3708
        merchant_name: merchant-test
        language: English
      type: object
      properties:
        vpa:
          description: Terminal Vpa,for which we need to update details.
          type: string
        cf_terminal_id:
          description: Cashfree terminal ID.
          type: integer
          format: int64
        merchant_name:
          type: string
          description: Merchant Name that need to updated on soundbox.
        language:
          type: string
          description: language of soundbox,currently English, Hindi, Tamil.
      required:
      - vpa
      - cf_terminal_id
      - device_serial_no.
    DemapSoundboxVpaRequest:
      title: Demap Soundbox Vpa
      description: Request body to demap a soundbox VPA.
      example:
        cf_terminal_id: 3708
        device_serial_no: abtest123
      type: object
      properties:
        cf_terminal_id:
          description: Cashfree terminal ID.
          type: integer
          format: int64
        device_serial_no:
          type: string
          description: Device Serial No of soundbox that need to demap.
      required:
      - cf_terminal_id
      - device_serial_no.
    CryptogramEntity:
      title: CryptogramEntity
      description: A one-time cryptogram for a saved card, with the token number and its expiry month and year.
      example:
        instrument_id: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
        token_requestor_id: '22457512314'
        card_number: '4491365621601472'
        card_expiry_mm: '06'
        card_expiry_yy: '2025'
        cryptogram: AQBBBBBBZatIlaIAmWKSghwBBBB=
        card_display: '1234'
      properties:
        instrument_id:
          type: string
          description: Identifier for the card saved at Cashfree.
        token_requestor_id:
          type: string
          description: TRID issued by respective card networks.
        card_number:
          type: string
          description: Token number.
        card_expiry_mm:
          type: string
          description: Token expiry month.
        card_expiry_yy:
          type: string
          description: Token expiry year.
        cryptogram:
          type: string
          description: A one-time code dynamically generated by the respective card network, required to process saved card
            payments.
        card_display:
          type: string
          description: Displays the last four digits of the actual card number.
    CartDetails:
      title: CartDetails
      description: The cart details that are necessary like shipping address, billing address and more.
      type: object
      properties:
        customer_note:
          type: string
        shipping_charge:
          type: number
          format: double
        cart_name:
          type: string
          description: Name of the cart.
        customer_shipping_address:
          $ref: '#/components/schemas/CartAddress'
        customer_billing_address:
          $ref: '#/components/schemas/CartAddress'
        cart_items:
          type: array
          items:
            $ref: '#/components/schemas/CartItem'
    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
    CartItem:
      title: CartItem
      description: Each item in the cart.
      properties:
        item_id:
          type: string
          description: Unique identifier of the item.
        item_name:
          type: string
          description: Name of the item.
        item_description:
          type: string
          description: Description of the item.
        item_tags:
          type: array
          items:
            type: string
          description: Tags attached to that item.
        item_details_url:
          type: string
          description: Item details url.
        item_image_url:
          type: string
          description: Item image url.
        item_original_unit_price:
          type: number
          format: double
          description: Original price.
        item_discounted_unit_price:
          type: number
          format: double
          description: Discounted Price.
        item_currency:
          type: string
          description: Currency of the item.
        item_quantity:
          type: number
          format: int32
          description: Quantity if that item.
        item_variant_id:
          type: string
          description: Variant identifier of the item.
    CustomerDetails:
      title: CustomerDetails
      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. To accommodate international phone numbers, ensure the number is prefixed with
            a '+' to override the 10-digit limitation.
          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's bank account number. This field is required only if you want to perform a bank account check
            (TPV).
          minLength: 3
          maxLength: 20
        customer_bank_ifsc:
          type: string
          description: Customer's bank IFSC. Required if you want to do a bank account check (TPV).
        customer_bank_code:
          type: number
          description: Customer's bank code. Required for net banking payments, if you want to do a bank account check (TPV).
        customer_uid:
          type: string
          description: Customer's identifier at Cashfree. You will get this when you create/get customer.
      required:
      - customer_id
      - customer_phone
    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.
    ShipmentDetails:
      title: ShipmentDetails
      description: Shipment details associated with shipping of order like tracking company, tracking number,tracking urls
        etc.
      properties:
        tracking_company:
          type: string
          description: Tracking company name associated with order.
          example: DHL
        tracking_urls:
          type: array
          description: Tracking Urls associated with order.
          items:
            type: string
            example: https://dhl.com/track/123456
        tracking_numbers:
          type: array
          description: Tracking Numbers associated wih order.
          items:
            type: string
            example: TRACK654321
      required:
      - tracking_company
      - tracking_urls
      - tracking_numbers.
    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
    OrderDeliveryStatus:
      title: OrderDeliveryStatus
      description: Order delivery Status associated with order.
      properties:
        status:
          type: string
          enum:
          - AWAITING_PICKUP
          - CANCELLED
          - SELF_FULFILLED
          - PICKED_UP
          - SHIPPED
          - IN_TRANSIT
          - DELAY_COURIER_COMPANY_ISSUES
          - DELAY_INCORRECT_ADDRESS
          - DELAY_SELLER_ISSUES
          - REACHED_DESTINATION_HUB
          - OUT_FOR_DELIVERY
          - DELIVERED
          - POTENTIAL_RTO_DELIVERY_ATTEMPTED
          - RTO
          - LOST
          - DAMAGED
          - UNTRACKABLE_404
          - MANUAL_INTERVENTION_BROKEN_URL
          - ASSOCIATED_WITH_RETURN_PICKUP
          - UNSERVICEABLE
          description: Delivery status of order.
          example: CANCELLED
        reason:
          type: string
          description: Reason of provided order delivery status. This is optional field.
          example: cancelled due to wrong address
      required:
      - status.
    CustomerDetailsCardlessEMI:
      title: CustomerDetailsObject
      description: Details of the customer for whom eligibility is being checked.
      type: object
      example:
        customer_phone: '9898989898'
      properties:
        customer_phone:
          type: string
          description: Phone Number of the customer.
          example: '9898989898'
      required:
      - customer_phone
    CustomerEntity:
      title: CustomerEntity
      type: object
      description: A customer, with their name, email address and phone number.
      example:
        customer_uid: cfcustom_78364873648723
        customer_phone: '9999999999'
        customer_email: prasun@example.com
        customer_name: Prasun
      properties:
        customer_uid:
          type: string
          description: unique id generated by cashfree for your customer.
        customer_phone:
          type: string
          description: Customer Phone Number.
        customer_email:
          type: string
          description: Customer Email.
        customer_name:
          type: string
          description: Customer Name.
    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
    EMIPlansArray:
      title: EMIPlansArray
      description: Single EMI object.
      type: object
      properties:
        tenure:
          type: integer
          example: 3
        interest_rate:
          type: number
          example: 24
        currency:
          type: string
          minLength: 3
          maxLength: 50
          example: INR
        emi:
          type: integer
          example: 3468
        total_interest:
          type: integer
          example: 404
        total_amount:
          type: integer
          example: 10404
    EligibilityCardlessEMIEntity:
      title: EligibilityCardlessEMIEntity
      description: A cardless EMI option, with its eligibility and details.
      type: object
      properties:
        eligibility:
          type: boolean
          example: true
        entity_type:
          type: string
          example: cardlessemi
        entity_value:
          type: string
          example: idfc
        entity_details:
          allOf:
          - $ref: '#/components/schemas/CardlessEMIEntity'
          example:
            payment_method: idfc
            emi_plans:
              - tenure: 1
                interest_rate: 10
                currency: INR
                emi: 400
                total_interest: 10
                total_amount: 40
    EligibilityFetchCardlessEMIRequest:
      title: EligibilityFetchCardlessEMIRequest
      description: Request body to fetch eligible cardless EMI options for a customer and order.
      example:
        queries:
          order_id: orderYB1X69LgzUQWiSxYDF
          amount: 20
          customer_details:
            customer_phone: '93838393833'
      type: object
      properties:
        queries:
          $ref: '#/components/schemas/CardlessEMIQueries'
      required:
      - queries
    EligibilityFetchOffersRequest:
      title: EligibilityFetchOffersRequest
      type: object
      description: Request body to fetch eligible offers for a customer and order.
      example:
        queries:
          order_id: order_413462PK1RI1IwYB1X69LgzUQWiSxYDF
          amount: 100
      properties:
        queries:
          $ref: '#/components/schemas/OfferQueries'
        filters:
          $ref: '#/components/schemas/OfferFilters'
      required:
      - queries
    EligibilityFetchPaylaterRequest:
      title: EligibilityFetchPaylaterRequest
      description: Request body to fetch eligible Pay Later options for a customer and order.
      example:
        queries:
          order_id: orderYB1X69LgzUQWiSxYDF
          amount: 20
          customer_details:
            customer_phone: '93838393833'
      type: object
      properties:
        queries:
          $ref: '#/components/schemas/CardlessEMIQueries'
      required:
      - queries
    EligibilityFetchPaymentMethodsRequest:
      title: EligibilityFetchPaymentMethodsRequest
      description: Request body to fetch eligible payment methods for an account and order.
      example:
        queries:
          amount: 100
        filters:
          payment_methods: null
      type: object
      properties:
        queries:
          $ref: '#/components/schemas/PaymentMethodsQueries'
        filters:
          $ref: '#/components/schemas/PaymentMethodsFilters'
      required:
      - queries
    EligibilityOfferEntity:
      title: EligibilityOfferEntity
      description: An offer, with its eligibility and details.
      type: object
      properties:
        eligibility:
          type: boolean
          example: true
        entity_type:
          type: string
          example: offers
        entity_value:
          type: string
          example: d2b430fb-1afe-455a-af31-66d00377b29a
        entity_details:
          allOf:
          - $ref: '#/components/schemas/OfferEntity'
          example:
            offer_id: d2b430fb-1afe-455a-af31-66d00377b29a
            offer_status: active
            offer_meta:
              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'
            offer_tnc:
              offer_tnc_type: text
              offer_tnc_value: TnC for the Offer.
            offer_details:
              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'
            offer_validations:
              min_amount: 10
              payment_method:
                wallet:
                  issuer: paytm
              max_allowed: 2
            redemption_amount: 10
            platform: CASHFREE
    EligibilityPaylaterEntity:
      title: EligibilityPaylaterEntity
      description: A Pay Later option, with its eligibility and details.
      type: object
      properties:
        eligibility:
          type: boolean
          example: true
        entity_type:
          type: string
          example: paylater
        entity_value:
          type: string
          example: olapostpaid
        entity_details:
          allOf:
          - $ref: '#/components/schemas/PaylaterEntity'
          example:
            payment_method:
              type: string
              example: olapostpaid
    EligibilityPaymentMethodsEntity:
      title: EligibilityPaymentMethodsEntity
      description: A payment method, with its eligibility and details.
      type: object
      properties:
        eligibility:
          type: boolean
          example: true
        entity_type:
          type: string
          example: payment_methods
        entity_value:
          type: string
          example: netbanking
        entity_details:
          type: object
          properties:
            payment_method_details:
              type: array
              items:
                $ref: '#/components/schemas/PaymentModeDetails'
          example:
            payment_method_details:
            - nick: motak_kahindra_bank
              display: Motak Kahindra Bank
              eligibility: true
              code: 3032
            - nick: bank_of_india
              display: Bank Of India
              eligibility: true
              code: 3031
    InternationalPaymentEntity:
      title: InternationalPayment
      description: International payment details.
      type: object
      properties:
        international:
          type: boolean
    ErrorDetailsInPaymentsEntity:
      title: ErrorDetailsInPayments
      description: The error details are present only for failed payments.
      example:
        error_code: TRANSACTION_DECLINED
        error_description: issuer bank or payment service provider declined the transaction
        error_reason: auth_declined
        error_source: customer
        error_code_raw: ZM
        error_description_raw: INVALID / INCORRECT MPIN
        error_subcode_raw: ''
      type: object
      properties:
        error_code:
          type: string
        error_description:
          type: string
        error_reason:
          type: string
        error_source:
          type: string
        error_code_raw:
          type: string
        error_description_raw:
          type: string
        error_subcode_raw:
          type: string
    FetchReconRequest:
      type: object
      description: Request body to fetch payment gateway reconciliation details.
      example:
        pagination:
          limit: 10
          cursor: eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==
        filters:
          start_date: '2022-07-20T00:00:00Z'
          end_date: '2022-07-21T23:59:59Z'
      properties:
        pagination:
          type: object
          properties:
            limit:
              type: integer
              description: Number of settlements you want to fetch in the next iteration. Maximum limit is 1000, default value
                is 10.
            cursor:
              type: string
              description: Specifies from where the next set of settlement details should be fetched.
          description: "To fetch the next set of settlements, pass the cursor received in the response to the next API call.\
            \ \n To receive the data for the first time, pass the cursor as null. \n Limit would be number of settlements\
            \ that you want to receive."
          required:
          - limit
        filters:
          type: object
          properties:
            start_date:
              type: string
              description: Specify the start date from when you want the settlement reconciliation details.
            end_date:
              type: string
              description: Specify the end date till when you want the settlement reconciliation details.
          required:
          - start_date
          - end_date
      required:
      - pagination
      - filters.
    FetchSettlementsRequest:
      type: object
      description: Request body to fetch settlements.
      example:
        pagination:
          limit: 10
          cursor: eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==
        filters:
          cf_settlement_ids:
          - '4234233'
          settlement_utrs:
          - utr1
          - utr2
          settlement_status:
          - SUCCESS
          - PENDING_WITH_BANK
          start_date: '2022-07-20T00:00:00Z'
          end_date: '2022-07-21T23:59:59Z'
      properties:
        pagination:
          type: object
          properties:
            limit:
              type: integer
              description: The number of settlements you want to fetch. Maximum limit is 1000, default value is 10.
            cursor:
              type: string
              description: Specifies from where the next set of settlement details should be fetched.
          description: "To fetch the next set of settlements, pass the cursor received in the response to the next API call.\
            \ \n To receive the data for the first time, pass the cursor as null. \n Limit would be number of settlements\
            \ that you want to receive."
          required:
          - limit
        filters:
          type: object
          properties:
            cf_settlement_ids:
              type: array
              items:
                type: string
              description: List of settlement IDs for which you want the settlement reconciliation details.
            settlement_utrs:
              type: array
              items:
                type: string
              description: List of settlement UTRs for which you want the settlement reconciliation details.
            settlement_status:
              type: array
              items:
                type: string
                enum:
                - SUCCESS
                - PENDING
                - PENDING_WITH_CASHFREE
                - PENDING_WITH_BANK
                - FAILED
              description: List of settlement statuses to filter by. Possible values are SUCCESS, PENDING, PENDING_WITH_CASHFREE, PENDING_WITH_BANK, FAILED.
            start_date:
              type: string
              description: Specify the start date from when you want the settlement reconciliation details.
            end_date:
              type: string
              description: Specify the end date till when you want the settlement reconciliation details.
          description: Specify either the Settlement ID, Settlement UTR, settlement status, or start date and end date to fetch the settlement
            details.
      required:
      - pagination
      - filters
    FetchTerminalQRCodesEntity:
      title: FetchTerminalQRCodesEntity
      description: A static QR code for a terminal, with its bank, encoded QR code, QR code URL and status.
      example:
        bank: SIM
        qrCode: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///
        qrCodeUrl: upi://pay?cu=INR&pa=cf.vpa-epos-gamma202601415xwtvf9
        status: ACTIVE
      type: object
      properties:
        bank:
          type: string
          description: Name of the bank that is linked to the Static QR.
        qrCode:
          type: string
          description: Base-64 Encoded QR Code URL.
        qrCodeUrl:
          type: string
          description: URL of the qr Code.
        status:
          type: string
          description: Status of the static QR.
    IdempotencyError:
      title: IdempotencyError
      description: Error when idempotency fails. Different request body with the same idempotent key.
      example:
        message: something is not found
        help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
          https://bit.ly/4eeZYO9'
        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.
    InstrumentEntityForAllSavedCard:
      title: InstrumentEntityForAllSavedCard
      description: A saved card for a customer, with its instrument ID, display details, status and card metadata.
      example:
        customer_id: akshita2106
        afa_reference: '3128531647'
        instrument_id: 54de41ad34ee-36a0-409e-aec9-bdc9d232add0
        instrument_type: card
        instrument_uid: 78c2a3b90265436eceb4c09d8b09c85432ee1bb57512cc24ba998a12cd0180c2
        instrument_display: XXXXXXXXXXXX1001
        instrument_status: INACTIVE
        created_at: '2024-10-10T10:16:18.000+00:00'
        instrument_meta:
          card_network: mastercard
          card_bank_name: ICICI BANK
          card_country: IN
          card_type: credit_card
          card_sub_type: P
          card_token_details:
            par: 5001AJE6CSF757UMKRTKK61PRVYGC
            expiry_month: '11'
            expiry_year: '2027'
      properties:
        customer_id:
          type: string
          description: Customer ID that merchant sends during [Create Order API](https://www.cashfree.com/docs/api-reference/payments/latest/orders/create),
            against which the cards are saved for the customer.
        afa_reference:
          type: string
          description: cf_payment_id of the successful transaction done while saving instrument.
        instrument_id:
          type: string
          description: Identifier for the card saved at Cashfree. It is used for [cryptogram generation](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/generate-cryptogram)
            and in [order pay](https://www.cashfree.com/docs/api-reference/payments/latest/payments/pay) request for saved
            cards..
        instrument_type:
          type: string
          description: Type of the saved instrument. Available option is `card`.
        instrument_uid:
          type: string
          description: Unique identifier for the saved card, used to identify a specific card.
        instrument_display:
          type: string
          description: Last 4 digits of actual card number, to be displayed to the customer for card identification.
        instrument_status:
          type: string
          description: Status of the saved instrument. Available options are `ACTIVE`, `INACTIVE`.
        created_at:
          type: string
          description: Timestamp at which instrument was saved.
        instrument_meta:
          $ref: '#/components/schemas/SavedInstrumentMeta'
    InstrumentEntity:
      title: InstrumentEntity
      description: A saved card for a customer, with its instrument ID, display details, status and card metadata.
      example:
        customer_id: akshita2106
        afa_reference: '3128531647'
        instrument_id: 54de41ad34ee-36a0-409e-aec9-bdc9d232add0
        instrument_type: card
        instrument_uid: 78c2a3b90265436eceb4c09d8b09c85432ee1bb57512cc24ba998a12cd0180c2
        instrument_display: XXXXXXXXXXXX1001
        instrument_status: INACTIVE
        created_at: '2024-10-10T10:16:18.000+00:00'
        instrument_meta:
          card_network: mastercard
          card_bank_name: ICICI BANK
          card_country: IN
          card_type: credit_card
          card_sub_type: P
          card_token_details:
            par: 5001AJE6CSF757UMKRTKK61PRVYGC
            expiry_month: '11'
            expiry_year: '2027'
      properties:
        customer_id:
          type: string
          description: Customer ID that merchant sends during [Create Order API](https://www.cashfree.com/docs/api-reference/payments/latest/orders/create),
            against which the cards are saved for the customer.
        afa_reference:
          type: string
          description: cf_payment_id of the successful transaction done while saving instrument.
        instrument_id:
          type: string
          description: Identifier for the card saved at Cashfree.
        instrument_type:
          type: string
          description: Type of the saved instrument. Available option is `card`.
        instrument_uid:
          type: string
          description: Unique identifier for the saved card, used to identify a specific card.
        instrument_display:
          type: string
          description: Last four digits of actual card number.
        instrument_status:
          type: string
          description: Status of the saved instrument. Available options are `ACTIVE`, `INACTIVE`.
        created_at:
          type: string
          description: Timestamp at which instrument was saved.
        instrument_meta:
          $ref: '#/components/schemas/SavedInstrumentMeta'
    DeletedInstrumentEntity:
      title: InstrumentEntity
      description: A deleted saved card, with its instrument ID, display details and status.
      example:
        customer_id: akshita2106
        afa_reference: '3128531647'
        instrument_id: 54de41ad34ee-36a0-409e-aec9-bdc9d232add0
        instrument_type: card
        instrument_uid: 78c2a3b90265436eceb4c09d8b09c85432ee1bb57512cc24ba998a12cd0180c2
        instrument_display: XXXXXXXXXXXX1001
        instrument_status: INACTIVE
        created_at: '2024-10-10T10:16:18.000+00:00'
        instrument_meta:
          card_network: mastercard
          card_bank_name: ICICI BANK
          card_country: IN
          card_type: credit_card
          card_sub_type: P
          card_token_details:
            par: 5001AJE6CSF757UMKRTKK61PRVYGC
            expiry_month: '11'
            expiry_year: '2027'
      properties:
        customer_id:
          type: string
          description: Customer ID against which the card is saved.
        afa_reference:
          type: string
          description: cf_payment_id of the successful transaction done while saving instrument.
        instrument_id:
          type: string
          description: Identifier for the card saved at Cashfree, which was requested to be deleted.
        instrument_type:
          type: string
          enum:
          - card
          description: Type of the saved instrument.
        instrument_uid:
          type: string
          description: Unique identifier for the saved card, used to identify a specific card.
        instrument_display:
          type: string
          description: Last four digits of actual card number.
        instrument_status:
          type: string
          enum:
          - INACTIVE
          description: Status of the saved instrument. This would be `INACTIVE` when the instrument is successfully deleted.
        created_at:
          type: string
          description: Timestamp at which instrument was saved.
        instrument_meta:
          $ref: '#/components/schemas/SavedInstrumentMeta'
    InstrumentWebhook:
      title: InstrumentWebhook
      description: Instrument webhook object.
      type: object
      properties:
        data:
          type: object
          properties:
            data:
              type: object
              title: InstrumentWebhookDataEntity
              description: data entity in webhook.
              properties:
                instrument:
                  allOf:
                  - $ref: '#/components/schemas/InstrumentEntity'
            event_time:
              type: string
              example: '2021-10-07T19:42:44+05:30'
            type:
              type: string
              example: INSTRUMENT_ACTIVE_WEBHOOK
    PaymentWebhook:
      title: PaymentWebhook
      description: payment webhook object.
      type: object
      properties:
        data:
          type: object
          title: PaymentWebhookDataEntity
          description: data entity in webhook.
          properties:
            order:
              type: object
              title: PaymentWebhookOrderEntity
              description: order entity in webhook.
              properties:
                order_id:
                  type: string
                order_amount:
                  type: number
                  format: double
                order_currency:
                  type: string
                order_tags:
                  type: object
                  maxProperties: 15
                  description: Custom Tags in the form of {"key":"value"} which can be passed for an order. A maximum of 10
                    tags can be added.
                  additionalProperties:
                    type: string
                    minLength: 1
                    maxLength: 255
            payment:
              allOf:
              - $ref: '#/components/schemas/PaymentEntity'
            customer_details:
              type: object
              description: customer details object in webhook.
              title: PaymentWebhookCustomerEntity
              properties:
                customer_name:
                  type: string
                  example: Yogesh
                customer_id:
                  type: string
                  example: '12121212'
                customer_email:
                  type: string
                  example: yogesh.miglani@gmail.com
                customer_phone:
                  type: string
                  example: '9666699999'
            error_details:
              type: object
              description: error details present in the webhook.
              title: PaymentWebhookErrorEntity
              properties:
                error_code:
                  type: string
                error_description:
                  type: string
                error_reason:
                  type: string
                error_source:
                  type: string
                error_code_raw:
                  type: string
                error_description_raw:
                  type: string
            payment_gateway_details:
              type: object
              description: payment gateway details present in the webhook response.
              title: PaymentWebhookGatewayDetailsEntity
              properties:
                gateway_name:
                  type: string
                gateway_order_id:
                  type: string
                gateway_order_reference_id:
                  type: string
                gateway_payment_id:
                  type: string
                gateway_status_code:
                  type: string
                gateway_settlement:
                  type: string
                gateway_reference_name:
                  type: string
            payment_offers:
              type: array
              items:
                $ref: '#/components/schemas/OfferEntity'
        event_time:
          type: string
          example: '2021-10-07T19:42:44+05:30'
        type:
          type: string
          example: PAYMENT_SUCCESS_WEBHOOK
    RefundWebhook:
      title: RefundWebhook
      description: refund webhook object.
      type: object
      properties:
        data:
          type: object
          title: RefundWebhookDataEntity
          description: data entity in webhook.
          properties:
            refund:
              allOf:
              - $ref: '#/components/schemas/RefundEntity'
        event_time:
          type: string
          example: '2021-10-07T19:42:44+05:30'
        type:
          type: string
          example: REFUND_SUCCESS_WEBHOOK
    EntitySimulationRequest:
      title: entity_simulation
      description: Entity simulation contains payment_status and payment_error_code.
      type: object
      example:
        payment_status: FAILED
        payment_error_code: ISSUER_NOT_AVAILABLE
      properties:
        payment_status:
          type: string
          enum:
          - SUCCESS
          - FAILED
          - PENDING
          - USER_DROPPED
          description: Payment status.
        payment_error_code:
          type: string
          description: Payment error code.
      required:
      - payment_status
    EntitySimulationResponse:
      title: entity_simulation
      description: Entity simulation contains payment_status and payment_error_code.
      type: object
      example:
        payment_status: FAILED
        payment_error_code: ISSUER_NOT_AVAILABLE
      properties:
        payment_status:
          type: string
          description: Payment status.
        payment_error_code:
          type: string
          description: Payment error code.
      required:
      - payment_status
    VBASimulationRequest:
      title: vba_simulation
      description: VBA simulation contains VBA and remitter information for simulation.
      type: object
      example:
        vba_ifsc: YESB0CMSNOC
        utr: utr
        amount: 10
        remitter_account: 808081pxqp242614HW
        remitter_ifsc: IFSC
        remitter_name: Test
        phone: '1234567891'
      properties:
        vba_ifsc:
          type: string
          description: IFSC of the issues VBA.
        utr:
          type: string
          description: UTR of the transaction.
        amount:
          type: number
          description: Amount of the transaction.
        remitter_account:
          type: string
          description: Account from which transaction was done.
        remitter_ifsc:
          type: string
          description: IFSC of the remitter.
        remitter_name:
          type: string
          description: Name of the remitter.
        phone:
          type: string
          description: Phone number of the remitter.
      required:
      - vba_ifsc
      - utr
      - amount
      - remitter_account
      - remitter_ifsc
      - remitter_name
      - phone
    LinkCustomerDetailsEntity:
      title: customer_details
      description: Payment link customer entity.
      type: object
      example:
        customer_name: John Doe
        customer_phone: '9999999999'
        customer_email: john@cashfree.com
        customer_bank_account_number: 11111111111
        customer_bank_ifsc: SBIN0001882
        customer_bank_code: 7001
        customer_bank_acoount_holder_name: Ajeet kumar
      properties:
        customer_phone:
          type: string
          description: Customer phone number.
        customer_email:
          type: string
          description: Customer email address.
        customer_name:
          type: string
          description: Customer name.
        customer_bank_account_number:
          type: string
          description: Customer Bank Account Number.
        customer_bank_ifsc:
          type: string
          description: Customer Bank Ifsc.
        customer_bank_code:
          type: integer
          enum:
          - 3003
          - 3005
          - 3006
          - 3010
          - 3012
          - 3016
          - 3019
          - 3020
          - 3021
          - 3022
          - 3023
          - 3024
          - 3026
          - 3027
          - 3028
          - 3029
          - 3030
          - 3031
          - 3032
          - 3033
          - 3038
          - 3039
          - 3040
          - 3042
          - 3044
          - 3054
          - 3055
          - 3058
          - 3086
          - 3087
          - 3088
          - 3089
          - 3090
          - 3091
          - 3092
          - 3098
          - 3115
          - 3117
          - 7001
          description: Customer Bank Code.
        customer_bank_acoount_holder_name:
          type: string
          description: Customer Bank Account Holder Name.
      required:
      - customer_phone
    LinkEntity:
      title: LinkEntity
      description: A payment link, with its amount, status, URL, expiry time and customer details.
      type: object
      example:
        cf_link_id: '1996567'
        link_id: my_link_id
        link_status: ACTIVE
        link_currency: INR
        link_amount: 100
        link_amount_paid: 0
        link_partial_payments: true
        link_minimum_partial_amount: 20
        link_purpose: Payment for PlayStation 11
        link_created_at: '2021-09-30T17:05:01+05:30'
        customer_details:
          customer_name: John Doe
          customer_phone: '9999999999'
          customer_email: john@example.com
        link_meta:
          notify_url: https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net
          upi_intent: false
          return_url: https://www.cashfree.com/devstudio/thankyou
        link_url: https://payments-test.cashfree.com/links/o1tf1nvcvjhg
        link_expiry_time: '2021-10-14T15:04:05+05:30'
        link_notes:
          key_1: value_1
          key_2: value_2
        link_auto_reminders: true
        link_qrcode: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAABlBMVEX///8AAABVwtN+AAAC9ElEQVR4nOyaPY7jMAyFn6HCpY7go/hmkXIzH0VHUOlC8Fvw0c4kM4PFFltJJjDAQPnSEPx5JIPbbrvttv9rC82mPW7gvnDasT5ZkSZyS/ZR6xLMANaJFQLJuj5J5mkHHgaMDpJlNfeROzAZFE4/PgKZOwZfoWTggchsDrvBd7DNZeW/+LEHUDmzY7Wn1aNHORO335JrNPBVcVPYl+2Y6/pssSS9/F6aOwDdLq9smLkBsUCl9aeNB6riymMzNwujI9QlW11hw/Lmx47AJVNBY16Zi71Ydy1JFTXU4UEGlvWYSfsGgbghXOn2HkGdgcCymdJS9GCu66HXmVtqsQwOvoSo/tnswbovLZ6mFpnHBpccTLHaPGMq5QBWKznZOpN9PbUeQcCdUV1mmFfkHmqcI4nBweZt2Ifc031SbEifrbgnMClndg8aWknJ1l5cpLlgHRp0OaZ5xiY4qRQPI5Our3mmO7Cs3L37mhp1SaYBNtRP9wwJnsll84zWYTmwJO5qOCV1CdpoT9pQkkykWWuResdccY22A4NIZIGmF2i4qesRXLBbcpWvNtwTuDCc7SWf0tTay6LVZ3ovpKOClkYHbHrZsU575LOddfiBD2XfFdhMhJozgo31NsXBFem35BoSlPjY9LkJdswkWywJEmmfWdgPeMqt64akQtr0Gj8XgKOCvubxjehmfszXaD992wH0AyL5BGZ9xqIHkU+eihRX9xkX9C2fSzKVFJtXouSITitvS8AhwSzBLm2mM6RmGoDaJfMtHvsC1YavzbD344pXxR0eNG1m8jx5yVHFNT9GBU/uEnSzDMnNSq8KLaATG0L9OiyOCfoFUn5sM7fj2gy/ztLoEtS12f6yqshc8Qj13AKFd202KHheIF2bQWseFkxKrrp8/6VLV+Au8cFNqYJYkrXZZ4s/f98zJEiPFd3gU9PPdij1/rEO6whUzsxnmug24gez6DkzOPiquAg+ztEX57rK1+WX0twBeNttt932d/sTAAD//zUdVfZhwUvzAAAAAElFTkSuQmCC
        link_notify:
          send_sms: false
          send_email: true
          send_whatsapp: false
        order_splits:
        - vendor_id: Jane
          percentage: 10
          tags:
            address: Hyderabad
        - vendor_id: Barbie
          percentage: 50
          tags:
            address: Bengaluru, India
      properties:
        cf_link_id:
          type: string
        link_id:
          type: string
        link_status:
          type: string
        link_currency:
          type: string
        link_amount:
          type: number
        link_amount_paid:
          type: number
        link_partial_payments:
          type: boolean
        link_minimum_partial_amount:
          type: number
        link_purpose:
          type: string
        link_created_at:
          type: string
        customer_details:
          $ref: '#/components/schemas/LinkCustomerDetailsEntity'
        link_meta:
          $ref: '#/components/schemas/LinkMetaResponseEntity'
        link_url:
          type: string
        link_expiry_time:
          type: string
        link_notes:
          $ref: '#/components/schemas/LinkNotesEntity'
        link_auto_reminders:
          type: boolean
        link_notify:
          $ref: '#/components/schemas/LinkNotifyEntity'
        link_qrcode:
          type: string
          description: Base64 encoded string for payment link. You can scan with camera to open a link in the browser to complete
            the payment.
        order_splits:
          type: array
          items:
            $ref: '#/components/schemas/VendorSplit'
        subscription:
          $ref: '#/components/schemas/LinkSubscriptionEntity'
    LinkMetaResponseEntity:
      title: link_meta
      description: Payment link meta information object.
      type: object
      example:
        notify_url: https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net
        upi_intent: 'false'
        return_url: https://www.cashfree.com/devstudio/thankyou
      properties:
        notify_url:
          type: string
          description: Notification URL for server-server communication. It should be an https URL.
        upi_intent:
          type: string
          description: If "true", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere.
        return_url:
          type: string
          description: 'The URL to which user will be redirected to after the payment is done on the link. Maximum length:
            250.'
        payment_methods:
          type: string
          description: Allowed payment modes for this link. Pass comma-separated values among following options - "cc", "dc",
            "ccc", "ppc", "nb", "upi", "paypal", "app", "paylater", "cardlessemi", "dcemi", "ccemi", "banktransfer", "applepay".
            Leave it blank to show all available payment methods.
    OfferDetailsResponse:
      description: Offer details response and type.
      example:
        cashback_details:
          cashback_type: percentage
          cashback_value: '20'
          max_cashback_amount: '150'
        discount_details:
          discount_type: flat
          discount_value: '10'
          max_discount_amount: '10'
        offer_type: DISCOUNT_AND_CASHBACK
      properties:
        cashback_details:
          $ref: '#/components/schemas/CashbackDetails'
        discount_details:
          $ref: '#/components/schemas/DiscountDetails'
        offer_type:
          description: Offer Type for the Offer.
          enum:
          - DISCOUNT
          - CASHBACK
          - DISCOUNT_AND_CASHBACK
          - NO_COST_EMI
          example: DISCOUNT_AND_CASHBACK
          maxLength: 50
          minLength: 3
          type: string
      title: OfferDetailsResponse
      type: object
    LinkNotesEntity:
      title: link_notes
      type: object
      description: Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs.
      example:
        key_1: value_1
        key_2: value_2
      additionalProperties:
        type: string
    LinkNotifyEntity:
      title: link_notify
      type: object
      description: Payment link Notify Object for SMS and Email.
      example:
        send_sms: false
        send_email: true
        send_whatsapp: false
      properties:
        send_sms:
          type: boolean
          description: If "true", Cashfree will send sms on customer_phone.
        send_email:
          type: boolean
          description: If "true", Cashfree will send email on customer_email.
    MethodsType:
      title: MethodsType
      type: string
      description: Methods Type Object.
    NetBankingPaymentMethod:
      title: NetBankingPaymentMethod
      description: Payment method for netbanking object.
      type: object
      properties:
        netbanking:
          $ref: '#/components/schemas/Netbanking'
      required:
      - netbanking
    Netbanking:
      title: Netbanking
      description: Netbanking payment method request body.
      example:
        channel: link
        netbanking_bank_code: 3022
      type: object
      properties:
        channel:
          type: string
          description: The channel for netbanking will always be `link`.
        netbanking_bank_code:
          type: integer
          format: int32
          description: Bank code.
          pattern: ^\d{4}$
        netbanking_bank_name:
          type: string
          format: BANKR
          description: String code for bank.
          pattern: ^[A-Z]{5}$
      required:
      - channel
    OfferAll:
      title: All Offers
      description: returns all offers.
      example:
        all: {}
      type: object
      properties:
        all:
          $ref: '#/components/schemas/AllOffers'
      required:
      - all
    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
    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
    OfferEMI:
      title: EMI Offer
      description: EMI offer object.
      type: object
      example:
        emi:
          type: cardless_emi
          issuer: hdfc bank
          tenures:
          - 3
          - 6
      properties:
        emi:
          title: EMI Offer
          type: object
          properties:
            type:
              type: string
              description: Type of emi offer. Possible values are `credit_card_emi`, `debit_card_emi`, `cardless_emi`.
              minLength: 3
              maxLength: 100
              example: cardless_emi
            issuer:
              type: string
              description: Bank Name.
              minLength: 3
              maxLength: 100
              example: hdfc bank
            tenures:
              type: array
              items:
                title: Tenure Array
                type: integer
                example: 3
          required:
          - type
          - issuer
          - tenures
      required:
      - emi.
    OfferEntity:
      title: OfferEntity
      type: object
      description: An offer, with its status, details, terms and conditions, and validation rules.
      properties:
        offer_id:
          type: string
          example: d2b430fb-1afe-455a-af31-66d00377b29a
        offer_status:
          type: string
          example: active
        order_amount:
          type: number
          format: float64
        payable_amount:
          type: number
          format: float64
        offer_meta:
          allOf:
          - $ref: '#/components/schemas/OfferMetaResponse'
          example:
            offer_code: CFTESTOFFER
            offer_description: some offer description
            offer_end_time: '2023-03-29T08:09:51Z'
            offer_start_time: '2023-03-21T08:09:51Z'
            offer_title: some title
        offer_tnc:
          allOf:
          - $ref: '#/components/schemas/OfferTncResponse'
          example:
            offer_tnc_type: text
            offer_tnc_value: TnC for the Offer.
        offer_details:
          allOf:
          - $ref: '#/components/schemas/OfferDetailsResponse'
          example:
            cashback_details:
              cashback_type: percentage
              cashback_value: '20'
              max_cashback_amount: '150'
            discount_details:
              discount_type: flat
              discount_value: '10'
              max_discount_amount: '10'
            offer_type: DISCOUNT_AND_CASHBACK
        offer_validations:
          allOf:
          - $ref: '#/components/schemas/OfferValidationsResponse'
          example:
            max_allowed: 2
            min_amount: 10
            payment_method:
              wallet:
                issuer: paytm
        redemption_amount:
          type: number
          format: float64
        platform:
          type: string
          example: cashfree
    OfferValidationsResponse:
      description: Offer validation object.
      example:
        max_allowed: 2
        min_amount: 10
        payment_method:
          wallet:
            issuer: paytm
      properties:
        max_allowed:
          description: Maximum Amount for Offer to be Applicable.
          example: 1
          minimum: 1
          type: number
        min_amount:
          description: Minimum Amount for Offer to be Applicable.
          example: 1
          minimum: 1
          type: number
        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'
      title: OfferValidationsResponse
      type: object
    OfferTncResponse:
      description: Offer terms and condition object.
      example:
        offer_tnc_type: text
        offer_tnc_value: TnC for the Offer.
      properties:
        offer_tnc_type:
          description: TnC Type for the Offer. It can be either `text` or `link`.
          enum:
          - text
          - link
          example: text
          maxLength: 50
          minLength: 3
          type: string
        offer_tnc_value:
          description: TnC for the Offer.
          example: Lorem ipsum dolor sit amet, consectetur adipiscing elit
          maxLength: 100
          minLength: 3
          type: string
      title: OfferTncResponse
      type: object
    OfferMetaResponse:
      description: Offer meta response details object.
      example:
        offer_code: CFTESTOFFER
        offer_description: some offer description
        offer_end_time: '2023-03-29T08:09:51Z'
        offer_start_time: '2023-03-21T08:09:51Z'
        offer_title: some title
      properties:
        offer_code:
          description: Unique identifier for the Offer.
          example: CFTESTOFFER
          maxLength: 45
          minLength: 1
          type: string
        offer_description:
          description: Description for the Offer.
          example: Lorem ipsum dolor sit amet, consectetur adipiscing elit
          maxLength: 100
          minLength: 3
          type: string
        offer_end_time:
          description: Expiry Time for the Offer.
          example: '2023-03-29T08:09:51Z'
          type: string
        offer_start_time:
          description: Start Time for the Offer.
          example: '2023-03-21T08:09:51Z'
          maxLength: 20
          minLength: 3
          type: string
        offer_title:
          description: Title for the Offer.
          example: Test Offer
          maxLength: 50
          minLength: 3
          type: string
      title: OfferMetaResponse
      type: object
    OfferFilters:
      title: OfferFilters
      type: object
      description: Filter for offers.
      properties:
        offer_type:
          type: array
          description: Array of offer_type to be filtered.
          items:
            $ref: '#/components/schemas/OfferType'
      example:
        offer_type:
        - DISCOUNT_AND_CASHBACK
        - DISCOUNT
    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
    OfferNB:
      title: Net Banking Offer
      description: Offer object ofr NetBanking.
      example:
        netbanking:
          bank_name: hdfc bank
      type: object
      properties:
        netbanking:
          type: object
          properties:
            bank_name:
              type: string
              example: all
      required:
      - netbanking
    OfferPaylater:
      title: Paylater Offer
      description: Offer object for paylater.
      example:
        paylater:
          issuer: lazypay
      type: object
      properties:
        paylater:
          title: Paylater Offer
          type: object
          properties:
            provider:
              type: string
              example: simpl
      required:
      - paylater
    OfferQueries:
      title: OfferQueries
      description: Offer Query Object.
      type: object
      example:
        order_id: order_413462PK1RI1IwYB1X69LgzUQWiSxYDF
        amount: 100
      properties:
        order_id:
          type: string
          description: OrderId of the order. Either of `order_id` or `order_amount` is mandatory.
          minLength: 3
          maxLength: 50
          format: string
          example: order_413462PK1RI1IwYB1X69LgzUQWiSxYDF
        amount:
          type: number
          description: Amount of the order. OrderId of the order. Either of `order_id` or `order_amount` is mandatory.
          minimum: 1
          example: 100
    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
    OfferType:
      title: OfferType
      type: string
      description: Offer Type Object.
      example: DISCOUNT_AND_CASHBACK
      enum:
      - DISCOUNT
      - CASHBACK
      - DISCOUNT_AND_CASHBACK
      - NO_COST_EMI
    OfferUPI:
      title: UPI Offer
      description: Offer object for UPI.
      example:
        upi: {}
      type: object
      properties:
        upi:
          title: UPI Offer
          type: object
      required:
      - upi
    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
    OfferWallet:
      title: Wallet Offer
      description: Offer object for wallet payment method.
      example:
        app:
          issuer: paytm
      type: object
      properties:
        app:
          title: Wallet Offer
          type: object
          properties:
            provider:
              type: string
              example: paytm
      required:
      - app
    OrderAuthenticateEntity:
      title: OrderAuthenticateEntity
      description: The result of submitting or resending an OTP, with the authentication status and payment message.
      example:
        action: SUBMIT_OTP
        authenticate_status: SUCCESS
        cf_payment_id: '3991872901'
        payment_message: payment successful
      properties:
        cf_payment_id:
          type: string
          description: Cashfree payment ID for which this request was sent.
        action:
          type: string
          enum:
          - SUBMIT_OTP
          - RESEND_OTP
          description: The action that was requested.
        authenticate_status:
          type: string
          enum:
          - FAILED
          - SUCCESS
          description: Status of this action - will be either success or failed. If the action is success, you should still
            call [payment status API](https://www.cashfree.com/docs/api-reference/payments/latest/payments/get) to verify
            the final payment status.
        payment_message:
          type: string
          description: Human readable message which describes the status in more detail.
    OrderAuthenticatePaymentRequest:
      title: OrderAuthenticatePaymentRequest
      description: Request body to submit or resend an OTP in the Native OTP flow.
      type: object
      required:
      - action
      properties:
        otp:
          type: string
          description: OTP collected from the customer. Mandatory only when action is SUBMIT_OTP.
        action:
          type: string
          enum:
          - SUBMIT_OTP
          - RESEND_OTP
          description: Action intended for this request - can be SUBMIT_OTP or RESEND_OTP.
      example:
        otp: '111000'
        action: SUBMIT_OTP
    OrderCreateRefundRequest:
      title: OrderCreateRefundRequest
      description: Request body to create a refund for an order.
      example:
        refund_amount: 1
        refund_id: refund_00912
        refund_note: refund note for reference
        refund_speed: STANDARD
      type: object
      properties:
        refund_amount:
          type: number
          format: double
          description: Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed).
        refund_id:
          type: string
          description: An unique ID to associate the refund with. Provie alphanumeric values.
          minLength: 3
          maxLength: 40
        refund_note:
          type: string
          description: A refund note for your reference. To simulate refund status in Sandbox, pass SUCCESS, FAILED, PENDING,
            or ACTIVE in the refund_note field. This is a case-sensitive parameter.
          minLength: 3
          maxLength: 100
        refund_speed:
          type: string
          enum:
          - STANDARD
          - INSTANT
          description: Speed at which the refund is processed. It's an optional field with default being STANDARD.
        refund_splits:
          type: array
          items:
            properties:
              vendor_id:
                type: string
                description: Vendor id created in Cashfree system.
              amount:
                type: number
                description: Amount which will be associated with this vendor.
              tags:
                type: object
                maxProperties: 15
                description: Custom Tags in the form of {"key":"value"} which can be passed for an order. A maximum of 10
                  tags can be added.
                additionalProperties:
                  type: object
            required:
            - vendor_id
      required:
      - refund_amount
      - refund_id.
    OrderUpdateRefundRequest:
      title: OrderUpdateRefundRequest
      description: Request body to update a refund.
      example:
        refund_status: CANCELLED
        remarks: Requesting cancellation of refund
      type: object
      properties:
        refund_status:
          type: string
          description: 'Allowed values: ["CANCELLED"].'
          enum:
          - CANCELLED
        remarks:
          type: string
          description: Add remarks for your reference.
          minLength: 0
          maxLength: 250
      required:
      - refund_status
    OrderEntity:
      title: OrderEntity
      description: An order, with its amount, currency, status, customer details and payment session ID.
      type: object
      example:
        cf_order_id: '2149460581'
        created_at: '2023-08-11T18:02:46+05:30'
        customer_details:
          customer_id: '409128494'
          customer_name: Johmn Doe
          customer_email: pmlpayme@ntsas.com
          customer_phone: '9876543210'
          customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
        entity: order
        order_amount: 22
        payment_session_id: session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH
        order_currency: INR
        order_expiry_time: '2023-09-09T18:02:46+05:30'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        order_meta:
          return_url: https://www.cashfree.com/devstudio/thankyou
          payment_methods: cc
          notify_url: https://example.com/cf_notify
          payment_methods_filters:
            methods:
              action: ALLOW
              values:
                - debit_card
                - credit_card
                - credit_card_emi
                - debit_card_emi
            filters:
              card_bins:
                action: ALLOW
                values:
                  - 441144
                  - 554455
              card_schemes:
                action: ALLOW
                values:
                  - VISA
                  - MASTERCARD
              card_suffix:
                action: ALLOW
                values:
                  - 4433
                  - 8910
              card_emi_bins:
                action: ALLOW
                values:
                  - 441144
                  - 554455
              card_emi_schemes:
                action: ALLOW
                values:
                  - VISA
                  - MASTERCARD
              card_emi_suffix:
                action: ALLOW
                values:
                  - 4433
                  - 8910
        order_note: some order note LIST
        order_splits: []
        order_status: ACTIVE
        order_tags:
          name: John
          age: '19'
        terminal_data: null
        cart_details:
          cart_id: '1'
      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
        order_note:
          type: string
          description: Additional note for order.
        created_at:
          type: string
          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'
    OrderExtendedDataEntity:
      title: OrderExtendedDataEntity
      description: Extended data for an order, including customer details, shipping and billing addresses, cart, charges and offers.
      type: object
      example:
        cf_order_id: '2149460581'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        order_amount: 22
        order_currency: INR
        created_at: '2023-08-11T18:02:46+05:30'
        charges:
          shipping_charges: 5
          cod_handling_charges: 10
        customer_details:
          customer_id: '409128494'
          customer_name: Aditya Keshri
          customer_email: pmlpayme@ntsas.com
          customer_phone: '9876543210'
          customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
        shipping_address:
          name: Saurav Singh
          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
        billing_address:
          name: Saurav Singh
          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
        cart:
          name: test
          items:
            - item_id: '26'
              item_name: Sample Product
              item_description: item-description
              item_tags:
                - '1'
                - '2'
              item_details_url: http://cashfree.com
              item_image_url: http://cashfree.com
              item_original_unit_price: '1'
              item_discounted_unit_price: '1'
              item_quantity: 1
              item_currency: INR
            - item_id: '35'
              item_name: Sample Product
              item_description: item-description
              item_tags:
                - '1'
                - '2'
              item_details_url: http://cashfree.com
              item_image_url: http://cashfree.com
              item_original_unit_price: '1'
              item_discounted_unit_price: '1'
              item_quantity: 1
              item_currency: INR
        offer:
          offer_id: d2b430fb-1afe-455a-af31-66d00377b29a
          offer_status: active
          offer_meta:
            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'
          offer_tnc:
            offer_tnc_type: text
            offer_tnc_value: TnC for the Offer.
          offer_details:
            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'
          offer_validations:
            min_amount: 10
            payment_method:
              wallet:
                issuer: paytm
            max_allowed: 2
      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.
        order_amount:
          type: number
        order_currency:
          type: string
          description: Currency of the order. Example INR.
        created_at:
          type: string
          description: When the order was created at cashfree's server.
          example: '2022-08-16T14:45:38+05:30'
        charges:
          $ref: '#/components/schemas/ChargesEntity'
        customer_details:
          $ref: '#/components/schemas/ExtendedCustomerDetails'
        shipping_address:
          $ref: '#/components/schemas/AddressDetails'
        billing_address:
          $ref: '#/components/schemas/AddressDetails'
        cart:
          $ref: '#/components/schemas/ExtendedCartDetails'
        offers:
          type: array
          items:
            $ref: '#/components/schemas/OfferExtendedDetails'
    OfferExtendedDetails:
      title: OfferEntity
      type: object
      description: Details of the offer which got applied to the paid order.
      properties:
        offer_id:
          type: string
          example: d2b430fb-1afe-455a-af31-66d00377b29a
        offer_status:
          type: string
          example: active
        offer_meta:
          allOf:
          - $ref: '#/components/schemas/OfferMeta'
          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'
        offer_tnc:
          allOf:
          - $ref: '#/components/schemas/OfferTnc'
          example:
            offer_tnc_type: text
            offer_tnc_value: TnC for the Offer.
        offer_details:
          allOf:
          - $ref: '#/components/schemas/OfferDetails'
          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'
        offer_validations:
          allOf:
          - $ref: '#/components/schemas/OfferValidations'
          example:
            min_amount: 10
            payment_method:
              wallet:
                issuer: paytm
            max_allowed: 2
    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'
    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.
    ChargesEntity:
      title: ChargesEntity
      description: Charges accociated with the order.
      type: object
      example:
        shipping_charges: 5
        cod_handling_charges: 10
      properties:
        shipping_charges:
          type: number
          description: Shipping charge of the order.
        cod_handling_charges:
          type: number
          description: COD handling fee for order.
    ExtendedCustomerDetails:
      title: CustomerDetails
      description: Recent Customer details associated with the order.
      example:
        customer_id: 7112AAA812234
        customer_email: john@cashfree.com
        customer_phone: '9908734801'
        customer_name: John Doe
        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_uid:
          type: string
          description: Customer identifier at Cashfree. You will get this when you create/get customer.
    UpdateOrderExtendedDataEntity:
      title: UpdateOrderExtendedDataEntity
      description: Updated shipment and delivery status details for an order.
      type: object
      example:
        cf_order_id: '2149460581'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        shipment_details:
          - tracking_company: DHL
            tracking_urls:
              - https://dhl.com/track/123456
            tracking_numbers:
              - TRACK123456
        order_delivery_status:
          status: CANCELLED
          reason: wrong address
      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.
        shipment_details:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentDetails'
        order_delivery_status:
          $ref: '#/components/schemas/OrderDeliveryStatus'
    CartDetailsEntity:
      title: CartDetailsEntity
      description: Cart Details in the Order Entity Response.
      type: object
      properties:
        cart_id:
          type: string
          description: ID of the cart that was created.
    OrderMeta:
      title: OrderMeta
      description: Optional meta details to control how the customer pays and how payment journey completes.
      type: object
      properties:
        return_url:
          type: string
          example: https://www.cashfree.com/devstudio/thankyou?order_id=devstudio_734905336776434862
          description: |-
            This is the [URL](https://www.cashfree.com/devstudio/thankyou?order_id=devstudio_734905336776434862) to which the customer will be redirected after the payment reaches a terminal state (success, failed or cancelled). We recommend keeping context of `order_id` in your `return_url` so that you can identify the order when customer lands on your page. Cashfree triggers a **GET request** to this URL.
            Maximum URL length: 250 characters.
        notify_url:
          type: string
          example: https://example.com/cf_notify
          description: 'Notification URL for server-server communication. Useful when user''s connection drops while re-directing.
            NotifyUrl should be an https URL. Maximum length: 250.'
        payment_methods:
          example: cc,dc,upi
          description: 'Specifies the allowed payment modes for this order. To restrict payment options,  provide a comma-separated
            list of values from the following options: `cc`, `dc`, `ccc`,  `ppc`, `nb`, `upi`, `paypal`, `app`, `paylater`,
            `cardlessemi`, `dcemi`, `ccemi`,  `banktransfer`, `applepay`. Leave this field blank to display all available
            payment methods.'
        payment_methods_filters:
          description: Allowed payment modes for this order. Along with multiple filters for cards can be added to this key.
            And this filtering will be honoured during transaction creation.
          type: object
          properties:
            methods:
              description: Allowed payment modes for this order. credit_card, debit_card, netbanking, paylater, etc are the
                values that can be passed to this parameter.
              type: object
              properties:
                action:
                  type: string
                  description: It accepts value of "ALLOW" and allows only those modes present in it's neighbouring parameter
                    "values.".
                values:
                  type: array
                  items:
                    type: string
                  description: The accepted entries for this paramter are "debit_card, credit_card, prepaid_card, upi, wallet,
                    netbanking, banktransfer, paylater, paypal, debit_card_emi, credit_card_emi, upi_credit_card, upi_ppi,
                    cardless_emi, account_based_payment, corporate_credit_card, sbc_debit_card, sbc_emandate, sbc_upi, sbc_credit_card.".
            filters:
              $ref: '#/components/schemas/OrderPaymentMethodFilters'
        offer_filters:
          type: object
          description: Allow or deny specific offers.
          properties:
            action:
              type: string
              enum:
              - ALLOW
              - DENY
              description: Defines whether to allow or deny the specified offers.
              example: ALLOW
            values:
              type: array
              maxItems: 25
              items:
                type: string
                maxLength: 50
              description: List of offer identifiers.
              example:
              - OFFER_123
              - OFFER_456
          example:
            action: ALLOW
            values:
            - OFFER_123
            - OFFER_456
        upi_app_priority:
          description: Set the priority of UPI apps that you want to show for this order. Pass values in list among following
            options - "gpay","phonepe","paytm","navi","cred","supermoney","amazonpay","bhim","mobikwik","airtel","popclub","kiwi".
          example:
          - navi
          - gpay
          - phonepe
          - cred
    OrderPaymentMethodFilters:
      title: OrderPaymentMethodFilters
      description: Filters for this order. Card bins, card schemes, card issuing bank and card suffixes.
      type: object
      properties:
        card_emi_tenure:
          type: integer
          minimum: 3
          maximum: 36
          description: Allowed card EMI tenure for the order.
        card_emi_bins:
          type: array
          items:
            type: integer
            minimum: 100000
            maximum: 999999
          description: Allowed card EMI bins for the order.
        card_emi_schemes:
          type: array
          items:
            type: string
          description: Allowed card EMI schemes for the order.
        card_emi_suffix:
          type: array
          items:
            type: integer
          description: Allowed card EMI suffixes for the order.
        card_emi_issuing_bank:
          type: array
          items:
            type: string
          description: Allowed card EMI issuing bank for the order.
        card_bins:
          type: array
          items:
            type: integer
            minimum: 100000
            maximum: 999999
          description: Allowed card bins for the order.
        card_schemes:
          type: array
          items:
            type: string
          description: Allowed card schemes for the order.
        card_suffix:
          type: array
          items:
            type: integer
          description: Allowed card suffixes for the order.
        card_issuing_bank:
          type: array
          items:
            type: string
          description: Allowed card issuing bank for the order.
    OrderPayData:
      title: OrderPayData
      type: object
      description: The data object of Order Pay API.
      properties:
        url:
          type: string
          description: For card payments, if the response includes ```action:link```, redirect the customer to the ```data.url```
            page. If the response includes ```action:post```, display a native OTP UI to collect the OTP and submit it to
            ```data.url```.
        payload:
          type: object
          description: Key value pairs sent as the request body if the payment link requires a form submission instead of
            a redirect.
        content_type:
          type: string
          description: Specifies the Content-Type header that should be used when submitting the payload, for example, ```application/x-www-form-urlencoded```.
        method:
          type: string
          description: The HTTP method to use when submitting the payload to the url. For example, POST.
        redirect_to_bank:
          type: string
          description: This field is available only for card payments when ```action:post``` is returned. Display a native
            OTP UI and also provide an option for the customer to redirect to bank page. When the customer selects this option,
            redirect them to the ```data.redirect_to_bank``` URL.
    OrderTags:
      type: object
      maxProperties: 15
      description: Custom Tags in the form of {"key":"value"} which can be passed for an order. A maximum of 10 tags can be
        added.
      additionalProperties:
        type: string
        minLength: 1
        maxLength: 255
      example:
        product: Laptop
        shipping_address: 123 Main St.
    ProductDetailsEntity:
      type: object
      description: Configurations for this feature.
      properties:
        enabled:
          type: boolean
          description: Whether the feature has been enabled for this order.
        conditions:
          type: array
          description: Configured condtions for the feature.
          items:
            $ref: '#/components/schemas/ProductConditionsEntity'
    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
    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'
    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
    PayOrderEntity:
      title: PayOrderEntity
      type: object
      description: A transaction created for an order, with its amount, payment method, channel and the action to complete the payment.
      example:
        payment_method: card
        channel: link
        action: link
        cf_payment_id: '91235'
        payment_amount: 22.42
        data:
          url: https://sandbox.cashfree.com/pg/view/gateway/FHsuvhayLM5mmhINoqri7ba296e2ebca8b98e6119f6223021a13
          payload:
            name: card
          content_type: application/x-www-form-urlencoded
          method: post
      properties:
        payment_amount:
          type: number
          description: Total amount payable.
        cf_payment_id:
          type: string
          description: Payment identifier created by Cashfree.
          format: int64
        payment_method:
          type: string
          enum:
          - netbanking
          - card
          - upi
          - app
          - cardless_emi
          - paylater
          - banktransfer
          - applepay
          description: |
            The payment method used for this transaction.
            - netbanking: Net banking payment.
            - card: Credit or debit card payment.
            - upi: UPI payment via collect, intent, or QR code.
            - app: Wallet-based payment.
            - cardless_emi: Cardless EMI payment.
            - paylater: Pay later payment.
            - banktransfer: Direct bank transfer payment.
            - applepay: Apple Pay payment.
        channel:
          type: string
          enum:
          - link
          - post
          - collect
          - qrcode
          - podQrCode
          description: |
            The channel used for the payment method.
            - link: Redirect-based flow where the customer is taken to an external page.
            - post: Native OTP flow where the merchant renders a custom UI to collect OTP.
            - collect: UPI collect request sent to the customer's VPA.
            - qrcode: UPI QR code for the customer to scan.
            - podQrCode: Pay on delivery QR code.
        action:
          type: string
          enum:
          - link
          - post
          - custom
          - form
          description: |
            The action to complete the payment.
            - link: Redirect the customer to `data.url` using a browser or in-app webview.
            - post: Render a native UI, collect required input, and POST it to `data.url`.
            - form: Render the form from `data.payload` and auto-submit it to `data.url`.
            - custom: Follow integration-specific instructions or SDK handling.
        data:
          $ref: '#/components/schemas/OrderPayData'
    GetAllTerminalTransactionRequest:
      title: GetAllTerminalTransactionRequest
      type: object
      description: Request body to fetch terminal transactions. Include filter and pagination options to customise the results.
      properties:
        filter:
          $ref: '#/components/schemas/TerminalFilters'
        pagination:
          $ref: '#/components/schemas/TerminalPagination'
    PayOrderRequest:
      title: PayOrderRequest
      description: Request body to create a transaction using `payment_session_id`.
      type: object
      properties:
        payment_session_id:
          title: payment_session_id
          description: Unique identifier for the payment session, returned in the response of the Create Order API.
          type: string
          example: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/CardPaymentMethod'
          - $ref: '#/components/schemas/UPIPaymentMethod'
          - $ref: '#/components/schemas/NetBankingPaymentMethod'
          - $ref: '#/components/schemas/AppPaymentMethod'
          - $ref: '#/components/schemas/CardEMIPaymentMethod'
          - $ref: '#/components/schemas/CardlessEMIPaymentMethod'
          - $ref: '#/components/schemas/PaylaterPaymentMethod'
          - $ref: '#/components/schemas/BanktransferPaymentMethod'
        save_instrument:
          type: boolean
          description: Send as **true** if the customer has given consent to save or tokenise the card; otherwise, send as
            false.
        offer_id:
          type: string
          description: This is required if any offers needs to be applied to the order.
          example: faa6cc05-d1e2-401c-b0cf-0c9db3ff0f0b
        transaction_expiry_time:
          type: string
          format: ISO8601
          description: The maximum time for the payment attempt to reach a terminal state. If this timestamp expires, the transaction is marked as failed and cannot be retried. Provide the value in ISO 8601 timestamp format. Timestamps are stored in IST. IST appears as 2021-07-02T10:20:12+05:30, UTC appears as 2021-07-02T10:20:12Z.
          example: "2021-07-02T10:20:12+05:30"
      required:
      - payment_session_id
      - payment_method
    Paylater:
      title: Paylater
      description: Paylater payment method.
      example:
        channel: link
        provider: kotak
        phone: '7789112345'
      type: object
      properties:
        channel:
          type: string
          description: The channel for cardless EMI is always `link`.
        provider:
          type: string
          enum:
          - kotak
          - flexipay
          - zestmoney
          - lazypay
          - olapostpaid
          - simpl
          - freechargepaylater
          description: One of ["kotak", "flexipay", "zestmoney", "lazypay", "olapostpaid","simpl", "freechargepaylater"].
            Please note that Flexipay is offered by HDFC bank.
        phone:
          type: string
          description: Customers phone number for this payment instrument. If the customer is not eligible you will receive
            a 400 error with type as 'invalid_request_error' and code as 'invalid_request_error'.
    Banktransfer:
      title: Banktransfer
      description: Bank transfer payment method.
      example:
        channel: link
      type: object
      properties:
        channel:
          type: string
          description: The channel for bank transfer is always `link`.
    PaylaterEntity:
      title: PaylaterEntity
      description: Paylater Entity.
      type: object
      properties:
        payment_method:
          type: string
          example: olapostpaid
    PaylaterPaymentMethod:
      title: PaylaterPaymentMethod
      description: Paylater payment method.
      type: object
      properties:
        paylater:
          $ref: '#/components/schemas/Paylater'
      required:
      - paylater
    BanktransferPaymentMethod:
      title: BanktransferPaymentMethod
      description: banktransfer payment method.
      type: object
      properties:
        banktransfer:
          $ref: '#/components/schemas/Banktransfer'
      required:
      - banktransfer
    PaymentGatewayDetails:
      title: PaymentGatewayDetails
      type: object
      description: payment gateway details present in the webhook response.
      properties:
        gateway_name:
          type: string
        gateway_order_id:
          type: string
        gateway_payment_id:
          type: string
        gateway_order_reference_id:
          type: string
        gateway_status_code:
          type: string
        gateway_settlement:
          type: string
        gateway_reference_name:
          type: string
    PaymentEntity:
      title: PaymentEntity
      description: A payment, with its amount, status, payment method, payment time and gateway details.
      type: object
      example:
        cf_payment_id: '12376123'
        order_id: order_8123
        entity: payment
        payment_currency: INR
        error_details: null
        order_amount: 10.01
        order_currency: INR
        is_captured: true
        payment_group: upi
        authorization:
          action: CAPTURE
          status: PENDING
          captured_amount: 100
          start_time: '2022-02-09T18:04:34+05:30'
          end_time: '2022-02-19T18:04:34+05:30'
          approve_by: '2022-02-09T18:04:34+05:30'
          action_reference: '6595231908096894505959'
          action_time: '2022-08-03T16:09:51'
        payment_method:
          upi:
            channel: collect
            upi_id: rohit@xcxcx
            upi_payer_ifsc: AXL1234
            upi_payer_account_number: XXXXXXX6024
        payment_amount: 10.01
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: SUCCESS
        payment_surcharge:
          payment_surcharge_service_charge: 0
          payment_surcharge_service_tax: 0
        payment_message: Transaction successful
        bank_reference: P78112898712
        auth_id: A898101
        international_payment:
          international: false
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 1234421ABD
          gateway_payment_id: XABDJ2213
          gateway_order_reference_id: BDIWO233
          gateway_settlement: cashfree
          gateway_reference_name: ''
      properties:
        cf_payment_id:
          type: string
          description: Payment entity full object.
        order_id:
          type: string
        entity:
          type: string
        error_details:
          $ref: '#/components/schemas/ErrorDetailsInPaymentsEntity'
        is_captured:
          type: boolean
        order_amount:
          type: number
          description: Order amount can be different from payment amount if you collect service fee from the customer.
        payment_group:
          type: string
          description: Type of payment group. One of ['prepaid_card', 'upi_ppi_offline', 'cash', 'upi_credit_card', 'paypal',
            'net_banking', 'cardless_emi', 'credit_card', 'bank_transfer', 'pay_later', 'debit_card_emi', 'debit_card', 'wallet',
            'upi_ppi', 'upi', 'credit_card_emi'].
        payment_currency:
          type: string
        payment_amount:
          type: number
        payment_time:
          type: string
          description: This is the time when the payment was initiated.
        payment_completion_time:
          type: string
          description: This is the time when the payment reaches its terminal state.
        payment_status:
          type: string
          enum:
          - SUCCESS
          - NOT_ATTEMPTED
          - FAILED
          - USER_DROPPED
          - VOID
          - CANCELLED
          - PENDING
          description: The transaction status can be one of  ["SUCCESS", "NOT_ATTEMPTED", "FAILED", "USER_DROPPED", "VOID",
            "CANCELLED", "PENDING"].
        payment_message:
          type: string
        bank_reference:
          type: string
          description: Issuing bank’s transaction reference number.
        auth_id:
          type: string
          description: Authorisation ID provided by the issuing bank.
        order_currency:
          type: string
        authorization:
          $ref: '#/components/schemas/AuthorizationInPaymentsEntity'
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodCardInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodNetBankingInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodUPIInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodAppInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodCardlessEMIInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodPaylaterInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodCardEMIInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodBankTransferInPaymentsEntity'
        international_payment:
          $ref: '#/components/schemas/InternationalPaymentEntity'
        payment_gateway_details:
          $ref: '#/components/schemas/PaymentGatewayDetails'
        payment_surcharge:
          type: object
          properties:
            payment_surcharge_service_charge:
              type: number
              format: float64
            payment_surcharge_service_tax:
              type: number
              format: float64
    GetAllTerminalPaymentEntity:
      title: GetAllTerminalPaymentEntity
      type: object
      description: A terminal payment transaction, with its amount, payment mode, status and time.
      example:
        cf_terminal_id: 12376123
        terminal_id: abcd
        terminal_vpa: cf.epose@cashfreensdlpb
        cf_payment_id: 12394
        payment_amount: 10.1
        payment_mode: UPI_OFFLINE_STATIC
        payment_status: SUCCESS
        payment_time: '2023-11-28T15:59:55+05:30'
      properties:
        cf_terminal_id:
          type: integer
          description: Unique Cashfree terminal identifier.
        terminal_id:
          type: string
          description: Merchant-defined terminal identifier.
        terminal_vpa:
          type: string
          description: Virtual payment address (VPA) associated with the terminal.
        cf_payment_id:
          type: integer
          description: Unique Cashfree payment identifier.
        payment_amount:
          type: number
          description: Payment transaction amount in the specified currency.
        payment_mode:
          type: string
          description: Payment method used for the transaction (for example, UPI_OFFLINE_STATIC).
        payment_status:
          type: string
          description: Current status of the payment transaction (SUCCESS, FAILED, or PENDING).
        payment_time:
          type: string
          description: Timestamp when the payment was processed in ISO8601 format.
        error_details:
          $ref: '#/components/schemas/ErrorDetailsInPaymentsEntity'
    TerminalPaymentEntity:
      title: TerminalPaymentEntity
      type: object
      description: A terminal payment, with its amount, status, payment method, customer details and gateway details.
      example:
        cf_payment_id: '12376123'
        order_id: order_8123
        entity: payment
        payment_currency: INR
        error_details: null
        order_amount: 10.01
        is_captured: true
        payment_group: upi
        authorization:
          action: CAPTURE
          status: PENDING
          captured_amount: 100
          start_time: '2022-02-09T18:04:34+05:30'
          end_time: '2022-02-19T18:04:34+05:30'
          approve_by: '2022-02-09T18:04:34+05:30'
          action_reference: '6595231908096894505959'
          action_time: '2022-08-03T16:09:51'
        payment_method:
          upi:
            channel: collect
            upi_id: rohit@xcxcx
            upi_payer_ifsc: AXL1234
            upi_payer_account_number: XXXXXXX6024
        payment_amount: 10.01
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: SUCCESS
        payment_message: Transaction successful
        bank_reference: P78112898712
        auth_id: A898101
        customer_details:
          customer_id: 7112AAA812234
          customer_email: john@cashfree.com
          customer_phone: '9908734801'
          customer_name: John Doe
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 1234421ABD
          gateway_payment_id: XABDJ2213
          gateway_order_reference_id: BDIWO233
          gateway_settlement: cashfree
          gateway_reference_name: ''
      properties:
        cf_payment_id:
          type: integer
          format: int64
        order_id:
          type: string
        entity:
          type: string
        error_details:
          $ref: '#/components/schemas/ErrorDetailsInPaymentsEntity'
        is_captured:
          type: boolean
        order_amount:
          type: number
          description: Order amount can be different from payment amount if you collect service fee from the customer.
        payment_group:
          type: string
          description: Type of payment group. One of ['prepaid_card', 'upi_ppi_offline', 'cash', 'upi_credit_card', 'paypal',
            'net_banking', 'cardless_emi', 'credit_card', 'bank_transfer', 'pay_later', 'debit_card_emi', 'debit_card', 'wallet',
            'upi_ppi', 'upi', 'credit_card_emi'].
        payment_currency:
          type: string
        payment_amount:
          type: number
        payment_time:
          type: string
          description: This is the time when the payment was initiated.
        payment_completion_time:
          type: string
          description: This is the time when the payment reaches its terminal state.
        payment_status:
          type: string
          enum:
          - SUCCESS
          - NOT_ATTEMPTED
          - FAILED
          - USER_DROPPED
          - VOID
          - CANCELLED
          - PENDING
          description: The transaction status can be one of  ["SUCCESS", "NOT_ATTEMPTED", "FAILED", "USER_DROPPED", "VOID",
            "CANCELLED", "PENDING"].
        payment_message:
          type: string
        bank_reference:
          type: string
        auth_id:
          type: string
        authorization:
          $ref: '#/components/schemas/AuthorizationInPaymentsEntity'
        customer_details:
          $ref: '#/components/schemas/CustomerDetails'
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodCardInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodNetBankingInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodUPIInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodAppInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodCardlessEMIInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodPaylaterInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodCardEMIInPaymentsEntity'
          - $ref: '#/components/schemas/PaymentMethodBankTransferInPaymentsEntity'
        payment_gateway_details:
          $ref: '#/components/schemas/PaymentGatewayDetails'
    PaymentLinkCustomerDetails:
      title: PaymentLinkCustomerDetails
      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
      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).
      required:
      - customer_phone.
    PaymentLinkOrderEntity:
      title: PaymentLinkOrderEntity
      type: object
      description: An order created from a payment link, with its amount, currency, status and payment session ID.
      example:
        cf_order_id: '2149460581'
        created_at: '2023-08-11T18:02:46+05:30'
        customer_details:
          customer_id: '409128494'
          customer_name: Johmn Doe
          customer_email: pmlpayme@ntsas.com
          customer_phone: '9876543210'
          customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
        entity: order
        order_amount: 22
        payment_session_id: session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH
        order_currency: INR
        order_expiry_time: '2023-09-09T18:02:46+05:30'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        order_meta:
          return_url: https://www.cashfree.com/devstudio/thankyou
          payment_methods: cc
          notify_url: https://example.com/cf_notify
          payment_methods_filters:
            methods:
              action: ALLOW
              values:
                - debit_card
                - credit_card
                - credit_card_emi
                - debit_card_emi
            filters:
              card_bins:
                action: ALLOW
                values:
                  - 441144
                  - 554455
              card_schemes:
                action: ALLOW
                values:
                  - VISA
                  - MASTERCARD
              card_suffix:
                action: ALLOW
                values:
                  - 4433
                  - 8910
              card_emi_bins:
                action: ALLOW
                values:
                  - 441144
                  - 554455
              card_emi_schemes:
                action: ALLOW
                values:
                  - VISA
                  - MASTERCARD
              card_emi_suffix:
                action: ALLOW
                values:
                  - 4433
                  - 8910
        order_note: some order note LIST
        order_splits: []
        order_status: ACTIVE
        order_tags:
          name: John
          age: '19'
        terminal_data: null
        cart_details:
          cart_id: '1'
      properties:
        cf_order_id:
          type: string
          description: unique id generated by cashfree for your order.
        link_id:
          type: string
          description: link id of the 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"
        payment_session_id:
          type: string
        order_expiry_time:
          type: string
        order_note:
          type: string
          description: Additional note for order.
        created_at:
          type: string
          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/PaymentLinkCustomerDetails'
        order_meta:
          $ref: '#/components/schemas/OrderMeta'
        order_tags:
          $ref: '#/components/schemas/OrderTags'
    PaymentMethodAppInPaymentsEntity:
      title: App
      description: payment method app object in payment entity.
      example:
        channel: link
        provider: paytm
        phone: '1234512345'
      type: object
      properties:
        app:
          type: object
          properties:
            channel:
              type: string
            provider:
              type: string
            phone:
              type: string
    PaymentMethodBankTransferInPaymentsEntity:
      title: Bank transfer
      description: payment method bank transfer object in payment entity.
      example:
        channel: link
        banktransfer_bank_name: BANK_TRANSFER
        banktransfer_ifsc: ''
        banktransfer_account_number: ''
      type: object
      properties:
        banktransfer:
          type: object
          properties:
            channel:
              type: string
            banktransfer_bank_name:
              type: string
            banktransfer_ifsc:
              type: string
            banktransfer_account_number:
              type: string
    PaymentMethodCardEMIInPaymentsEntity:
      title: Card EMI
      description: payment method card emi object in payment entity.
      example:
        channel: link
        card_number: 41111xxxxxx111
        card_network: visa
        card_type: credit_card
        card_country: IN
        card_bank_name: HDFC Bank
        card_network_reference_id: '100212023061229'
      type: object
      properties:
        emi:
          type: object
          properties:
            channel:
              type: string
            card_number:
              type: string
            card_network:
              type: string
            card_type:
              type: string
            card_country:
              type: string
            card_bank_name:
              type: string
            card_network_reference_id:
              type: string
            emi_tenure:
              type: number
            emi_details:
              type: object
              properties:
                emi_amount:
                  type: number
                emi_tenure:
                  type: number
                emi_interest:
                  type: number
    PaymentMethodCardInPaymentsEntity:
      title: Card
      description: The following code samples show the payment method object payload for different payment methods.
      example:
        channel: link
        card_number: XXXXXXXXXXXX4738
        card_network: visa
        card_type: credit_card
        card_sub_type: R
        card_country: IN
        card_bank_name: HDFC Bank
        card_network_reference_id: '100212023061229'
        instrument_id: 3fc5814b-e732-4a71-b2ee-94b4f147d9e1
      type: object
      properties:
        card:
          type: object
          properties:
            channel:
              description: The requested channel, can be `link` or `post`.
              type: string
            card_number:
              description: The last four digits of the customer's card number. For external token transactions or external
                Alt ID transactions, this value is passed only when the merchant includes `card_display` in the [Order Pay
                API](https://www.cashfree.com/docs/api-reference/payments/latest/payments/pay) request.
              type: string
            card_network:
              description: The card scheme or network of the card. For example, `visa`, `mastercard`, `rupay`, `amex`, or
                `diners`.
              type: string
            card_type:
              description: The type of card. For example, `credit_card`, `debit_card`, or `prepaid_card`.
              type: string
            card_sub_type:
              description: The sub-type of card. `R` is Retail card, `P` is Premium card, `C` is Corporate card.
              type: string
            card_country:
              description: The issuing country of the card. For example, `IN`.
              type: string
            card_bank_name:
              description: The issuing bank of the card. For example, `HDFC BANK`, `AXIS BANK`, or `ICICI BANK`.
              type: string
            card_network_reference_id:
              description: The authentication reference ID provided by the respective card network.
              type: string
            instrument_id:
              description: The identifier for the card saved at Cashfree. This value is sent only for CF token transactions.
              type: string
    PaymentMethodCardlessEMIInPaymentsEntity:
      title: Cardless EMI
      description: payment method carless object in payment entity.
      example:
        channel: link
        provider: flexmoney
        phone: '9908761211'
      type: object
      properties:
        cardless_emi:
          type: object
          properties:
            channel:
              type: string
            provider:
              type: string
            phone:
              type: string
    PaymentMethodNetBankingInPaymentsEntity:
      title: Net banking
      description: Netbanking payment method object for pay.
      example:
        channel: link
        netbanking_bank_code: 3044
        netbanking_bank_name: State Bank of India
      type: object
      properties:
        netbanking:
          type: object
          properties:
            channel:
              type: string
            netbanking_bank_code:
              type: integer
            netbanking_bank_name:
              type: string
            netbanking_ifsc:
              type: string
            netbanking_account_number:
              type: string
      required:
      - channel
      - netbanking_bank_name
      - netbanking_bank_code
    PaymentMethodPaylaterInPaymentsEntity:
      title: Pay later
      description: Paylater payment method object for pay API.
      example:
        channel: link
        provider: lazypay
        phone: '9908761211'
      type: object
      properties:
        paylater:
          type: object
          properties:
            channel:
              type: string
            provider:
              type: string
            phone:
              type: string
    PaymentMethodUPIInPaymentsEntity:
      title: UPI
      description: UPI payment method for pay api.
      example:
        channel: collect
        upi_id: 980123781@upi
        upi_payer_ifsc: AXL1234
        upi_payer_account_number: XXXXXXX6024
      type: object
      properties:
        upi:
          type: object
          properties:
            channel:
              type: string
            upi_id:
              type: string
            upi_payer_ifsc:
              type: string
            upi_payer_account_number:
              type: string
      required:
      - channel
    PaymentMethodsFilters:
      title: PaymentMethodsFilters
      type: object
      example:
        payment_methods: null
      description: Filter for Payment Methods.
      properties:
        payment_methods:
          type: array
          description: Array of payment methods to be filtered. This is optional, by default all payment methods will be returned.
            Possible values in [ 'debit_card', 'credit_card', 'prepaid_card', 'corporate_credit_card', 'upi', 'wallet', 'netbanking',
            'banktransfer', 'paylater', 'paypal', 'debit_card_emi', 'credit_card_emi', 'upi_credit_card', 'upi_ppi', 'cardless_emi',
            'account_based_payment' ].
          items:
            $ref: '#/components/schemas/MethodsType'
    PaymentMethodsQueries:
      title: PaymentMethodsQueries
      description: Payment Method Query Object.
      type: object
      example:
        amount: 100
      properties:
        amount:
          type: number
          description: Amount of the order.
          minimum: 1
          example: 100
        order_id:
          type: string
          description: OrderId of the order. Either of `order_id` or `order_amount` is mandatory.
          minLength: 3
          maxLength: 50
          format: string
          example: order_413462PK1RI1IwYB1X69LgzUQWiSxYDF
    PaymentModeDetails:
      description: payment mode eligiblity object.
      properties:
        nick:
          type: string
          example: motak_kahindra_bank
        display:
          type: string
          example: Motak Mahindra Bank
        eligibility:
          type: boolean
          example: false
        code:
          type: number
          example: 3001
    RateLimitError:
      title: RateLimitError
      description: Error when rate limit is breached for your api.
      example:
        message: Too many requests from IP. Check headers
        code: request_failed
        type: rate_limit_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        type:
          type: string
          enum:
          - rate_limit_error
          description: rate_limit_error.
    ReconEntity:
      title: ReconEntity
      description: A paginated list of reconciliation events, each with its order, payment, settlement, refund and dispute details.
      example:
        cursor: cursor-uid
        limit: 10
        data:
        - customer_details:
            customer_bank_account_number: null
            customer_bank_code: null
            customer_bank_ifsc: null
            customer_email: cashfreesdet+pwynht20250910112529373@gmail.com
            customer_id: null
            customer_name: Charlie
            customer_phone: '9892566583'
          dispute_details:
            closed_in_favor_of: null
            dispute_category: null
            dispute_note: null
            dispute_resolved_on: null
            resolved_on: null
          event_details:
            entity: recon
            event_amount: 0.0
            event_currency: INR
            event_id: '5114920543991'
            event_remarks: null
            event_service_charge: null
            event_service_tax: null
            event_settlement_amount: null
            event_status: FAILED
            event_time: '2025-09-10T16:55:56+05:30'
            event_type: PAYMENT
            sale_type: CREDIT
          order_details:
            order_amount: 4000.0
            order_currency: null
            order_id: Automated_Test_202509101125293419855069112
            order_tags: null
          payment_details:
            bank_reference: null
            cf_payment_id: '5114920543991'
            charges_currency: INR
            forex_conversion_handling_charge: null
            forex_conversion_handling_tax: null
            payment_amount: null
            payment_currency: null
            payment_group: CREDIT_CARD_EMI
            payment_service_charge: null
            payment_service_tax: null
            payment_time: null
            status: null
          refund_details:
            refund_arn: null
            refund_id: null
            refund_note: null
            refund_processed_at: null
          settlement_details:
            adjustment: null
            amount_settled: null
            cf_settlement_id: ''
            payment_from: null
            payment_till: null
            reason: null
            remarks: null
            service_charge: null
            service_tax: null
            settlement_charge: null
            settlement_date: null
            settlement_initiated_on: null
            settlement_tax: null
            settlement_type: null
            split_service_charge: null
            split_service_tax: null
            utr: null
            vendor_commission: null
        - customer_details:
            customer_bank_account_number: '9876543210'
            customer_bank_code: HDFC001
            customer_bank_ifsc: HDFC0001234
            customer_email: charlie.doe@example.com
            customer_id: CUST12345
            customer_name: Charlie Doe
            customer_phone: '9123456789'
          dispute_details:
            closed_in_favor_of: merchant
            dispute_category: Fraudulent Transaction
            dispute_note: Customer raised a chargeback for unauthorized use
            dispute_resolved_on: '2025-09-12T10:30:00+05:30'
            resolved_on: '2025-09-12T10:30:00+05:30'
          event_details:
            entity: recon
            event_amount: 4000.0
            event_currency: INR
            event_id: EVT987654321
            event_remarks: Payment captured successfully
            event_service_charge: 40.0
            event_service_tax: 7.2
            event_settlement_amount: 3952.8
            event_status: SUCCESS
            event_time: '2025-09-11T14:45:20+05:30'
            event_type: PAYMENT
            sale_type: CREDIT
          order_details:
            order_amount: 4000.0
            order_currency: INR
            order_id: order_20250911XYZ987654
            order_tags:
              category: Electronics
              device: Mobile
          payment_details:
            bank_reference: BR123456789
            cf_payment_id: PAY9876543210
            charges_currency: INR
            forex_conversion_handling_charge: 0.0
            forex_conversion_handling_tax: 0.0
            payment_amount: 4000.0
            payment_currency: INR
            payment_group: CREDIT_CARD_EMI
            payment_service_charge: 40.0
            payment_service_tax: 7.2
            payment_time: '2025-09-11T14:45:18+05:30'
            status: SUCCESS
          refund_details:
            refund_arn: ARN1234567890
            refund_id: REF9876543210
            refund_note: Customer requested refund for damaged product
            refund_processed_at: '2025-09-12T11:15:00+05:30'
          settlement_details:
            adjustment: None
            amount_settled: 3952.8
            cf_settlement_id: SETT987654321
            payment_from: '2025-09-11T00:00:00+05:30'
            payment_till: '2025-09-11T23:59:59+05:30'
            reason: Normal Settlement
            remarks: Settled within T+1 cycle
            service_charge: 40.0
            service_tax: 7.2
            settlement_charge: 47.2
            settlement_date: '2025-09-12T18:30:00+05:30'
            settlement_initiated_on: '2025-09-12T15:00:00+05:30'
            settlement_tax: 7.2
            settlement_type: DAILY
            split_service_charge: 0.0
            split_service_tax: 0.0
            utr: HDFC20250912UTR12345
            vendor_commission: 0.0
        - customer_details:
            customer_bank_account_number: null
            customer_bank_code: null
            customer_bank_ifsc: null
            customer_email: cashfreesdet+mmmmgf20250910112620666@gmail.com
            customer_id: null
            customer_name: Sharyl
            customer_phone: '9875662870'
          dispute_details:
            closed_in_favor_of: null
            dispute_category: null
            dispute_note: null
            dispute_resolved_on: null
            resolved_on: null
          event_details:
            entity: recon
            event_amount: 0.0
            event_currency: INR
            event_id: '5114920544087'
            event_remarks: null
            event_service_charge: null
            event_service_tax: null
            event_settlement_amount: null
            event_status: PENDING
            event_time: '2025-09-10T16:56:21+05:30'
            event_type: PAYMENT
            sale_type: CREDIT
          order_details:
            order_amount: 0.0
            order_currency: null
            order_id: payment_202509101126201757503580894
            order_tags: null
          payment_details:
            bank_reference: null
            cf_payment_id: '5114920544087'
            charges_currency: INR
            forex_conversion_handling_charge: null
            forex_conversion_handling_tax: null
            payment_amount: null
            payment_currency: null
            payment_group: SBC_PHYSICAL_MANDATE_SAVING
            payment_service_charge: null
            payment_service_tax: null
            payment_time: null
            status: null
          refund_details:
            refund_arn: null
            refund_id: null
            refund_note: null
            refund_processed_at: null
          settlement_details:
            adjustment: null
            amount_settled: null
            cf_settlement_id: ''
            payment_from: null
            payment_till: null
            reason: null
            remarks: null
            service_charge: null
            service_tax: null
            settlement_charge: null
            settlement_date: null
            settlement_initiated_on: null
            settlement_tax: null
            settlement_type: null
            split_service_charge: null
            split_service_tax: null
            utr: null
            vendor_commission: null
      properties:
        cursor:
          type: string
          description: Specifies from where the next set of settlement details should be fetched.
        limit:
          type: integer
          description: Number of settlements you want to fetch in the next iteration.
        data:
          type: array
          items:
            type: object
            properties:
              event_details:
                type: object
                properties:
                  event_id:
                    type: string
                    description: Unique ID associated with the event.
                  event_type:
                    type: string
                    description: The event type can be PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK,
                      CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT.
                  event_settlement_amount:
                    type: number
                    description: Amount that is part of the settlement corresponding to the event.
                  event_amount:
                    type: number
                    description: Amount corresponding to the event. Example, refund amount, dispute amount, payment amount,
                      etc.
                  sale_type:
                    type: string
                    description: Indicates if it is CREDIT/DEBIT sale.
                  event_status:
                    type: string
                    description: Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED.
                  entity:
                    type: string
                    description: Recon.
                  event_time:
                    type: string
                    description: Time associated with the event. Example, transaction time, dispute initiation time.
                  event_currency:
                    type: string
                    description: Curreny type - INR.
                  event_service_charge:
                    type: number
                    description: Service charge for above event_type.
                  event_service_tax:
                    type: number
                    description: Service tax for above event_type.
                  event_remarks:
                    type: number
                    description: Remarks for above event_type.
              order_details:
                type: object
                properties:
                  order_id:
                    type: string
                    description: Unique order ID. Alphanumeric and only '-' and '_' allowed.
                  order_amount:
                    type: number
                    description: The amount which was passed at the order creation time.
                  order_currency:
                    type: string
                    description: Order Curreny type - INR.
                  order_tags:
                    type: object
                    description: The order tags provided during order creation.
              customer_details:
                type: object
                properties:
                  customer_phone:
                    type: string
                    description: Customer phone number.
                  customer_email:
                    type: string
                    description: Customer email.
                  customer_name:
                    type: string
                    description: Customer name.
                  customer_id:
                    type: string
                    description: Customer's id.
                  customer_bank_account_number:
                    type: string
                    description: Customer bank account number.
                  customer_bank_code:
                    type: string
                    description: Customer bank code.
                  customer_bank_ifsc:
                    type: string
                    description: Customer bank ifsc.".
              payment_details:
                type: object
                properties:
                  payment_amount:
                    type: number
                    description: Payment amount captured.
                  payment_currency:
                    type: string
                    description: Payment Curreny type - INR.
                  bank_reference:
                    type: string
                    description: Unique transaction reference number of the payment.
                  payment_time:
                    type: string
                    description: Date and time when the payment was initiated.
                  payment_group:
                    type: string
                    description: Mode of the payment.
                  payment_service_charge:
                    type: number
                    description: Service charge applicable for the payment.
                  payment_service_tax:
                    type: number
                    description: Service tax applicable on the payment.
                  cf_payment_id:
                    type: string
                    description: Cashfree unique ID to identify a payment.
                  status:
                    type: string
                    description: Status of the Payment.
                  forex_conversion_handling_charge:
                    type: string
                    description: Forex Conversion Service Charge.
                  forex_conversion_handling_tax:
                    type: string
                    description: Forex Conversion Service Tax.
                  charges_currency:
                    type: string
                    description: Forex Charges Curreny type - INR.
              settlement_details:
                type: object
                properties:
                  cf_settlement_id:
                    type: string
                    description: Unique ID to identify the settlement.
                  settlement_date:
                    type: string
                    description: Date and time when the settlement was processed.
                  utr:
                    type: string
                    description: Unique transaction reference number of the settlement.
                  split_service_charge:
                    type: number
                    description: Service charge that is applicable for splitting the payment.
                  split_service_tax:
                    type: number
                    description: Service tax applicable for splitting the amount to vendors.
                  vendor_commission:
                    type: number
                    description: Vendor commission applicable for this transaction.
                  payment_from:
                    type: string
                    description: Date and time from settlement computed.
                  payment_till:
                    type: string
                    description: Date and time till settlement computed.
                  reason:
                    type: string
                    description: If any reason for settlement failure.
                  remarks:
                    type: string
                    description: Remarks related for settlement.
                  service_charge:
                    type: number
                    description: Service charge for the transactions.
                  service_tax:
                    type: number
                    description: Service tax for the transactions.
                  settlement_charge:
                    type: number
                    description: Settlement Service Charge.
                  settlement_initiated_on:
                    type: string
                    description: Date and time when Settlement initiated.
                  settlement_tax:
                    type: number
                    description: Settlement Service Tax.
                  settlement_type:
                    type: string
                    description: Type of Settlement, Example - Normal Settlement.
              dispute_details:
                type: object
                properties:
                  closed_in_favor_of:
                    type: string
                    description: Specifies whether the dispute was closed in favor of the merchant or customer. Possible values
                      - Merchant, Customer.
                  dispute_resolved_on:
                    type: string
                    description: Date and time when the dispute was resolved.
                  dispute_category:
                    type: string
                    description: Category of the dispute - Dispute code and the reason for dispute is shown.
                  dispute_note:
                    type: string
                    description: Note regarding the dispute.
              refund_details:
                type: object
                properties:
                  refund_processed_at:
                    type: string
                    description: Date and time when the refund was processed.
                  refund_arn:
                    type: string
                    description: The bank reference number for refund.
                  refund_note:
                    type: string
                    description: A refund note for your reference.
                  refund_id:
                    type: string
                    description: An unique ID associated with the refund.
    RefundEntity:
      title: RefundEntity
      description: A refund, with its amount, status, refund speed and bank reference number (ARN).
      type: object
      example:
        cf_payment_id: '918812'
        cf_refund_id: '1553338'
        refund_id: REF-123
        order_id: c6G-QMcbm1848
        entity: refund
        refund_amount: 100.81
        refund_currency: INR
        refund_note: 'Refund for order #123'
        refund_status: SUCCESS
        refund_type: MERCHANT_INITIATED
        refund_splits: []
        status_description: In Progress
        refund_arn: RF12312
        metadata:
          option: myotpion
        created_at: '2021-07-25T08:57:52+05:30'
        processed_at: '2021-07-25T12:57:52+05:30'
        refund_charge: 0
        refund_mode: STANDARD
        forex_conversion_handling_charge: 11.12
        forex_conversion_handling_tax: 1.12
        forex_conversion_rate: 84.24
        charges_currency: INR
      properties:
        cf_payment_id:
          type: string
          description: Cashfree ID of the payment for which refund is initiated.
        cf_refund_id:
          type: string
          description: Cashfree ID for a refund.
        order_id:
          type: string
          description: Merchant’s order Id of the order for which refund is initiated.
        refund_id:
          type: string
          description: Merchant’s refund ID of the refund.
        entity:
          type: string
          enum:
          - refund
          description: Type of object.
        refund_amount:
          type: number
          description: Amount that is refunded.
        refund_currency:
          type: string
          description: Currency of the refund amount.
        refund_note:
          type: string
          description: Note added by merchant for the refund.
        refund_status:
          type: string
          enum:
          - SUCCESS
          - PENDING
          - PENDING_APPROVAL
          - CANCELLED
          - ONHOLD
          - REJECTED
          description: >-
            The refund status can be one of the following: `SUCCESS`, `PENDING`,
            `PENDING_APPROVAL`, `CANCELLED`, `ONHOLD`, or `REJECTED`.
        refund_arn:
          type: string
          description: The bank reference number for refund.
        refund_charge:
          type: number
          description: Charges in INR for processing refund.
        status_description:
          type: string
          description: Description of refund status.
        metadata:
          type: object
          description: Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value
            pairs.
        refund_splits:
          type: array
          items:
            $ref: '#/components/schemas/VendorSplit'
        refund_type:
          type: string
          enum:
          - PAYMENT_AUTO_REFUND
          - MERCHANT_INITIATED
          - UNRECONCILED_AUTO_REFUND
          description: This can be one of ["PAYMENT_AUTO_REFUND", "MERCHANT_INITIATED", "UNRECONCILED_AUTO_REFUND"].
        refund_mode:
          type: string
          description: Method or speed of processing refund.
        created_at:
          type: string
          description: Time of refund creation.
        processed_at:
          type: string
          description: Time when refund was processed successfully.
        refund_speed:
          $ref: '#/components/schemas/RefundSpeed'
        forex_conversion_handling_charge:
          type: number
          description: Cashfree forex conversion charges for refund processing.
        forex_conversion_handling_tax:
          type: number
          description: Cashfree forex conversion tax for refund processing.
        forex_conversion_rate:
          type: number
          description: Cashfree forex conversion rate for refund processing.
        charges_currency:
          type: string
          description: Cashfree refund charges currency for a refund.
    RefundSpeed:
      title: RefundSpeed
      description: How fast refund has to be proecessed.
      type: object
      example:
        requested: STANDARD
        accepted: STANDARD
        processed: STANDARD
        message: Error message, if any
      properties:
        requested:
          type: string
          description: Requested speed of refund.
        accepted:
          type: string
          description: Accepted speed of refund.
        processed:
          type: string
          description: Processed speed of refund.
        message:
          type: string
          description: Error message, if any for refund_speed request.
    SavedInstrumentMeta:
      title: InstrumentMeta
      description: Card instrument meta information.
      type: object
      properties:
        card_network:
          type: string
          description: Card scheme/network of the saved card. Available options are `visa`, `mastercard`, `rupay`, `amex`,
            and `diners`.
        card_bank_name:
          type: string
          description: Issuing bank name of the saved card. For example, `HDFC BANK`, `AXIS BANK`, or `ICICI BANK`.
        card_country:
          type: string
          description: Issuing country of the saved card. For example, `IN`.
        card_type:
          type: string
          description: Type of the saved card. Available options are `credit_card`, `debit_card`, and `prepaid_card`.
        card_sub_type:
          type: string
          description: Subtype of the saved card. R indicates retail, P indicates premium, and C indicates corporate. Available
            options are `R`, `P`, and `C`.
        card_token_details:
          type: object
          description: Card token information.
          properties:
            par:
              type: string
              description: The [PAR (Primary Account Reference)](https://www.cashfree.com/docs/payments/features/payment-account-reference)
                for the plain card.
            expiry_month:
              type: string
              description: Token expiry month.
            expiry_year:
              type: string
              description: Token expiry year.
    SchemeArray:
      title: Scheme array
      type: string
      example: visa
      description: array of card schemes like visa, master etc.
    EmptyObject:
      type: object
      additionalProperties: false
    SettlementEntity:
      title: SettlementsEntity
      description: Settlement entity object.
      type: object
      example:
        cf_payment_id: '553338'
        order_id: order-12-127
        entity: settlement
        order_amount: 100
        payment_time: '2021-07-13T13:13:59+05:30'
        service_charge: 10
        service_tax: 1.8
        settlement_amount: 88.2
        cf_settlement_id: '6121238'
        transfer_id: 238
        transfer_time: '2021-07-25T12:57:52+05:30'
        transfer_utr: N87912312
        order_currency: INR
        settlement_currency: INR
        forex_conversion_handling_charge: 11.12
        forex_conversion_handling_tax: 1.12
        forex_conversion_rate: 84.24
        charges_currency: INR
      properties:
        cf_payment_id:
          type: string
        cf_settlement_id:
          type: string
        settlement_currency:
          type: string
        order_id:
          type: string
        entity:
          type: string
        order_amount:
          type: number
        payment_time:
          type: string
        service_charge:
          type: number
        service_tax:
          type: number
        settlement_amount:
          type: number
        settlement_id:
          type: integer
        transfer_id:
          type: integer
        transfer_time:
          type: string
        transfer_utr:
          type: string
        forex_conversion_handling_charge:
          type: number
          description: Cashfree forex conversion charges for refund processing.
        forex_conversion_handling_tax:
          type: number
          description: Cashfree forex conversion tax for refund processing.
        forex_conversion_rate:
          type: number
          description: Cashfree forex conversion rate for refund processing.
        charges_currency:
          type: string
          description: Cashfree refund charges currency for a refund.
    GetAllSettlementsResponse:
      title: GetAllSettlementsResponse
      description: A paginated list of settlements, with their status, unique transaction reference (UTR), amounts, charges and taxes.
      type: object
      example:
        cursor: null
        limit: 2
        data:
        - cf_settlement_id: '312048765'
          status: SUCCESS
          status_description: The settlement amount has been credited to your bank account.
          settlement_utr: CB0312048765
          payment_from: '2026-01-05T10:22:14+05:30'
          payment_till: '2026-01-18T08:47:52+05:30'
          settlement_initiated_on: '2026-01-20T09:15:22+05:30'
          settlement_processed_on: '2026-01-20T09:15:22+05:30'
          payment_amount: 1000.00
          pg_service_charge: 0.00
          pg_service_tax: 0.00
          adjustment: -100.00
          settlement_charge: 0.00
          settlement_tax: 0.00
          split_service_charge: 0.00
          split_service_tax: 0.00
          vendor_commission: 0.00
          amount_settled: 900.00
          charge_type: PREPAID
          settlement_type: NORMAL_SETTLEMENT
        - cf_settlement_id: '489271036'
          status: PENDING_WITH_BANK
          status_description: The settlement has been processed by Cashfree's partner bank and is waiting for a credit confirmation from your bank.
          settlement_utr: CB0489271036
          payment_from: '2026-01-05T10:22:14+05:30'
          payment_till: '2026-01-18T08:47:52+05:30'
          settlement_initiated_on: '2026-01-21T11:30:05+05:30'
          settlement_processed_on: ''
          payment_amount: 1000.00
          pg_service_charge: 0.00
          pg_service_tax: 0.00
          adjustment: -100.00
          settlement_charge: 0.00
          settlement_tax: 0.00
          split_service_charge: 0.00
          split_service_tax: 0.00
          vendor_commission: 0.00
          amount_settled: 900.00
          charge_type: PREPAID
          settlement_type: NORMAL_SETTLEMENT
      properties:
        cursor:
          type: string
          nullable: true
          description: Cursor for the next set of settlements. Pass this value in the next API call to fetch the next page. Null if there are no more settlements.
        data:
          type: array
          items:
            type: object
            properties:
              cf_settlement_id:
                type: string
                description: Unique ID to identify the settlement.
              status:
                type: string
                enum:
                - SUCCESS
                - PENDING
                - PENDING_WITH_CASHFREE
                - PENDING_WITH_BANK
                - FAILED
                description: Status of the settlement.
              status_description:
                type: string
                description: Human-readable description of the settlement status.
              settlement_utr:
                type: string
                description: Unique transaction reference number of the settlement.
              payment_from:
                type: string
                description: Start of the payment period included in this settlement.
              payment_till:
                type: string
                description: End of the payment period included in this settlement.
              settlement_initiated_on:
                type: string
                description: Date and time when the settlement was initiated.
              settlement_processed_on:
                type: string
                description: Date and time when the settlement was processed.
              payment_amount:
                type: number
                default: 0.00
                description: Net amount of transactions that was a part of this settlement.
              pg_service_charge:
                type: number
                default: 0.00
                description: PG service charges that were deducted in this settlement.
              pg_service_tax:
                type: number
                default: 0.00
                description: PG service taxes that were deducted in this settlement.
              adjustment:
                type: number
                default: 0.00
                description: Adjustments that were a part of this settlement.
              settlement_charge:
                type: number
                default: 0.00
                description: Settlement charges that were deducted in this settlement.
              settlement_tax:
                type: number
                default: 0.00
                description: Settlement taxes that were deducted in this settlement.
              split_service_charge:
                type: number
                default: 0.00
                description: Split service charges that were deducted in this settlement.
              split_service_tax:
                type: number
                default: 0.00
                description: Split service taxes that were deducted in this settlement.
              vendor_commission:
                type: number
                default: 0.00
                description: Vendor commission/split that was deducted in this settlement.
              amount_settled:
                type: number
                default: 0.00
                description: Amount that was settled to the merchant's bank account.
              charge_type:
                type: string
                enum:
                - PREPAID
                - POSTPAID
                - SURCHARGE
                - PREPAID_SURCHARGE
                - POSTPAID_SURCHARGE
                description: Indicates how Cashfree's service charges are applied for this settlement.
              settlement_type:
                type: string
                description: Type of settlement. Example - NORMAL_SETTLEMENT.
        limit:
          type: integer
          description: Number of settlement records returned in this response.
    OrderSettlementEntity:
      title: OrderSettlementEntity
      description: Settlement details for an order, with its order, payment, customer and settlement information.
      type: object
      example:
        order_details:
          order_amount: 500.00
          order_currency: INR
          order_id: CFPay_Xb19fzpqm1y5_AAAAAAAXpZ7_c1e452f9_ort8b920413_1882957022547
          order_tags:
            cf_link_id: '291437504'
        payment_details:
          cf_payment_id: '6183934088'
          payment_time: '2026-01-15T10:24:37+05:30'
          payment_currency: INR
          payment_amount: 500.00
          pg_service_charge: 0.00
          pg_service_tax: 0.00
          split_service_charge: 0.00
          split_service_tax: 0.00
          surcharge: 0.00
          tax_on_surcharge: 0.0000
          charges_currency: INR
          forex_conversion_handling_charge: 0.00
          forex_conversion_handling_tax: 0.00
          forex_conversion_rate: 0.00
          vendor_commission: 0.00
          settlement_amount: 475.00
          charge_type: PREPAID
          charged_to: MERCHANT
        customer_details:
          customer_id: customer_001
          customer_name: Rahul Kumar
          customer_phone: '+918765432190'
          customer_email: null
        settlement_details:
          cf_settlement_id: '312048765'
          status: SUCCESS
          status_description: The settlement amount has been credited to your bank account.
          settlement_utr: CB0312048765
          settlement_initiated_on: '2026-01-20T09:15:22+05:30'
          settlement_processed_on: '2026-01-20T09:15:22+05:30'
          settlement_currency: INR
          settlement_type: NORMAL_SETTLEMENT
      properties:
        order_details:
          type: object
          properties:
            order_id:
              type: string
              description: Unique order ID.
            order_amount:
              type: number
              description: The amount which was passed at the order creation time.
            order_currency:
              type: string
              description: Currency of the order.
            order_tags:
              type: object
              description: The order tags provided during order creation.
        payment_details:
          type: object
          properties:
            cf_payment_id:
              type: string
              description: Cashfree unique ID to identify the payment.
            payment_time:
              type: string
              description: Date and time when the transaction was completed.
            payment_currency:
              type: string
              description: Currency of the payment.
            payment_amount:
              type: number
              default: 0.00
              description: Net amount of the transaction that was a part of this settlement.
            pg_service_charge:
              type: number
              default: 0.00
              description: PG service charges that were deducted in this settlement.
            pg_service_tax:
              type: number
              default: 0.00
              description: PG service taxes that were deducted in this settlement.
            split_service_charge:
              type: number
              default: 0.00
              description: Split service charges that were deducted in this settlement.
            split_service_tax:
              type: number
              default: 0.00
              description: Split service taxes that were deducted in this settlement.
            surcharge:
              type: number
              default: 0.00
              description: Surcharge collected from the customer.
            tax_on_surcharge:
              type: number
              default: 0.00
              description: Tax on surcharge. Upto 4 decimal points.
            charges_currency:
              type: string
              description: Currency in which service charges are applied.
            forex_conversion_handling_charge:
              type: number
              default: 0.00
              description: Forex conversion handling charge.
            forex_conversion_handling_tax:
              type: number
              default: 0.00
              description: Forex conversion handling tax.
            forex_conversion_rate:
              type: number
              default: 0.00
              description: Forex conversion rate applied.
            vendor_commission:
              type: number
              default: 0.00
              description: Vendor commission/split that was deducted in this settlement.
            settlement_amount:
              type: number
              default: 0.00
              description: Amount after deducting all charges.
            charge_type:
              type: string
              enum:
              - PREPAID
              - POSTPAID
              - SURCHARGE
              - PREPAID_SURCHARGE
              - POSTPAID_SURCHARGE
              description: Indicates how Cashfree's service charges are applied for this payment.
            charged_to:
              type: string
              enum:
              - MERCHANT
              - CUSTOMER
              - MERCHANT_AND_CUSTOMER
              - VENDOR
              description: Indicates who bears Cashfree's service charges.
        customer_details:
          type: object
          properties:
            customer_id:
              type: string
              description: Unique ID of the customer.
            customer_name:
              type: string
              description: Name of the customer.
            customer_phone:
              type: string
              description: Phone number of the customer.
            customer_email:
              type: string
              nullable: true
              description: Email address of the customer.
        settlement_details:
          type: object
          properties:
            cf_settlement_id:
              type: string
              description: Unique ID to identify the settlement.
            status:
              type: string
              enum:
              - SUCCESS
              - PENDING
              - PENDING_WITH_CASHFREE
              - PENDING_WITH_BANK
              - FAILED
              description: Status of the linked settlement.
            status_description:
              type: string
              description: Human-readable description of the settlement status.
            settlement_utr:
              type: string
              description: Unique transaction reference number of the settlement.
            settlement_initiated_on:
              type: string
              description: Date and time when the settlement was initiated.
            settlement_processed_on:
              type: string
              description: Date and time when the settlement was processed.
            settlement_currency:
              type: string
              description: Currency of the settlement.
            settlement_type:
              type: string
              description: Type of settlement. Example - NORMAL_SETTLEMENT.
    MarkOrderSettlementResponse:
      title: MarkOrderSettlementResponse
      description: An order marked for settlement, with its order ID and metadata.
      type: object
      example:
        order_id: order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H
        meta_data:
          cbriks_id: CBRIKS_004
          settlement_date: '2026-04-12'
      properties:
        order_id:
          type: string
          description: The order ID that was marked for settlement.
        meta_data:
          type: object
          properties:
            cbriks_id:
              type: string
              description: CBRIKS ID used for reporting purposes.
            settlement_date:
              type: string
              format: date
              description: The settlement date recorded in the system.
    VendorBalance:
      title: VendorBalance
      description: Unsettled balances for a merchant and a vendor.
      type: object
      properties:
        merchant_id:
          type: number
        vendor_id:
          type: string
        merchant_unsettled:
          type: number
        vendor_unsettled:
          type: number
    VendorBalanceTransferCharges:
      title: VendorBalanceTransferCharges
      description: Charges for a vendor balance transfer, with the amount, service charges, service tax and who is billed.
      type: object
      properties:
        service_charges:
          type: number
          format: float64
        service_tax:
          type: number
          format: float64
        amount:
          type: number
          format: float64
        billed_to:
          type: string
        is_postpaid:
          type: boolean
    DisputesEntity:
      title: DisputesEntity
      description: A dispute, with its type, reason, amount, status, response deadline and evidence.
      type: object
      example:
        dispute_id: 433447817
        dispute_type: DISPUTE
        reason_code: 1401
        reason_description: Fraud Transaction
        dispute_amount: 10.0
        dispute_amount_currency: INR
        created_at: '2023-01-18T11:26:58'
        respond_by: '2023-01-19T00:00:00'
        updated_at: '2023-01-18T11:26:58'
        resolved_at: '9999-09-09T00:00:00'
        dispute_status: DISPUTE_DOCS_RECEIVED
        cf_dispute_remarks: Load Testing
        preferred_evidence:
        - document_type: Delivery/Service Proof
          document_description: Proof that the cardholder/customer received the goods or services.
        dispute_evidence:
        - document_id: 18150
          document_name: disputeSampleFile.pdf
          document_type: DeliveryProof
        order_details:
          order_id: Load_test_0103_FGA4HF12AC
          order_currency: INR
          order_amount: 10.0
          cf_payment_id: 1489901523
          payment_currency: INR
          payment_amount: 10.0
        customer_details:
          customer_name: John Ellur
          customer_phone: 9876543210
          customer_email: john@cashfree.com
      properties:
        dispute_id:
          type: integer
        dispute_type:
          type: string
          enum:
          - DISPUTE
          - CHARGEBACK
          - RETRIEVAL
          - PRE_ARBITRATION
          - ARBITRATION
        reason_code:
          type: string
        reason_description:
          type: string
        dispute_amount:
          type: number
          description: Dispute amount may differ from transaction amount for partial cases.
        dispute_amount_currency:
          type: string
          description: Dispute amount currency for a dispute.
        created_at:
          type: string
          description: This is the time when the dispute was created.
        respond_by:
          type: string
          description: This is the time by which evidence should be submitted to contest the dispute.
        updated_at:
          type: string
          description: This is the time when the dispute case was updated.
        resolved_at:
          type: string
          description: This is the time when the dispute case was closed.
        dispute_status:
          type: string
          enum:
          - DISPUTE_CREATED
          - DISPUTE_DOCS_RECEIVED
          - DISPUTE_UNDER_REVIEW
          - DISPUTE_MERCHANT_WON
          - DISPUTE_MERCHANT_LOST
          - DISPUTE_MERCHANT_ACCEPTED
          - DISPUTE_INSUFFICIENT_EVIDENCE
          - CHARGEBACK_CREATED
          - CHARGEBACK_DOCS_RECEIVED
          - CHARGEBACK_UNDER_REVIEW
          - CHARGEBACK_MERCHANT_WON
          - CHARGEBACK_MERCHANT_LOST
          - CHARGEBACK_MERCHANT_ACCEPTED
          - CHARGEBACK_INSUFFICIENT_EVIDENCE
          - RETRIEVAL_CREATED
          - RETRIEVAL_DOCS_RECEIVED
          - RETRIEVAL_UNDER_REVIEW
          - RETRIEVAL_MERCHANT_WON
          - RETRIEVAL_MERCHANT_LOST
          - RETRIEVAL_MERCHANT_ACCEPTED
          - RETRIEVAL_INSUFFICIENT_EVIDENCE
          - PRE_ARBITRATION_CREATED
          - PRE_ARBITRATION_DOCS_RECEIVED
          - PRE_ARBITRATION_UNDER_REVIEW
          - PRE_ARBITRATION_MERCHANT_WON
          - PRE_ARBITRATION_MERCHANT_LOST
          - PRE_ARBITRATION_MERCHANT_ACCEPTED
          - PRE_ARBITRATION_INSUFFICIENT_EVIDENCE
          - ARBITRATION_CREATED
          - ARBITRATION_DOCS_RECEIVED
          - ARBITRATION_CONTEST_REQUESTED
          - ARBITRATION_UNDER_REVIEW
          - ARBITRATION_MERCHANT_WON
          - ARBITRATION_MERCHANT_LOST
          - ARBITRATION_MERCHANT_ACCEPTED
          - ARBITRATION_INSUFFICIENT_EVIDENCE
        cf_dispute_remarks:
          type: string
        preferred_evidence:
          $ref: '#/components/schemas/PreferredEvidence'
        dispute_evidence:
          $ref: '#/components/schemas/DisputeEvidence'
        order_details:
          $ref: '#/components/schemas/OrderDetailsInDisputesEntity'
        customer_details:
          $ref: '#/components/schemas/CustomerDetailsInDisputesEntity'
    DisputesEntityMerchantAccepted:
      title: DisputesEntityMerchantAccepted
      description: An accepted dispute, with its type, reason, amount and status.
      type: object
      example:
        dispute_id: 433447817
        dispute_type: DISPUTE
        reason_code: 1401
        reason_description: Fraud Transaction
        dispute_amount: 10.0
        created_at: '2023-01-18T11:26:58'
        respond_by: '2023-01-19T00:00:00'
        updated_at: '2023-01-18T11:26:58'
        resolved_at: '2023-01-18T11:26:58'
        dispute_status: DISPUTE_MERCHANT_ACCEPTED
        cf_dispute_remarks: Load Testing
        preferred_evidence: []
        dispute_evidence: []
        order_details:
          order_id: Load_test_0103_FGA4HF12AC
          order_currency: INR
          order_amount: 10.0
          cf_payment_id: 1489901523
          payment_currency: INR
          payment_amount: 10.0
        customer_details:
          customer_name: John Ellur
          customer_phone: 8281554863
          customer_email: john@cashfree.com
      properties:
        dispute_id:
          type: integer
        dispute_type:
          type: string
          enum:
          - DISPUTE
          - CHARGEBACK
          - RETRIEVAL
          - PRE_ARBITRATION
          - ARBITRATION
        reason_code:
          type: string
        reason_description:
          type: string
        dispute_amount:
          type: number
          description: Dispute amount may differ from transaction amount for partial cases.
        created_at:
          type: string
          description: This is the time when the dispute was created.
        respond_by:
          type: string
          description: This is the time by which evidence should be submitted to contest the dispute.
        updated_at:
          type: string
          description: This is the time when the dispute case was updated.
        resolved_at:
          type: string
          description: This is the time when the dispute case was closed.
        dispute_status:
          type: string
          enum:
          - DISPUTE_CREATED
          - DISPUTE_DOCS_RECEIVED
          - DISPUTE_UNDER_REVIEW
          - DISPUTE_MERCHANT_WON
          - DISPUTE_MERCHANT_LOST
          - DISPUTE_MERCHANT_ACCEPTED
          - DISPUTE_INSUFFICIENT_EVIDENCE
          - CHARGEBACK_CREATED
          - CHARGEBACK_DOCS_RECEIVED
          - CHARGEBACK_UNDER_REVIEW
          - CHARGEBACK_MERCHANT_WON
          - CHARGEBACK_MERCHANT_LOST
          - CHARGEBACK_MERCHANT_ACCEPTED
          - CHARGEBACK_INSUFFICIENT_EVIDENCE
          - RETRIEVAL_CREATED
          - RETRIEVAL_DOCS_RECEIVED
          - RETRIEVAL_UNDER_REVIEW
          - RETRIEVAL_MERCHANT_WON
          - RETRIEVAL_MERCHANT_LOST
          - RETRIEVAL_MERCHANT_ACCEPTED
          - RETRIEVAL_INSUFFICIENT_EVIDENCE
          - PRE_ARBITRATION_CREATED
          - PRE_ARBITRATION_DOCS_RECEIVED
          - PRE_ARBITRATION_UNDER_REVIEW
          - PRE_ARBITRATION_MERCHANT_WON
          - PRE_ARBITRATION_MERCHANT_LOST
          - PRE_ARBITRATION_MERCHANT_ACCEPTED
          - PRE_ARBITRATION_INSUFFICIENT_EVIDENCE
          - ARBITRATION_CREATED
          - ARBITRATION_DOCS_RECEIVED
          - ARBITRATION_CONTEST_REQUESTED
          - ARBITRATION_UNDER_REVIEW
          - ARBITRATION_MERCHANT_WON
          - ARBITRATION_MERCHANT_LOST
          - ARBITRATION_MERCHANT_ACCEPTED
          - ARBITRATION_INSUFFICIENT_EVIDENCE
        cf_dispute_remarks:
          type: string
        preferred_evidence:
          $ref: '#/components/schemas/PreferredEvidence'
        dispute_evidence:
          $ref: '#/components/schemas/DisputeEvidence'
        order_details:
          $ref: '#/components/schemas/OrderDetailsInDisputesEntity'
        customer_details:
          $ref: '#/components/schemas/CustomerDetailsInDisputesEntity'
    OrderDetailsInDisputesEntity:
      title: OrderDetailsInDisputesEntity
      example:
        order_id: Load_test_0103_FGA4HF12AC
        order_currency: INR
        order_amount: 10.0
        cf_payment_id: 1489901523
        payment_currency: INR
        payment_amount: 10.0
      type: object
      properties:
        order_id:
          type: string
        order_currency:
          type: string
        order_amount:
          type: number
        cf_payment_id:
          type: string
        payment_currency:
          type: string
        payment_amount:
          type: number
    CustomerDetailsInDisputesEntity:
      title: CustomerDetailsInDisputesEntity
      example:
        customer_name: Manideep Ellur
        customer_phone: 8281554863
        customer_email: manideep.ellur@cashfree.com
      type: object
      properties:
        customer_name:
          type: string
        customer_phone:
          type: string
        customer_email:
          type: string
    PreferredEvidence:
      title: EvidencesToContestDispute
      type: array
      example:
        preferred_evidence:
        - document_type: Delivery/Service Proof
          document_description: Proof that the cardholder/customer received the goods or services.
        - document_type: Statement of Service
          document_description: Account Statement of wallet where funds were loaded by customer.
      items:
        $ref: '#/components/schemas/EvidencesToContestDispute'
    DisputeEvidence:
      title: DisputeEvidence
      example:
      - document_id: 18150
        document_name: disputeSampleFile.pdf
        document_type: DeliveryProof
      type: array
      items:
        $ref: '#/components/schemas/Evidence'
    Evidence:
      title: Evidence
      example:
        document_id: 18150
        document_name: disputeSampleFile.pdf
        document_type: DeliveryProof
      type: object
      properties:
        document_id:
          type: integer
        document_name:
          type: string
        document_type:
          type: string
    EvidencesToContestDispute:
      title: EvidencesToContestDispute
      example:
        preferred_evidence:
        - document_type: Delivery/Service Proof
          document_description: Proof that the cardholder/customer received the goods or services.
        - document_type: Statement of Service
          document_description: Account Statement of wallet where funds were loaded by customer.
      type: object
      properties:
        document_type:
          type: string
        document_description:
          type: string
    VendorEntity:
      title: VendorEntity
      description: A vendor, with its contact details, status, bank or UPI details, settlement schedule and related documents.
      type: object
      example:
        email: johndoe@cashfree.com
        status: IN_BENE_CREATION
        phone: 9876543210
        name: customer
        vendor_id: johntest11111
        added_on: '2023-03-02 12:12:56'
        updated_on: '2023-03-02 12:12:57'
        bank:
          account_number: 0123456111110
          account_holder: JOHNDOE
          ifsc: YESB0000262
        upi: null
        schedule_option:
          settlement_schedule_message: T+1 settlement at 11:00 AM
          schedule_id: 1
          merchant_default: true
        vendor_type: PG
        account_type: BUSINESS
        business_type: NBFC
        remarks: Invalid bank account
        related_docs:
        - vendor_id: johntest11111
          doc_type: CIN_NUMBER
          doc_value: L00000Aa0000AaA000000
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: GSTIN_NUMBER
          doc_value: 11AAAAA1111A1Z0
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: PAN_NUMBER
          doc_value: BIAPA2934N
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: PASSPORT_NUMBER
          doc_value: L6892603
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: UIDAI_NUMBER
          doc_value: 753624181019
          status: IN_REVIEW
          remarks: null
      properties:
        email:
          type: string
        status:
          type: string
        phone:
          type: string
        name:
          type: string
        vendor_id:
          type: string
        added_on:
          type: string
        updated_on:
          type: string
        bank:
          $ref: '#/components/schemas/BankDetails'
        upi:
          type: string
        schedule_option:
          $ref: '#/components/schemas/ScheduleOption'
        vendor_type:
          type: string
        account_type:
          type: string
        business_type:
          type: string
        remarks:
          type: string
        related_docs:
          type: array
          items:
            type: object
            properties:
              vendor_id:
                type: string
              doc_type:
                type: string
              doc_value:
                type: string
              status:
                type: string
              remarks:
                type: string
    VendorDocumentsResponse:
      title: VendorDocumentsResponse
      description: The documents uploaded for a vendor, with the type, value and status of each.
      type: object
      properties:
        documents:
          type: array
          items:
            type: object
            properties:
              vendor_id:
                type: string
              doc_type:
                type: string
              doc_value:
                type: string
              status:
                type: string
              remarks:
                type: string
    VendorDocumentDownloadResponse:
      title: VendorDocumentDownloadResponse
      description: A download URL for a vendor document.
      type: object
      properties:
        download_url:
          type: string
    UploadVendorDocumentsResponse:
      title: UploadVendorDocumentsResponse
      description: A document uploaded for a vendor, with its type, value, status and remarks.
      type: object
      properties:
        vendor_id:
          type: string
        doc_type:
          type: string
        doc_value:
          type: string
        status:
          type: string
        remarks:
          type: string
    StaticSplitResponse:
      title: StaticSplitResponse
      description: A static split configuration, with its split scheme, product type and terminal details.
      type: object
      properties:
        active:
          type: boolean
        terminal_id:
          type: string
        terminal_reference_id:
          type: number
        product_type:
          type: string
        scheme:
          type: array
          items:
            type: object
            properties:
              merchantVendorId:
                type: string
              percentage:
                type: string
        added_on:
          type: string
    ESOrderReconResponse:
      title: ESOrderReconResponse
      description: A paginated list of split and settlement details for orders.
      type: object
      properties:
        cursor:
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              amount:
                type: number
                format: float64
              settlement_eligibility_time:
                type: string
              status:
                type: string
              merchant_order_id:
                type: string
              tx_time:
                type: string
              settled:
                type: string
              entity_id:
                type: string
              merchant_settlement_utr:
                type: string
              currency:
                type: string
              sale_type:
                type: string
              customer_name:
                type: string
              customer_email:
                type: string
              customer_phone:
                type: string
              merchant_vendor_commission:
                type: string
              split_service_charge:
                type: string
              split_service_tax:
                type: string
              pg_service_tax:
                type: string
              pg_service_charge:
                type: string
              pg_charge_postpaid:
                type: string
              merchant_settlement_id:
                type: string
              added_on:
                type: string
              tags:
                type: string
              entity_type:
                type: string
              settlement_initiated_on:
                type: string
              settlement_time:
                type: string
              order_splits:
                type: array
                items:
                  type: object
                  properties:
                    split:
                      type: array
                      items:
                        type: object
                        properties:
                          merchant_vendor_id:
                            type: string
                          percentage:
                            type: number
                            format: float64
                          tags:
                            type: object
                    created_at:
                      type: string
              eligible_split_balance:
                type: string
        limit:
          type: integer
    SplitOrderReconSuccessResponse:
      title: SplitOrderReconSuccessResponse
      description: Split and settlement details for an order, including its settlement, refunds and vendor splits.
      type: object
      properties:
        settlement:
          type: object
          description: Details of the settlement information.
          properties:
            entity:
              type: string
              description: 'Type of entity. Example: "settlement".'
            cf_settlement_id:
              type: integer
              format: int64
              description: Unique Cashfree settlement ID.
            cf_payment_id:
              type: integer
              format: int64
              description: Unique Cashfree payment ID associated with the order.
            order_id:
              type: string
              description: Unique identifier for the order.
            order_currency:
              type: string
              description: 'Currency of the order. Example: "INR".'
            transfer_id:
              type: string
              nullable: true
              description: Unique transfer ID if available, otherwise null.
            order_amount:
              type: number
              format: float64
              description: Total amount of the order.
            service_charge:
              type: number
              format: float64
              description: Service charge for the order.
            service_tax:
              type: number
              format: float64
              description: Service tax for the order.
            settlement_amount:
              type: number
              format: float64
              description: Amount to be settled after charges and tax.
            settlement_currency:
              type: string
              description: 'Currency of the settlement. Example: "INR".'
            transfer_utr:
              type: string
              nullable: true
              description: UTR (Unique Transaction Reference) for the transfer if available, otherwise null.
            transfer_time:
              type: string
              nullable: true
              description: Time of transfer if available, otherwise null.
            payment_time:
              type: string
              description: Timestamp when payment was made.
        refunds:
          type: array
          items:
            type: object
          description: List of refunds associated with the order, if any.
        vendors:
          type: array
          description: List of vendor settlements associated with the split settlement.
          items:
            type: object
            properties:
              vendor_id:
                type: string
                description: Unique identifier for the vendor.
              settlement_id:
                type: integer
                format: int64
                description: Settlement ID associated with the vendor.
              settlement_amount:
                type: number
                format: float64
                description: Settlement amount allocated to the vendor.
              settlement_eligibility_date:
                type: string
                description: Date and time when the vendor is eligible for the settlement.
    SimulationResponse:
      title: SimulationResponse
      description: A payment simulation, with its simulation ID and the simulated payment status and error code.
      type: object
      example:
        simulation_id: sim_2900842gV18Lhh7owswLj5XF0uHHUn1CX
        entity: PAYMENTS
        entity_id: '14934289844'
        entity_simulation:
          payment_status: FAILED
          payment_error_code: ISSUER_NOT_AVAILABLE
      properties:
        simulation_id:
          type: string
        entity:
          type: string
        entity_id:
          type: string
        entity_simulation:
          $ref: '#/components/schemas/EntitySimulationResponse'
    SettlementSimulationResponse:
      title: SettlementSimulationResponse
      description: A settlement simulation, with its simulation ID, settlement IDs and status.
      type: object
      example:
        simulation_id: sim_103332852xk16dlG9zsoySmOVWTUW2t7FDv
        entity: SETTLEMENTS
        settlement_ids:
        - '14934289844'
        simulation_status: SUCCESS
      properties:
        simulation_id:
          type: string
          description: A unique identifier for the simulation request.
        entity:
          type: string
          description: 'Entity type for which the simulation is performed. Example: "SETTLEMENTS".'
        settlement_ids:
          type: array
          description: List of simulated settlement IDs.
          items:
            type: number
        simulation_status:
          type: string
          description: 'Status of the simulation request. Possible values are `SUCCESS`, `FAILED` and `PENDING`.'
    VendorSettlementSimulationResponse:
      title: VendorSettlementSimulationResponse
      description: An Easy Split vendor settlement simulation, with its simulation ID, payout IDs and status.
      type: object
      example:
        simulation_id: sim_103332852xk16dlG9zsoySmOVWTUW2t7FDv
        entity: VENDOR_SETTLEMENTS
        payout_ids:
        - 14934289844
        simulation_status: SUCCESS
      properties:
        simulation_id:
          type: string
          description: A unique identifier for the simulation request.
        entity:
          type: string
          description: 'Entity type for which the simulation is performed. Example: "VENDOR_SETTLEMENTS".'
        payout_ids:
          type: array
          description: List of simulated vendor payout IDs.
          items:
            type: number
        simulation_status:
          type: string
          description: 'Status of the simulation request. Possible values are `INITIATED`, `SUCCESS` and `FAILED`.'
    EasySplitSandboxStatusResponse:
      title: EasySplitSandboxStatusResponse
      description: Current Easy Split configuration for the merchant in the sandbox environment.
      type: object
      example:
        status: ACTIVE
        on_demand_enabled: true
        static_split_enabled: true
        vpa_enabled: true
        vendor_dashboard_enabled: false
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - HOLD
          - NOT_ACTIVE
          - RISK_APPROVAL_PENDING
          - RISK_REJECTED
          description: Easy Split status for the merchant. Poll this API until the status is `ACTIVE` before you create orders
            with a vendor split. If the status does not reach `ACTIVE` within a few minutes of calling Enable Easy Split in
            Sandbox, raise a request through the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1).
        on_demand_enabled:
          type: boolean
          description: Whether on-demand vendor settlement is enabled for the merchant.
        static_split_enabled:
          type: boolean
          description: Whether static split configuration is enabled for the merchant.
        vpa_enabled:
          type: boolean
          description: Whether vendor VPA payouts are enabled for the merchant.
        vendor_dashboard_enabled:
          type: boolean
          description: Whether vendor dashboard access is enabled for the merchant.
    SplitAfterPaymentResponse:
      title: SplitAfterPaymentResponse
      description: The status of a split request, with a message.
      type: object
      properties:
        status:
          type: string
        message:
          type: string
    AdjustVendorBalanceResponse:
      title: AdjustVendorBalanceResponse
      description: An on-demand transfer, with its settlement ID, transfer details, updated balances and charges.
      type: object
      properties:
        settlement_id:
          type: number
        transfer_details:
          $ref: '#/components/schemas/TransferDetails'
        balances:
          $ref: '#/components/schemas/BalanceDetails'
        charges:
          $ref: '#/components/schemas/ChargesDetails'
    VendorAdjustmentSuccessResponse:
      title: VendorAdjustmentSuccessResponse
      description: The status of a vendor adjustment, with a message.
      type: object
      properties:
        message:
          type: string
        status:
          type: string
    CreateVendorResponse:
      title: CreateVendorResponse
      description: A new vendor, with its contact details, status, bank or UPI details, KYC details and settlement schedule.
      type: object
      example:
        email: johndoe@cashfree.com
        status: IN_BENE_CREATION
        bank:
          account_number: 0123456111110
          account_holder: JOHNDOE
          ifsc: YESB0000262
        upi: []
        phone: 9876543210
        name: customer
        vendor_id: TestAccount11
        schedule_option:
          settlement_schedule_message: T+1 settlement at 11:00 AM
          schedule_id: 1
          merchant_default: true
        kyc_details:
          account_type: BUSINESS
          business_type: NBFC
          uidai: 753624181019
          gst: 11AAAAA1111A1Z0
          cin: L00000Aa0000AaA000000
          pan: BIAPA2934N
          passport_number: L6892603
        dashboard_access: false
        bank_details: null
      properties:
        email:
          type: string
        status:
          type: string
        bank:
          $ref: '#/components/schemas/BankDetails'
        upi:
          type: string
        phone:
          type: number
        name:
          type: string
        vendor_id:
          type: string
        schedule_option:
          $ref: '#/components/schemas/ScheduleOption'
        kyc_details:
          $ref: '#/components/schemas/KycDetails'
        dashboard_access:
          type: boolean
        bank_details:
          type: string
    UpdateVendorResponse:
      title: UpdateVendorResponse
      description: An updated vendor, with its contact details, status, bank or UPI details, KYC details and settlement schedule.
      type: object
      example:
        email: johndoe@cashfree.com
        status: IN_BENE_CREATION
        bank:
          account_number: 0123456111110
          account_holder: JOHNDOE
          ifsc: YESB0000262
        upi: []
        phone: 9876543210
        name: customer
        vendor_id: TestAccount11
        schedule_option:
          settlement_schedule_message: T+1 settlement at 11:00 AM
          schedule_id: 1
          merchant_default: true
        kyc_details:
          account_type: BUSINESS
          business_type: NBFC
          uidai: 753624181019
          gst: 11AAAAA1111A1Z0
          cin: L00000Aa0000AaA000000
          pan: BIAPA2934N
          passport_number: L6892603
        dashboard_access: false
        bank_details: null
        related_docs:
        - vendor_id: johntest11111
          doc_type: CIN_NUMBER
          doc_value: L00000Aa0000AaA000000
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: GSTIN_NUMBER
          doc_value: 11AAAAA1111A1Z0
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: PAN_NUMBER
          doc_value: BIAPA2934N
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: PASSPORT_NUMBER
          doc_value: L6892603
          status: IN_REVIEW
          remarks: null
        - vendor_id: johntest11111
          doc_type: UIDAI_NUMBER
          doc_value: 753624181019
          status: IN_REVIEW
          remarks: null
      properties:
        email:
          type: string
        status:
          type: string
        bank:
          $ref: '#/components/schemas/BankDetails'
        upi:
          type: string
        added_on:
          type: string
        updated_on:
          type: string
        vendor_type:
          type: string
        account_type:
          type: string
        business_type:
          type: string
        phone:
          type: number
        name:
          type: string
        vendor_id:
          type: string
        schedule_option:
          $ref: '#/components/schemas/ScheduleOption'
        kyc_details:
          $ref: '#/components/schemas/KycDetails'
        dashboard_access:
          type: boolean
        bank_details:
          type: string
        related_docs:
          type: array
          items:
            type: object
            properties:
              vendor_id:
                type: string
              doc_type:
                type: string
              doc_value:
                type: string
              status:
                type: string
              remarks:
                type: string
    CreateVendorRequest:
      title: CreateVendorRequest
      description: Request body to create a vendor.
      type: object
      example:
        vendor_id: vendortest123
        status: ACTIVE
        name: customer
        email: johndoe@cashfree.com
        phone: 9876543210
        verify_account: true
        dashboard_access: true
        schedule_option: 1
        bank: {}
        upi: {}
        kyc_details: {}
      properties:
        vendor_id:
          type: string
          description: Specify the unique Vendor ID to identify the beneficiary. Alphanumeric and underscore (_) allowed.
        status:
          type: string
          description: 'Specify the status of vendor that should be updated. Possible values: ACTIVE,BLOCKED, DELETED.'
        name:
          type: string
          description: Specify the name of the vendor to be updated. Name should not have any special character except . /
            - &.
        email:
          type: string
          description: Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com)
            should contain @ and dot (.).
        phone:
          type: string
          description: Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits,
            8 - 12 characters after excluding +91).
        verify_account:
          type: boolean
          description: 'Specify if the vendor bank account details should be verified. Possible values: true or false.'
        dashboard_access:
          type: boolean
          description: 'Update if the vendor will have dashboard access or not. Possible values are: true or false.'
        schedule_option:
          type: number
          description: Specify the settlement cycle to be updated. View the settlement cycle details from the "Settlement
            Cycles Supported" table. If no schedule option is configured, the settlement cycle ID "1" will be in effect. Select
            "8" or "9" if you want to schedule instant vendor settlements.
        bank:
          $ref: '#/components/schemas/BankDetails'
          description: Specify the vendor bank account details to be updated.
        upi:
          $ref: '#/components/schemas/UpiDetails'
          description: 'Updated beneficiary upi vpa. Alphanumeric, dot (.), hyphen (-), at sign (@), and underscore allowed
            (100 character limit). Note: underscore and dot (.) gets accepted before and after @, but hyphen (-) is only accepted
            before @ sign.'
        kyc_details:
          $ref: '#/components/schemas/KycDetails'
          description: Specify the kyc details that should be updated.
      required:
      - vendor_id
      - status
      - name
      - email
      - phone
      - kyc_details
    StaticSplitRequest:
      title: StaticSplitRequest
      description: Request body to create a static split configuration.
      type: object
      properties:
        active:
          type: boolean
          description: 'Specify if the split is to be active or not. Possible values: true/false.'
        terminal_id:
          type: string
          description: For Subscription payments, the subscription reference ID is to be shared as the terminal ID. Incase
            for Payment Gateway terminal ID is non-mandatory. Mention as 0 if not applicable.
        terminal_reference_id:
          type: number
          description: You can share additional information using the reference ID.
        product_type:
          type: string
          description: Specify the product for which the split should be created. If you want split to be created for Payment
            Gateway pass value as "PG". If you want split to be created for Subscription, pass value as "SBC". Accepted values
            - "STATIC_QR", "SBC", "PG", "EPOS".
        scheme:
          type: array
          description: Provide the split scheme details.
          items:
            type: object
            properties:
              merchantVendorId:
                type: string
                description: Specify the merchant vendor ID to create the split scheme for the payment.
              percentage:
                type: string
                description: Specify the percentage of amount to be split.
      required:
      - active
      - product_type
      - scheme
    ESOrderReconRequest:
      title: ESOrderReconRequest
      description: Request body to fetch split and settlement details by order ID.
      type: object
      properties:
        filters:
          type: object
          description: Provide the filter object details.
          properties:
            start_date:
              type: string
              description: Specify the start data from which you want to get the recon data.
            end_date:
              type: string
              description: Specify the end data till which you want to get the recon data.
            order_ids:
              type: array
              description: Please provide list of order ids for which you want to get the recon data.
              items:
                type: string
        pagination:
          type: object
          description: Set limit based on your requirement. Pagination limit will fetch a set of orders, next set of orders
            can be generated using the cursor shared in previous response of the same API.
          properties:
            cursor:
              type: string
            limit:
              type: integer
              description: Set the minimum/maximum limit for number of filtered data. Min value - 10, Max value - 100.
      required:
      - filters
      - pagination
    SplitAfterPaymentRequest:
      title: SplitAfterPaymentRequest
      description: Request body to create a split for an order after payment.
      type: object
      properties:
        split:
          type: array
          description: Specify the vendors order split details.
          items:
            type: object
            properties:
              vendor_id:
                type: string
                description: Specify the merchant vendor ID to split the payment.
              amount:
                type: number
                description: Specify the amount to be split to the vendor.
              percentage:
                type: number
                description: Specify the percentage of amount to be split.
              tags:
                type: object
                maxProperties: 20
                description: Custom Tags in the form of {"key":"value"} which can be passed for an order. A maximum of 10
                  tags can be added.
                additionalProperties:
                  type: string
                  minLength: 1
                  maxLength: 255
        disable_split:
          type: boolean
          description: Specify if you want to end the split or continue creating further splits in future.
      required:
      - split.
    AdjustVendorBalanceRequest:
      title: AdjustVendorBalanceRequest
      description: Request body to create an on-demand transfer for a vendor.
      type: object
      properties:
        transfer_from:
          type: string
          description: Mention to whom you want to transfer the on demand balance. Possible values - MERCHANT, VENDOR.
        transfer_type:
          type: string
          description: 'Specifies the type of transfer to initiate. Allowed values are `ON_DEMAND` for settlement transfers and `ADJUSTMENT` for moving funds between the vendor and merchant ledgers in either direction.'
        transfer_amount:
          type: number
          format: float64
          description: Mention the on demand transfer amount.
        remark:
          type: string
          description: Mention remarks if any for the on demand transfer.
        tags:
          type: object
          description: Provide additional data fields using tags.
      required:
      - transfer_from
      - transfer_type
      - transfer_amount
    VendorAdjustmentRequest:
      title: VendorAdjustmentRequest
      description: Request body to create an adjustment for a vendor.
      type: object
      properties:
        vendor_id:
          type: string
          description: The unique identifier of the vendor to whom the adjustment is applied.
        adjustment_id:
          type: integer
          format: int64
          description: The unique identifier for the adjustment transaction.
        amount:
          type: number
          format: float64
          description: The adjustment amount to be applied.
        type:
          type: string
          description: 'The type of adjustment. Possible values: CREDIT, DEBIT.'
        remarks:
          type: string
          description: Remarks for the adjustment transaction, if any.
      required:
      - vendor_id
      - adjustment_id
      - amount
      - type
    UpdateVendorRequest:
      title: UpdateVendorRequest
      description: Request body to update a vendor.
      type: object
      example:
        status: ACTIVE
        name: customer
        email: johndoe@cashfree.com
        phone: 9876543210
        verify_account: true
        dashboard_access: true
        schedule_option: 1
        bank: []
        upi: []
        kyc_details: []
      properties:
        status:
          type: string
          description: 'Specify the status of vendor that should be updated. Possible value: ACTIVE.'
        name:
          type: string
          description: Specify the name of the vendor to be updated. Name should not have any special character except . /
            - &.
        email:
          type: string
          description: Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com)
            should contain @ and dot (.).
        phone:
          type: string
          description: Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits,
            8 - 12 characters after excluding +91).
        verify_account:
          type: boolean
          description: 'Specify if the vendor bank account details should be verified. Possible values: true or false.'
        dashboard_access:
          type: boolean
          description: 'Update if the vendor will have dashboard access or not. Possible values are: true or false.'
        schedule_option:
          type: number
          description: Specify the settlement cycle to be updated. View the settlement cycle details from the "Settlement
            Cycles Supported" table. If no schedule option is configured, the settlement cycle ID "1" will be in effect. Select
            "8" or "9" if you want to schedule instant vendor settlements.
        bank:
          type: array
          description: Specify the vendor bank account details to be updated.
          items:
            $ref: '#/components/schemas/BankDetails'
        upi:
          type: array
          description: 'Updated beneficiary upi vpa. Alphanumeric, dot (.), hyphen (-), at sign (@), and underscore allowed
            (100 character limit). Note: underscore and dot (.) gets accepted before and after @, but hyphen (-) is only accepted
            before @ sign.'
          items:
            $ref: '#/components/schemas/UpiDetails'
        kyc_details:
          type: array
          description: Specify the kyc details that should be updated.
          items:
            $ref: '#/components/schemas/KycDetails'
    CreateOrderSettlementRequestBody:
      type: object
      description: Request body to mark an order for settlement.
      example:
        order_id: order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H
        meta_data:
          cbriks_id: CBRIKS_004
          settlement_date: '2024-04-12'
      properties:
        order_id:
          type: string
          description: OrderId of the order.
        meta_data:
          type: object
          properties:
            cbriks_id:
              type: string
              description: Meta data cbricks ID to be used for reporting purpose.
            settlement_date:
              type: string
              format: date
              description: Requested Settlement Date.
      required:
      - order_id
      - meta_data
      - meta_data.settlement_date
    SettlementFetchReconRequest:
      type: object
      description: Request body to fetch settlement reconciliation details.
      example:
        pagination:
          limit: 10
          cursor: eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==
        filters:
          cf_settlement_ids:
          - '4234233'
          settlement_utrs:
          - utr1
          - utr2
          start_date_initiated_on: '2026-03-01T00:00:00+05:30'
          end_date_initiated_on: '2026-03-18T00:00:00+05:30'
          start_date_processed_on: '2026-03-01T00:00:00+05:30'
          end_date_processed_on: '2026-03-18T00:00:00+05:30'
      properties:
        pagination:
          type: object
          properties:
            limit:
              type: integer
              description: The number of settlements you want to fetch. Maximum limit is 1000, default value is 10.
            cursor:
              type: string
              description: Specifies from where the next set of settlement details should be fetched.
          description: "To fetch the next set of settlements, pass the cursor received in the response to the next API call.\
            \ \n To receive the data for the first time, pass the cursor as null. \n Limit would be number of settlements\
            \ that you want to receive."
          required:
          - limit
        filters:
          type: object
          properties:
            cf_settlement_ids:
              type: array
              items:
                type: integer
              description: List of settlement IDs for which you want the settlement reconciliation details.
            settlement_utrs:
              type: array
              items:
                type: string
              description: List of settlement UTRs for which you want the settlement reconciliation details.
            start_date_initiated_on:
              type: string
              description: Filter events by settlement initiation start date. Use ISO8601 format.
            end_date_initiated_on:
              type: string
              description: Filter events by settlement initiation end date. Use ISO8601 format.
            start_date_processed_on:
              type: string
              description: Filter events by settlement processed start date. Use ISO8601 format.
            end_date_processed_on:
              type: string
              description: Filter events by settlement processed end date. Use ISO8601 format.
            start_date:
              type: string
              deprecated: true
              description: "Deprecated: Use start_date_initiated_on or start_date_processed_on instead. Specify the start date from when you want the settlement reconciliation details."
            end_date:
              type: string
              deprecated: true
              description: "Deprecated: Use end_date_initiated_on or end_date_processed_on instead. Specify the end date till when you want the settlement reconciliation details."
          description: Specify either the Settlement ID, Settlement UTR, or date range filters to fetch the settlement details.
      required:
      - pagination
      - filters
    SettlementReconEntity:
      title: SettlementReconEntity
      description: A paginated list of settlement reconciliation events, each with its order, payment, settlement, refund and dispute details.
      example:
        cursor: bqiqsiuqsjlsd
        limit: 3
        data:
        - customer_details:
            customer_bank_account_number: '1234567'
            customer_bank_code: '123'
            customer_bank_ifsc: SBIN000123
            customer_email: manideep.ellur@cashfree.com
            customer_id: Manideep
            customer_name: Manideep
            customer_phone: '8281554863'
          dispute_details:
          - closed_in_favor_of: null
            dispute_category: null
            dispute_note: null
            dispute_resolved_on: null
            resolved_on: null
          event_details:
            entity: recon
            event_amount: 200.0
            event_currency: INR
            event_id: '43594'
            event_remarks: null
            event_service_charge: 2.0
            event_service_tax: 0.0
            event_settlement_amount: 200.0
            event_status: SUCCESS
            event_time: '2026-01-16T15:06:41+05:30'
            event_type: PAYMENT
            sale_type: CREDIT
          order_details:
            order_amount: 3000.0
            order_currency: INR
            order_id: order_1527072DQpGNwTMBlnAc1GfxmWalriHBG
            order_tags:
              key1: value1
              key2: value2
          payment_details:
            bank_reference: '210396'
            cf_payment_id: '1234881617186388204'
            charges_currency: INR
            forex_conversion_handling_charge: 0.0
            forex_conversion_handling_tax: 0.0
            payment_amount: 200.0
            payment_currency: INR
            payment_group: UPI
            payment_service_charge: 2.0
            payment_service_tax: 0.0
            payment_time: '2026-01-16T15:06:41+05:30'
            status: SUCCESS
          refund_details:
          - refund_arn: null
            refund_id: null
            refund_note: null
            refund_processed_at: null
          settlement_details:
            adjustment: null
            amount_settled: null
            cf_settlement_id: '1639775422'
            payment_from: null
            payment_till: null
            reason: null
            remarks: null
            service_charge: null
            service_tax: null
            settlement_charge: null
            settlement_date: '2026-01-16T18:33:51+05:30'
            settlement_initiated_on: '2026-01-16T15:33:51+05:30'
            settlement_tax: null
            settlement_type: null
            split_service_charge: 0.0
            split_service_tax: 0.0
            settlement_utr: PGI45406
            vendor_commission: 0.0
        - customer_details:
            customer_bank_account_number: '1234567'
            customer_bank_code: '123'
            customer_bank_ifsc: SBIN000123
            customer_email: manideep.ellur@cashfree.com
            customer_id: Manideep
            customer_name: Manideep
            customer_phone: '8281554863'
          dispute_details:
          - closed_in_favor_of: null
            dispute_category: null
            dispute_note: null
            dispute_resolved_on: null
            resolved_on: null
          event_details:
            entity: recon
            event_amount: 200.0
            event_currency: INR
            event_id: '74882039'
            event_remarks: null
            event_service_charge: 5.90
            event_service_tax: 1.06
            event_settlement_amount: 200.0
            event_status: SUCCESS
            event_time: '2026-01-15T11:42:08+05:30'
            event_type: REFUND
            sale_type: DEBIT
          order_details:
            order_amount: 3000.0
            order_currency: INR
            order_id: order_1527072DQpGNwTMBlnAc1GfxmWalriHBG
            order_tags:
              key1: value1
              key2: value2
          payment_details:
            bank_reference: '7492016853'
            cf_payment_id: '7492016853'
            charges_currency: INR
            forex_conversion_handling_charge: 0.0
            forex_conversion_handling_tax: 0.0
            payment_amount: null
            payment_currency: INR
            payment_group: UPI
            payment_service_charge: 5.90
            payment_service_tax: 1.06
            payment_time: null
            status: SUCCESS
          refund_details:
          - refund_arn: null
            refund_id: null
            refund_note: null
            refund_processed_at: null
          - refund_arn: null
            refund_id: null
            refund_note: null
            refund_processed_at: null
          settlement_details:
            adjustment: null
            amount_settled: null
            cf_settlement_id: '358124690'
            payment_from: null
            payment_till: null
            reason: null
            remarks: null
            service_charge: null
            service_tax: null
            settlement_charge: null
            settlement_date: '2026-01-20T08:45:33+05:30'
            settlement_initiated_on: null
            settlement_tax: null
            settlement_type: null
            split_service_charge: 0.0
            split_service_tax: 0.0
            settlement_utr: PGZ358124690
            vendor_commission: 0.0
        - customer_details:
            customer_bank_account_number: '1234567'
            customer_bank_code: '123'
            customer_bank_ifsc: SBIN000123
            customer_email: manideep.ellur@cashfree.com
            customer_id: Manideep
            customer_name: Manideep
            customer_phone: '8281554863'
          dispute_details:
          - closed_in_favor_of: MERCHANT
            dispute_category: 1402-Duplicate Processing
            dispute_note: test
            dispute_resolved_on: '2026-01-16 10:15:10'
            resolved_on: '2026-01-16 10:15:10'
          event_details:
            entity: recon
            event_amount: 200.0
            event_currency: INR
            event_id: '43594'
            event_remarks: null
            event_service_charge: 2.0
            event_service_tax: 0.0
            event_settlement_amount: 200.0
            event_status: SUCCESS
            event_time: '2026-01-16T15:06:41+05:30'
            event_type: DISPUTE
            sale_type: DEBIT
          order_details:
            order_amount: 3000.0
            order_currency: INR
            order_id: order_1527072DQpGNwTMBlnAc1GfxmWalriHBG
            order_tags:
              key1: value1
              key2: value2
          payment_details:
            bank_reference: '210396'
            cf_payment_id: '1234881617186388204'
            charges_currency: INR
            forex_conversion_handling_charge: 0.0
            forex_conversion_handling_tax: 0.0
            payment_amount: null
            payment_currency: INR
            payment_group: CREDIT_CARD
            payment_service_charge: 2.0
            payment_service_tax: 0.0
            payment_time: null
            status: null
          refund_details:
          - refund_arn: null
            refund_id: null
            refund_note: null
            refund_processed_at: null
          settlement_details:
            adjustment: null
            amount_settled: null
            cf_settlement_id: '1639775422'
            payment_from: null
            payment_till: null
            reason: null
            remarks: null
            service_charge: null
            service_tax: null
            settlement_charge: null
            settlement_date: '2026-01-16T18:33:51+05:30'
            settlement_initiated_on: '2026-01-16T15:33:51+05:30'
            settlement_tax: null
            settlement_type: null
            split_service_charge: 0.0
            split_service_tax: 0.0
            settlement_utr: PGI45406
            vendor_commission: 0.0
      properties:
        cursor:
          type: string
          description: Specifies from where the next set of settlement details should be fetched.
        limit:
          type: integer
          description: Number of settlements you want to fetch in the next iteration.
        data:
          type: array
          items:
            type: object
            properties:
              event_details:
                type: object
                properties:
                  event_id:
                    type: string
                    description: Unique ID associated with the event.
                  event_type:
                    type: string
                    description: The event type can be PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK,
                      CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT.
                  event_settlement_amount:
                    type: number
                    description: Amount that is part of the settlement corresponding to the event.
                  event_amount:
                    type: number
                    description: Amount corresponding to the event. Example, refund amount, dispute amount, payment amount,
                      etc.
                  sale_type:
                    type: string
                    description: Indicates if it is CREDIT/DEBIT sale.
                  event_status:
                    type: string
                    description: Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED.
                  entity:
                    type: string
                    description: Recon.
                  event_time:
                    type: string
                    description: Time associated with the event. Example, transaction time, dispute initiation time.
                  event_currency:
                    type: string
                    description: Currency type - INR.
                  event_service_charge:
                    type: number
                    description: Service charge for above event_type.
                  event_service_tax:
                    type: number
                    description: Service tax for above event_type.
                  event_remarks:
                    type: string
                    description: Remarks for above event_type.
              order_details:
                type: object
                properties:
                  order_id:
                    type: string
                    description: Unique order ID. Alphanumeric and only '-' and '_' allowed.
                  order_amount:
                    type: number
                    description: The amount which was passed at the order creation time.
                  order_currency:
                    type: string
                    description: Order Currency type - INR.
                  order_tags:
                    type: object
                    description: The order tags provided during order creation.
              customer_details:
                type: object
                properties:
                  customer_phone:
                    type: string
                    description: Customer phone number.
                  customer_email:
                    type: string
                    description: Customer email.
                  customer_name:
                    type: string
                    description: Customer name.
                  customer_id:
                    type: string
                    description: Customer's id.
                  customer_bank_account_number:
                    type: string
                    description: Customer bank account number.
                  customer_bank_code:
                    type: string
                    description: Customer bank code.
                  customer_bank_ifsc:
                    type: string
                    description: Customer bank IFSC.
              payment_details:
                type: object
                properties:
                  payment_amount:
                    type: number
                    description: Payment amount captured.
                  payment_currency:
                    type: string
                    description: Payment Currency type - INR.
                  bank_reference:
                    type: string
                    description: Unique transaction reference number of the payment.
                  payment_time:
                    type: string
                    description: Date and time when the payment was initiated.
                  payment_group:
                    type: string
                    description: Payment group/mode of the payment. Example - UPI, CREDIT_CARD.
                  payment_service_charge:
                    type: number
                    description: Service charge applicable for the payment.
                  payment_service_tax:
                    type: number
                    description: Service tax applicable on the payment.
                  cf_payment_id:
                    type: string
                    description: Cashfree unique ID to identify a payment.
                  status:
                    type: string
                    description: Status of the Payment.
                  forex_conversion_handling_charge:
                    type: number
                    description: Forex Conversion Service Charge.
                  forex_conversion_handling_tax:
                    type: number
                    description: Forex Conversion Service Tax.
                  charges_currency:
                    type: string
                    description: Forex Charges Currency type - INR.
              settlement_details:
                type: object
                properties:
                  cf_settlement_id:
                    type: string
                    description: Unique ID to identify the settlement.
                  settlement_date:
                    type: string
                    description: Date and time when the settlement was processed.
                  settlement_utr:
                    type: string
                    description: Unique transaction reference number of the settlement.
                  split_service_charge:
                    type: number
                    description: Service charge that is applicable for splitting the payment.
                  split_service_tax:
                    type: number
                    description: Service tax applicable for splitting the amount to vendors.
                  vendor_commission:
                    type: number
                    description: Vendor commission applicable for this transaction.
                  payment_from:
                    type: string
                    description: Date and time from settlement computed.
                  payment_till:
                    type: string
                    description: Date and time till settlement computed.
                  reason:
                    type: string
                    description: If any reason for settlement failure.
                  remarks:
                    type: string
                    description: Remarks related for settlement.
                  service_charge:
                    type: number
                    description: Service charge for the transactions.
                  service_tax:
                    type: number
                    description: Service tax for the transactions.
                  settlement_charge:
                    type: number
                    description: Settlement Service Charge.
                  settlement_initiated_on:
                    type: string
                    description: Date and time when Settlement initiated.
                  settlement_tax:
                    type: number
                    description: Settlement Service Tax.
                  settlement_type:
                    type: string
                    description: Type of Settlement, Example - Normal Settlement.
              dispute_details:
                type: array
                description: List of disputes linked to this event.
                items:
                  type: object
                  properties:
                    closed_in_favor_of:
                      type: string
                      description: Specifies whether the dispute was closed in favor of the merchant or customer. Possible values
                        - Merchant, Customer.
                    dispute_resolved_on:
                      type: string
                      description: Date and time when the dispute was resolved.
                    dispute_category:
                      type: string
                      description: Category of the dispute - Dispute code and the reason for dispute is shown.
                    dispute_note:
                      type: string
                      description: Note regarding the dispute.
                    resolved_on:
                      type: string
                      description: Date and time when the dispute case was resolved.
              refund_details:
                type: array
                description: List of refunds linked to this event.
                items:
                  type: object
                  properties:
                    refund_processed_at:
                      type: string
                      description: Date and time when the refund was processed.
                    refund_arn:
                      type: string
                      description: The bank reference number for refund.
                    refund_note:
                      type: string
                      description: A refund note for your reference.
                    refund_id:
                      type: string
                      description: An unique ID associated with the refund.
    SettlementWebhook:
      title: SettlementWebhook
      description: Settlement webhook object.
      type: object
      properties:
        data:
          type: object
          title: SettlementWebhookDataEntity
          description: data entity in webhook.
          properties:
            settlement:
              allOf:
              - $ref: '#/components/schemas/SettlementEntity'
        event_time:
          type: string
          example: '2021-10-07T19:42:44+05:30'
        type:
          type: string
          example: PAYMENT_SUCCESS_WEBHOOK
    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: integer
          format: int64
        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
    TerminalFilters:
      description: Use this object to filter terminal transactions based on various criteria.
      example:
        start_date: '2023-08-04T13:12:58+05:30'
        end_date: '2023-08-04T13:12:58+05:30'
        cf_terminal_id: 1234
        terminal_vpa: cf.epos@cash
        terminal_phone_no: '9696969696'
        payment_status: SUCCESS
        payment_group: UPI
        sort_by: start_date
        sort_order: ASC
      properties:
        start_date:
          description: 'Start date and time for transaction filtering. Use ISO8601 format  (example: 2021-07-02T10:20:12+05:30
            for IST, 2021-07-02T10:20:12Z for UTC).'
          type: string
        end_date:
          description: 'End date and time for transaction filtering. Use ISO8601 format  (example: 2021-07-02T10:20:12+05:30
            for IST, 2021-07-02T10:20:12Z for UTC).'
          type: string
        cf_terminal_id:
          description: Unique Cashfree terminal identifier.
          type: integer
          format: int64
        terminal_vpa:
          description: Virtual payment address (VPA) associated with the terminal.
          type: string
        terminal_phone_no:
          description: Mobile phone number registered with the terminal.
          type: string
        payment_status:
          description: Payment transaction status. Possible values are SUCCESS, FAILED, or PENDING.
          type: string
        payment_group:
          description: Payment method group (for example, UPI, CARD, NET_BANKING).
          type: string
        sort_by:
          description: Field to sort results by. Currently supports sorting by start_date.
          type: string
        sort_order:
          description: Sort order for the results. Use ASC for ascending or DESC for descending order.
          type: string
      title: TerminalFilters
      type: object
    TerminalPagination:
      description: Use this object to configure pagination for terminal transaction results.
      example:
        page_number: 1
        page_size: 50
      properties:
        page_number:
          description: Page number for the requested results. Default value is 1.
          type: integer
        page_size:
          description: Number of transactions to return per page. Default value is 25.
          type: integer
      title: TerminalPagination
      type: object
    TerminalEntity:
      title: TerminalEntity
      description: A terminal, with its ID, type, status, contact details and linked virtual payment addresses (VPAs).
      type: object
      example:
        added_on: 023-10-12T11:12:39+05:30
        cf_terminal_id: 1838
        last_updated_on: 023-10-12T11:12:39+05:30
        terminal_address: Bangalore
        terminal_email: john@cashfree.com
        terminal_id: test
        terminal_meta:
          terminal_operator: dev test
        terminal_name: john doe
        terminal_note: POS vertical
        terminal_phone_no: 9876543214
        terminal_status: DOCS_AWAITED
        terminal_type: STOREFRONT
        terminal_vpas: vpaPrefix@pg
      properties:
        added_on:
          type: string
        cf_terminal_id:
          type: integer
        last_updated_on:
          type: string
        terminal_address:
          type: string
        terminal_email:
          type: string
        terminal_type:
          type: string
        teminal_id:
          type: string
        terminal_name:
          type: string
        terminal_note:
          type: string
        terminal_phone_no:
          type: string
        terminal_status:
          type: string
        terminal_meta:
          description: Terminal metadata, required field for storefront.
          properties:
            terminal_operator:
              description: name of the STOREFRONT operator.
              type: string
          type: object
        terminal_vpas:
          type: string
    TerminalTransactionEntity:
      title: TerminalTransactionEntity
      description: A terminal transaction, with its amount, payment method, payment URL, QR code and timeout.
      type: object
      example:
        cf_payment_id: 42887
        payment_amount: 10
        payment_method: LINK
        payment_url: https://payments-test.cashfree.com/order/#4jWjotaRWEizB1BiCtPf
        qrcode: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAACWklEQVR42uyZPY7sIBCEy3JAyBE4Chdb+UfvYhyFIxASINdTNZ6dWc3mNu8NgbWyvw1a3dVdzeBzPue/PBNJHo7wB2LDWoCwl6i3aSCgAlgQyQNgXnyqWEsE4IcCAouAApcapoIq3rHdDnBpLhM5ZwCOexkV0JfUwobI/GuYNwdUUY5zWRxhugDwVnIXA128qfm9xtnK/ld13xvoxyX2+FYmx+29nd4cmCrmspLNb6ooMtWweZLbM5s3AAL8ZhVlFe8tilhD+45iCAANC3rLN/E6VZPjUACAXkx+r33o2rv60PkYwEQ2qUHjIM3cSQv4R4+6AZDnU7cVM1miy1Jw/hoJgMvyD/pWo0Vdw6FcDAWYund9W0lmc0ETiZ/yvxqgDLFakL2WPegtiGUgAC43vwHNBgMPb7GOBshmakN52GayYjr70G0AwGZW6uM37Ke3f86sIYCpgmWt0RRMNdIKeCovaSBABmivscmvWSOFrJDLX89sXg5AqwaZulXr40qPsH030gEAzSxu0oXsTrAwD69GOhIA9dCVJuw050l5WlRRL8m6HDCTYw+o0asT8dC/sQwEQDKgXJrsgfykxPuqi0EA2UwZTrUdAeHwtmylcQDTxWGTl6mFnanHnZ/e/nrgsXebRzB/06fw6xp1f+BxB2LLyZxX5WKXwZ/LSMB5y6q/ure3PLm3u+JrgfN+sotXachGffnhABWTjE22u+xFM+tnmIMA5jphhlPqruHPd0XdAbCK0sZq06sA4UB86VFDAOfvOM33XDCZK8arK74/8Dmf84+dvwEAAP//PizKiw+K9esAAAAASUVORK5CYII=
        timeout: '300000'
      properties:
        cf_payment_id:
          type: integer
          format: int64
        payment_amount:
          type: integer
        payment_method:
          type: string
        payment_url:
          type: string
        qrcode:
          type: string
        timeout:
          type: string
    SoundboxVpaEntity:
      title: SoundboxVpaEntity
      description: A soundbox device linked to a VPA, with its serial number, terminal ID, merchant name and language.
      type: object
      example:
        vpa: cf.vpa-epos-gamma1018696837085fad68@sim
        cf_terminal_id: 3708
        device_serial_no: abtest123
        merchant_name: merchant-test
        language: English
      properties:
        vpa:
          type: string
        cf_terminal_id:
          type: integer
          format: int64
        device_serial_no:
          type: string
        merchant_name:
          type: string
        language:
          type: string
    TerminateOrderRequest:
      title: TerminateOrderRequest
      description: Request body to terminate an active order.
      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.
    UPIAuthorizeDetails:
      title: UPIAuthorizeDetails
      description: Object when you are using preauth in UPI in order pay.
      example:
        authorization:
          approve_by: '2022-07-02T10:20:12+05:30'
          start_time: '2022-09-21T12:34:34Z'
          end_time: '2022-10-22T12:34:34Z'
      type: object
      properties:
        approve_by:
          type: string
          description: Time by which this authorization should be approved by the customer.
        start_time:
          type: string
          description: This is the time when the UPI one time mandate will start.
        end_time:
          type: string
          description: This is the time when the UPI mandate will be over. If the mandate has not been executed by this time,
            the funds will be returned back to the customer after this time.
    UPIPaymentMethod:
      title: UPIPaymentMethod
      description: Complete payment method for UPI collect.
      type: object
      properties:
        upi:
          $ref: '#/components/schemas/Upi'
      required:
      - upi
    UpdateTerminalEntity:
      title: UpdateTerminalEntity
      description: An updated terminal, with its ID, type, status and contact details.
      type: object
      example:
        added_on: 023-10-12T11:12:39+05:30
        cf_terminal_id: 1838
        last_updated_on: 023-10-12T11:12:39+05:30
        terminal_address: Cashfree India Pvt Ltd RMZ Eco world, Building 7 10th Floor, Devarabeesanahalli, Marathalli
          Outer Ring road, Bangalore - 560103
        terminal_email: john@cashfree.com
        terminal_id: test
        terminal_meta:
          terminal_operator: dev test
        terminal_name: john doe
        terminal_note: POS vertical
        terminal_phone_no: 9876543214
        terminal_status: DOCS_AWAITED
        terminal_type: STOREFRONT
      properties:
        added_on:
          type: string
        cf_terminal_id:
          type: integer
        last_updated_on:
          type: string
        terminal_address:
          type: string
        terminal_email:
          type: string
        terminal_type:
          type: string
        teminal_id:
          type: string
        terminal_name:
          type: string
        terminal_note:
          type: string
        terminal_phone_no:
          type: string
        terminal_status:
          type: string
        terminal_meta:
          description: Terminal metadata, required field for storefront.
          properties:
            terminal_operator:
              description: name of the STOREFRONT operator.
              type: string
          type: object
    UpdateTerminalRequest:
      title: Update Terminal
      description: Request body to update terminal details.
      example:
        terminal_email: john@cashfree.com
        terminal_phone_no: '9876543210'
        terminal_meta: null
        terminal_status: DOCS_AWAITED
        terminal_type: STOREFRONT
      type: object
      properties:
        terminal_email:
          type: string
          description: Mention the updated email ID of the terminal.
        terminal_phone_no:
          type: string
          description: Terminal phone number to be updated.
          minLength: 10
          maxLength: 10
        terminal_meta:
          type: object
          description: Terminal metadata.
          properties:
            terminal_operator:
              description: Name of the operator for the storefront.
              type: string
        terminal_type:
          type: string
          description: Mention the terminal type to be updated. Possible values - AGENT, STOREFRONT.
      required:
      - terminal_type
    UpdateTerminalStatusRequest:
      title: Update Terminal Status
      description: Request body to update terminal status.
      example:
        terminal_status: ACTIVE
      type: object
      properties:
        terminal_status:
          type: string
          description: Status of the terminal to be updated. possible values - ACTIVE, INACTIVE.
      required:
      - terminal_status
    Upi:
      title: Upi
      description: UPI collect payment method object.
      example:
        channel: collect
        upi_id: john@okxdfcbak
        upi_expiry_minutes: 10
      type: object
      properties:
        channel:
          type: string
          enum:
          - link
          - collect
          - qrcode
          - podQrCode
          description: Specify the channel through which the payment must be processed. Can be one of ["link", "collect",
            "qrcode", "podQrCode"].
        upi_id:
          type: string
          description: "Customer UPI VPA to process payment. \n### Important\nThis is a required parameter for channel = `collect`.\n"
        upi_redirect_url:
          type: boolean
          description: |
            use this if you want cashfree to show a loader. Sample response below. It is only supported for collect
            `action:collect` will be returned with `data.url` having the link for redirection.
        upi_expiry_minutes:
          type: number
          description: The UPI request will be valid for this expiry minutes. This parameter is only applicable for a UPI
            collect payment. The default value is 5 minutes. You should keep the minimum as 5 minutes, and maximum as 15 minutes.
        authorize_only:
          type: boolean
          description: For one time mandate on UPI. Set this as authorize_only = true. Please note that you can only use the
            "collect" channel if you are sending a one time mandate request.
        authorization:
          $ref: '#/components/schemas/UPIAuthorizeDetails'
      required:
      - channel.
    UploadTerminalDocs:
      title: Upload Terminal Docs
      description: Request body to upload terminal documents.
      example:
        doc_type: PHOTOGRAPH
        doc_value: john
        file: null
      type: object
      properties:
        doc_type:
          type: string
          description: Mention the document type you are uploading. Possible values - ADDRESSPROOF, PHOTOGRAPH.
        doc_value:
          type: string
          description: Enter the display name of the uploaded file.
        file:
          type: string
          description: Select the document that should be uploaded or provide the path of that file. You cannot upload a file
            that is more than 2MB in size.
      required:
      - doc_type
      - doc_value
      - file
    VendorSplit:
      title: VendorSplit
      description: Use to split order when cashfree's Easy Split is enabled for your account.
      type: object
      example:
        vendor_id: Vendor01
        amount: 100.12
        description: order amount should be more than equal to 100.12.
      properties:
        vendor_id:
          type: string
          description: Vendor id created in Cashfree system.
        amount:
          type: number
          description: Amount which will be associated with this vendor.
        percentage:
          type: number
          description: Percentage of order amount which shall get added to vendor account.
        tags:
          type: object
          maxProperties: 15
          description: Custom Tags in the form of {"key":"value"} which can be passed for an order. A maximum of 10 tags can
            be added.
          additionalProperties:
            type: object
      required:
      - vendor_id.
    BankDetails:
      title: BankDetails
      type: object
      example:
        account_number: 11219276360
        account_holder: JOHNDOE
        ifsc: YESB0000262
      properties:
        account_number:
          type: string
        account_holder:
          type: string
        ifsc:
          type: string
    TransferDetails:
      title: TransferDetails
      type: object
      example:
        vendor_id: test03
        transfer_from: VENDOR
        transfer_type: ADJUSTMENT
        transfer_amount: 10
        remark: Testing
        tags:
        - product: SHRT
        - size: 1
      properties:
        vendor_id:
          type: string
        transfer_from:
          type: string
        transfer_type:
          type: string
        transfer_amount:
          type: number
        remark:
          type: string
        tags:
          type: array
          items:
            type: object
            properties:
              product:
                type: string
              size:
                type: number
    BalanceDetails:
      title: BalanceDetails
      type: object
      example:
        merchant_id: 152707
        vendor_id: test03
        merchant_unsettled: 2442
        vendor_unsettled: 4757.42
      properties:
        merchant_id:
          type: number
        vendor_id:
          type: string
        merchant_unsettled:
          type: number
          format: float64
        vendor_unsettled:
          type: number
          format: float64
    ChargesDetails:
      title: ChargesDetails
      type: object
      example:
        service_charges: 2
        service_tax: 0.36
        amount: 10
        billed_to: MERCHANT
        is_postpaid: true
      properties:
        service_charges:
          type: number
          format: float64
        service_tax:
          type: number
          format: float64
        amount:
          type: number
          format: float64
        billed_to:
          type: string
        is_postpaid:
          type: boolean
    UpiDetails:
      title: UpiDetails
      type: object
      example:
        vpa: success@upi
        account_holder: JOHN DOE
      properties:
        vpa:
          type: string
        account_holder:
          type: string
    KycDetails:
      title: KycDetails
      type: object
      example:
        account_type: BUSINESS
        business_type: NBFC
        uidai: 753624181019
        gst: 11AAAAA1111A1Z0
        cin: L00000Aa0000AaA000000
        pan: BIAPA2934N
        passport_number: L6892603
      properties:
        account_type:
          type: string
        business_type:
          type: string
        uidai:
          type: number
        gst:
          type: string
        cin:
          type: string
        pan:
          type: string
        passport_number:
          type: string
        driving_license:
          type: string
        voter_id:
          type: string
    ScheduleOption:
      title: ScheduleOption
      type: object
      example:
        settlement_schedule_message: T+1 settlement at 11:00 AM
        schedule_id: 1
        merchant_default: true
      properties:
        settlement_schedule_message:
          type: string
        schedule_id:
          type: number
        merchant_default:
          type: boolean
    SubscriptionPaymentSplitItem:
      title: SubscriptionPaymentSplitItem
      description: Subscription Payment Split Item.
      type: object
      example:
        vendor_id: '123'
        percentage: 12.05
      properties:
        vendor_id:
          type: string
          description: Vendor ID.
        percentage:
          type: number
          format: float64
          description: Percentage of the payment to be split to vendor.
    AuthorizationDetails:
      title: AuthorizationDetails
      description: Details of the authorization done for the subscription. Returned in Get subscription and payments.
      type: object
      example:
        authorization_amount: 1
        authorization_amount_refund: false
        authorization_reference: ''
        authorization_time: '2025-06-01T23:47:52+05:30'
        authorization_status: INITIALIZED
        payment_id: '97877'
        payment_group: upi
        payment_method:
          upi:
            channel: collect
            upi_id: test@upi
            upi_instrument: upiInstrument
            upi_instrument_number: '1234567890'
            upi_payer_account_number: 039861903074
            upi_payer_ifsc: SBIN0001234
      properties:
        authorization_amount:
          type: number
          format: float64
          description: Amount charged for the authorisation payment. For eNACH, authorization_amount is always 0. For UPI
            and card, the minimum value is ₹1.
        authorization_amount_refund:
          type: boolean
          description: Indicates whether the authorisation amount is refunded to the customer automatically after the
            subscription is authorised. If true, the authorisation amount is refunded automatically. If false, it is not
            refunded automatically.
        authorization_reference:
          type: string
          description: Authorization reference. UMN for UPI, UMRN for EMandate/Physical Mandate and Enrollment ID for cards.
        authorization_time:
          type: string
          description: Authorization time. Cashfree stores timestamps in IST.
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        authorization_status:
          type: string
          description: Status of the authorization.
        payment_id:
          type: string
          description: A unique ID passed by merchant for identifying the transaction.
        payment_group:
          type: string
          description: Payment group used for the authorization.
        payment_method:
          type: object
          properties:
            upi:
              $ref: '#/components/schemas/AuthResponseUpi'
            enach:
              $ref: '#/components/schemas/AuthResponseEnach'
            pnach:
              $ref: '#/components/schemas/AuthResponsePnach'
            card:
              $ref: '#/components/schemas/AuthResponseCard'
    AuthResponseUpi:
      description: Payment method upi.
      type: object
      title: Upi Auth Response
      properties:
        channel:
          description: Can be link, qrcode, or collect.
          type: string
        upi_id:
          description: Virtual payment address (UPI ID) of the user.
          type: string
        upi_instrument:
          description: UPI instrument used for payment.
          type: string
        upi_instrument_number:
          description: Unique number representing the UPI instrument.
          type: string
        upi_payer_account_number:
          description: Account number of the UPI payer.
          type: string
        upi_payer_ifsc:
          description: IFSC code of the UPI payer's bank.
          type: string
    AuthResponseCard:
      description: Payment method card.
      type: object
      title: Card Auth Response
      properties:
        channel:
          description: Can be link.
          type: string
        card_number:
          description: Card number.
          type: string
        card_network:
          description: Card network (e.g., VISA, Mastercard).
          type: string
        card_type:
          description: Card type (e.g., credit_card).
          type: string
        card_sub_type:
          description: Card subtype (e.g., R).
          type: string
        card_country:
          description: Country of the card (e.g., IN).
          type: string
        card_bank_name:
          description: Bank name on card.
          type: string
        card_network_reference_id:
          description: Network reference ID.
          type: string
        instrument_id:
          description: Unique identifier for card instrument.
          type: string
    AuthResponseEnach:
      description: Payment method enach.
      type: object
      title: Enach Auth Response
      properties:
        channel:
          description: Channel. Can be link.
          type: string
        auth_mode:
          description: Auth mode. Can be debit_card, aadhaar, or net_banking.
          type: string
        account_type:
          description: Type of the bank account.
          type: string
        account_number:
          description: Bank account number.
          type: string
        account_ifsc:
          description: IFSC code of the bank account.
          type: string
        account_holder_name:
          description: Name of the account holder.
          type: string
        account_bank_code:
          description: Bank code of the account-holding bank.
          type: string
    AuthResponsePnach:
      description: Payment method pnach.
      type: object
      title: Pnach Auth Response
      properties:
        channel:
          description: Channel. Can be post.
          type: string
        mandate_creation_date:
          description: Date on which the mandate was created. Cashfree stores timestamps in IST.
          type: string
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        mandate_start_date:
          description: Start date of the mandate. Cashfree stores timestamps in IST.
          type: string
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        account_type:
          description: Type of the bank account.
          type: string
        account_number:
          description: Bank account number.
          type: string
        account_ifsc:
          description: IFSC code of the bank account.
          type: string
        account_holder_name:
          description: Name of the account holder.
          type: string
        account_bank_code:
          description: Bank code of the account-holding bank.
          type: string
    SubscriptionCustomerDetails:
      title: CustomerDetails
      description: Subscription customer details.
      type: object
      example:
        customer_name: Test Cust
        customer_email: test@gmail.com
        customer_phone: '9900755700'
        customer_bank_account_holder_name: ''
        customer_bank_account_number: ''
        customer_bank_ifsc: ''
        customer_bank_code: ''
        customer_bank_account_type: ''
      properties:
        customer_name:
          type: string
          description: Name of the customer.
        customer_email:
          type: string
          description: Email of the customer.
        customer_phone:
          type: string
          description: Phone number of the customer.
        customer_bank_account_holder_name:
          type: string
          description: Bank holder name of the customer. Account holder name is mandatory for TPV transaction. Max character
            allowed is 40.
        customer_bank_account_number:
          type: string
          description: Bank account number of the customer. Conditional Parameter. Max character allowed is 35.
        customer_bank_ifsc:
          type: string
          description: IFSC code of the customer. For a TPV transaction, send at least one out of `customer_bank_code` or
            `customer_bank_ifsc`.
        customer_bank_code:
          type: string
          description: Bank code of the customer. Refer to the list of Live Banks in API E-Mandate [here](https://www.npci.org.in/product/nach/all-members).
            For a TPV transactions, include at least one of `customer_bank_code` or `customer_bank_ifsc`.
        customer_bank_account_type:
          type: string
          enum:
          - SAVINGS
          - CURRENT
          description: Bank account type of the customer.
      required:
      - customer_email
      - customer_phone
    PlanEntity:
      title: PlanEntity
      description: A subscription plan, with its type, amounts, billing interval and maximum number of cycles.
      type: object
      example:
        plan_currency: INR
        plan_id: 144436-03471-JD_TEST
        plan_interval_type: WEEK
        plan_intervals: 1
        plan_max_amount: 1
        plan_max_cycles: 4
        plan_name: abscede
        plan_note: lsdkdn
        plan_recurring_amount: 1
        plan_status: ACTIVE
        plan_type: PERIODIC
      properties:
        plan_currency:
          type: string
          description: Currency for the plan.
        plan_id:
          type: string
          description: Plan ID provided by merchant.
        plan_interval_type:
          type: string
          description: Interval type for the plan.
        plan_intervals:
          type: integer
          description: Number of intervals for the plan.
        plan_max_amount:
          type: number
          format: float64
          description: Maximum amount for the plan.
        plan_max_cycles:
          type: integer
          description: Maximum number of payment cycles for the plan.
        plan_name:
          type: string
          description: Name of the plan.
        plan_note:
          type: string
          description: Note for the plan.
        plan_recurring_amount:
          type: number
          format: float64
          description: Recurring amount for the plan.
        plan_status:
          type: string
          description: Status of the plan.
        plan_type:
          type: string
          description: Type of the plan.
    SubscriptionEntity:
      title: SubscriptionEntity
      description: A subscription, with its status, plan, customer details, authorisation details and next scheduled payment date.
      type: object
      example:
        authorisation_details:
          authorization_amount: 1
          authorization_amount_refund: false
          authorization_reference: ''
          authorization_time: '2025-06-01T23:47:52+05:30'
          authorization_status: INITIALIZED
          payment_id: '97877'
          payment_group: enach
          payment_method:
            enach:
              channel: link
              auth_mode: NetBanking
              account_type: SAVINGS
              account_number: '123456789012'
              account_ifsc: SBIN0000123
              account_holder_name: John Doe
              account_bank_code: SBIN
        cf_subscription_id: '4'
        customer_details:
          customer_name: John Doe
          customer_email: test@gmail.com
          customer_phone: '9900755700'
          customer_bank_account_holder_name: ''
          customer_bank_account_number: ''
          customer_bank_ifsc: ''
          customer_bank_code: ''
          customer_bank_account_type: ''
        next_schedule_date: null
        plan_details:
          plan_id: od-20k-plan
          plan_name: On demand plan for 20000 max amount
          plan_type: ON_DEMAND
          plan_max_cycles: 0
          plan_recurring_amount: 0
          plan_max_amount: 20000
          plan_interval_type: ''
          plan_intervals: 0
          plan_currency: INR
          plan_note: ''
          plan_status: ''
        subscription_expiry_time: '2100-01-01T05:29:59+05:30'
        subscription_first_charge_time: ''
        subscription_id: SUB0028
        subscription_meta:
          return_url: ''
        subscription_note: ''
        subscription_session_id: subs_token_tc9JCN4MzUIJ
        subscription_payment_splits: null
        subscription_status: INITIALIZED
        subscription_tags: null
      properties:
        authorisation_details:
          $ref: '#/components/schemas/AuthorizationDetails'
        cf_subscription_id:
          type: string
          description: Cashfree subscription reference number.
        customer_details:
          $ref: '#/components/schemas/SubscriptionCustomerDetails'
        plan_details:
          $ref: '#/components/schemas/PlanEntity'
        subscription_expiry_time:
          type: string
          description: Time at which the subscription will expire. We store timestamps in IST.
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        subscription_first_charge_time:
          type: string
          description: Time at which the first charge will be made for the subscription. Applicable only for PERIODIC plans.
            Cashfree stores timestamps in IST.
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        subscription_id:
          type: string
          description: A unique ID passed by merchant for identifying the subscription.
        subscription_meta:
          type: object
          description: Subscription metadata.
          properties:
            return_url:
              type: string
              description: Return URL for the subscription.
        subscription_note:
          type: string
          description: Note for the subscription.
        subscription_session_id:
          type: string
          description: Subscription Session Id.
        subscription_payment_splits:
          type: array
          description: Payment splits for the subscription.
          items:
            $ref: '#/components/schemas/SubscriptionPaymentSplitItem'
        subscription_status:
          type: string
          description: Status of the subscription. For more details, see [Subscription Lifecycle](https://www.cashfree.com/docs/payments/subscription/create#subscription-lifecycle).
        subscription_tags:
          type: object
          description: Tags for the subscription.
        next_schedule_date:
          type: string
          description: The date on which the next payment is scheduled to be processed. Cashfree stores timestamps in IST.
            For ON_DEMAND plans this will be null .
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
    SubscriptionPaymentEntity:
      title: SubscriptionPaymentEntity
      description: A subscription payment, with its amount, type, status, scheduled date and retry attempts.
      type: object
      example:
        authorization_details:
          authorization_amount: 1
          authorization_amount_refund: true
          start_time: '2024-04-18T16:40:00'
          authorization_reference: osduh20ijegaoinfbBjuweod31@upi
          authorization_time: '2025-06-01T16:45:00'
          authorization_status: ACTIVE
          payment_id: test-payment-id
          payment_group: upi
          payment_method:
            upi:
              channel: collect
              upi_id: test@upi
              upi_instrument: upiInstrument
              upi_instrument_number: '1234567890'
              upi_payer_account_number: 039861903074
              upi_payer_ifsc: SBIN0001234
        cf_payment_id: '123456'
        cf_txn_id: '123456'
        cf_order_id: '123456'
        cf_subscription_id: '7891011'
        failure_details:
          failure_reason: ''
        payment_amount: 1
        payment_id: test-payment-id
        payment_initiated_date: 2025-06-01T22:14:58+0530
        payment_remarks: authpayment
        payment_schedule_date: ''
        payment_status: SUCCESS
        payment_type: AUTH
        retry_attempts: 0
        subscription_id: test-subscription-id
      properties:
        authorization_details:
          $ref: '#/components/schemas/AuthorizationDetails'
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        cf_subscription_id:
          type: string
          description: Cashfree subscription reference number.
        cf_txn_id:
          type: string
          description: Cashfree subscription payment transaction ID.
        cf_order_id:
          type: string
          description: Cashfree subscription payment order ID.
        failure_details:
          type: object
          properties:
            failure_reason:
              type: string
              description: Failure reason of the payment if the payment_status is failed.
        payment_amount:
          type: number
          format: float64
          description: The charge amount of the payment.
        payment_id:
          type: string
          description: A unique ID passed by merchant for identifying the transaction.
        payment_initiated_date:
          type: string
          description: The date on which the payment was initiated. Cashfree stores timestamps in IST.
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        payment_remarks:
          type: string
          description: Payment remarks.
        payment_schedule_date:
          type: string
          description: "The date on which the payment is scheduled to be processed. Cashfree stores timestamps in IST, but\
            \ you can provide them in a valid ISO 8601 time format.\n\nFor IST this `2025-06-01T10:20:12+05:30` translates\
            \ to `2025-06-01 10:20:12` \n\n For UTC this `2025-06-01T10:20:12Z` translates to `2025-06-01 15:50:12+05:30`."
        payment_status:
          type: string
          description: Status of the payment.
        payment_type:
          type: string
          description: Payment type. Can be AUTH or CHARGE.
        retry_attempts:
          type: integer
          description: Retry attempts.
        subscription_id:
          type: string
          description: A unique ID passed by merchant for identifying the subscription.
    CreateSubscriptionPaymentResponse:
      title: CreateSubscriptionPaymentResponse
      description: A subscription payment created as a charge or an authorisation, with its amount, type and status.
      type: object
      example:
        payment_id: test-paymey
        subscription_id: Demo_Subscription
        payment_amount: 1
        cf_payment_id: '12345'
        payment_method: upi
        payment_status: SUCCESS
        payment_type: AUTH
        action: custom
        channel: link
        data:
          url: https://api.cashfree.com/pg/view/gateway/tuOssT3fNV8soG97VSeHca034555-8a65-4aaf-9e67-c9893471af23
          payload: null
          content_type: null
          method: null
      properties:
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        failure_details:
          type: object
          properties:
            failure_reason:
              type: string
              description: Failure reason of the payment if the payment_status is failed.
        payment_amount:
          type: number
          format: float64
          description: The charge amount of the payment.
        payment_id:
          type: string
          description: A unique ID passed by merchant for identifying the transaction.
        payment_initiated_date:
          type: string
          description: The date on which the payment was initiated. We store timestamps in IST.
          format: ISO8601
          example: '2025-06-01T10:20:12+05:30'
        payment_status:
          type: string
          description: Status of the payment.
        payment_type:
          type: string
          description: Payment type. Can be AUTH or CHARGE.
          example: CHARGE
        subscription_id:
          type: string
          description: A unique ID passed by merchant for identifying the subscription.
        data:
          type: object
          description: Contains a payload for auth app links in case of AUTH. For charge, the payload is empty.
        payment_method:
          type: string
          description: Payment method used for the authorisation.
    SubscriptionPaymentRefundEntity:
      title: SubscriptionPaymentRefundEntity
      description: A refund on a subscription payment, with its amount, speed, status and note.
      type: object
      example:
        payment_id: pay8643
        cf_payment_id: '863782648'
        refund_id: refund2
        cf_refund_id: ref_212
        refund_amount: 100
        refund_note: test
        refund_speed: INSTANT
        refund_status: INITIALIZED
      properties:
        payment_id:
          type: string
          description: A unique ID passed by merchant for identifying the transaction.
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        refund_id:
          type: string
          description: A unique ID passed by merchant for identifying the refund.
        cf_refund_id:
          type: string
          description: Cashfree subscription payment refund reference number.
        refund_amount:
          type: number
          format: float64
          description: The refund amount.
        refund_note:
          type: string
          description: Refund note for merchant reference.
        refund_speed:
          type: string
          description: Refund speed. Can be INSTANT or NORMAL.
        refund_status:
          type: string
          description: Status of the refund. Can be INITIALIZED, SUCCESS, CANCEL, PENDING or FAILED.
    CreateSubscriptionRefundRequest:
      title: CreateSubscriptionRefundRequest
      description: Request body to create a subscription refund.
      example:
        subscription_id: test-subs-id
        payment_id: test-payment-id
        refund_id: dummy-test-refund-id
        refund_amount: 10
        refund_note: full refund
        refund_speed: INSTANT
        cf_payment_id: 1234235
      properties:
        cf_payment_id:
          description: Cashfree subscription payment reference number.
          type: number
          format: int64
        subscription_id:
          type: string
          description: A unique ID passed by merchant for identifying the subscription.
        payment_id:
          type: string
          description: A unique ID passed by merchant for identifying the transaction.
        refund_id:
          type: string
          description: A unique ID passed by merchant for identifying the refund.
        refund_amount:
          type: number
          format: float64
          description: The amount to be refunded. Can be partial or full amount of the payment.
        refund_note:
          type: string
          description: Refund note for merchant reference. To simulate refund status in Sandbox, pass SUCCESS, FAILED, PENDING,
            or ACTIVE in the refund_note field. This is a case-sensitive parameter.
        refund_speed:
          type: string
          description: Refund speed. Can be INSTANT or STANDARD. UPI supports only STANDARD refunds, Enach and Pnach supports
            only INSTANT refunds.
      required:
      - subscription_id
      - refund_id
      - refund_amount
      - payment_id
    CreatePlanRequest:
      title: CreatePlanRequest
      description: Request body to create a plan.
      example:
        plan_id: plan_12345
        plan_name: Plan 12345
        plan_type: PERIODIC
        plan_currency: INR
        plan_recurring_amount: 10
        plan_max_amount: 100
        plan_max_cycles: 10
        plan_intervals: 2
        plan_interval_type: WEEK
        plan_note: Test Plan
      properties:
        plan_id:
          type: string
          description: Unique ID to identify the plan. Only alpha-numerics, dot, hyphen and underscore allowed.
          minLength: 1
          maxLength: 40
        plan_name:
          type: string
          description: Name of the plan.
          minLength: 1
          maxLength: 40
        plan_type:
          type: string
          description: Type of the plan. Possible values - PERIODIC, ON_DEMAND.
        plan_currency:
          type: string
          description: Currency of the plan. For plans in non-INR currency, please refer to [supported currencies](https://www.cashfree.com/docs/payments/international-payments/ipg/currencies-supported#full-currency-list).
        plan_recurring_amount:
          type: number
          format: float64
          description: Recurring amount for the plan. Required for PERIODIC plan_type.
        plan_max_amount:
          type: number
          format: float64
          description: Maximum amount for the plan.
        plan_max_cycles:
          type: integer
          description: Maximum number of payment cycles for the plan.
        plan_intervals:
          type: integer
          description: Number of billing cycles between charges. For instance, if set to 2 and the interval type is 'week',
            the service will be billed every 2 weeks. Similarly, if set to 3 and the interval type is 'month', the service
            will be billed every 3 months. Required for PERIODIC plan_type.
        plan_interval_type:
          type: string
          description: Interval type for the plan. Possible values - DAY, WEEK, MONTH, YEAR.
        plan_note:
          type: string
          description: Note for the plan.
      required:
      - plan_id
      - plan_name
      - plan_type
      - plan_max_amount
    ManageSubscriptionRequest:
      title: ManageSubscriptionRequest
      description: Request body to manage a subscription.
      example:
        subscription_id: Demo_Subscription
        action: CHANGE_PLAN
        action_details:
          plan_id: new-plan-1
      properties:
        subscription_id:
          type: string
          description: The unique ID which was used to create subscription.
        action:
          type: string
          description: Action to be performed on the subscription. Possible values - CANCEL, PAUSE, ACTIVATE, CHANGE_PLAN.
        action_details:
          type: object
          description: Details of the action to be performed.
          properties:
            next_scheduled_time:
              type: string
              description: |-
                Next scheduled time for the action. Required for ACTIVATE action.

                 Please note that only the date component is considered. Any time value provided will be ignored.
            plan_id:
              type: string
              description: Plan ID to update. Required for CHANGE_PLAN action.
      required:
      - subscription_id
      - action
    CreateSubscriptionRequest:
      title: CreateSubscriptionRequest
      description: Request body to create a subscription.
      example:
        subscription_id: Demo_Subscription
        customer_details:
          customer_name: john
          customer_email: john@dummy.com
          customer_phone: '9908730221'
          customer_bank_account_number: '59108290701802'
          customer_bank_ifsc: HDFC0002614
          customer_bank_code: HDFC
          customer_bank_account_type: SAVINGS
        plan_details:
          plan_name: plan12345
          plan_type: PERIODIC
          plan_amount: 10.0
          plan_max_amount: 100.0
          plan_max_cycles: 100
          plan_intervals: 2
          plan_currency: INR
          plan_interval_type: WEEK
          plan_note: Bi-weekly INR 10 plan
        authorization_details:
          authorization_amount: 100
          authorization_amount_refund: true
          payment_methods:
          - enach
          - pnach
          - upi
          - card
        subscription_meta:
          return_url: https://wa.me/9512440440?text=Payment%20Successfull
          notification_channel:
          - EMAIL
          - SMS
          session_id_expiry: '2025-06-01T23:00:08+05:30'
        subscription_expiry_time: '2100-01-01T23:00:08+05:30'
        subscription_first_charge_time: '2025-06-01T23:00:08+05:30'
        subscription_tags:
          psp_note: Monthly subscription payment
          custom_field: value
        subscription_payment_splits:
        - vendor_id: vendor1
          percentage: 10
        - vendor_id: vendor2
          percentage: 10
      properties:
        subscription_id:
          type: string
          description: A unique ID for the subscription. It can include alphanumeric characters, underscore, dot, hyphen,
            and space. Maximum characters allowed is 250.
          minLength: 1
          maxLength: 250
        customer_details:
          $ref: '#/components/schemas/SubscriptionCustomerDetails'
        plan_details:
          type: object
          properties:
            plan_id:
              type: string
              description: The unique identifier used to create plan. You only need to pass this field if you had already
                created plan. Otherwise use the other fields here to define the plan.
            plan_name:
              type: string
              description: Specify plan name for easy reference.
              maxLength: 40
            plan_type:
              type: string
              description: Possible values ON_DEMAND or PERIODIC. PERIODIC - Payments are triggered automatically at fixed
                intervals defined by the merchant. ON_DEMAND - Merchant needs to trigger/charge the customer explicitly with
                the required amount.
            plan_currency:
              type: string
              description: INR by default. For subscriptions in non-INR currency, please refer to [supported currencies](https://www.cashfree.com/docs/payments/international-payments/ipg/currencies-supported#full-currency-list).
            plan_amount:
              type: number
              format: float64
              description: The amount to be charged for PERIODIC plan. This is a conditional parameter, only required for
                PERIODIC plans.
            plan_max_amount:
              type: number
              format: float64
              description: This is the maximum amount that can be charged on a subscription.
            plan_max_cycles:
              type: integer
              description: Maximum number of debits set for the plan. The subscription will automatically change to COMPLETED
                status once this limit is reached.
            plan_intervals:
              type: integer
              description: Number of intervals of intervalType between every subscription payment. For example, to charge
                a customer bi-weekly use intervalType as “week” and intervals as 2. Required for PERIODIC plan. The default
                value is 1.
            plan_interval_type:
              type: string
              description: The type of interval for a PERIODIC plan like DAY, WEEK, MONTH, or YEAR. This is a conditional
                parameter only applicable for PERIODIC plans.
            plan_note:
              type: string
              description: Note for the plan.
        authorization_details:
          type: object
          properties:
            authorization_amount:
              type: number
              format: float64
              description: Amount to charge for the authorisation payment. For eNACH, authorization_amount is always 0.
                For UPI and card, the minimum value is ₹1.
            authorization_amount_refund:
              type: boolean
              description: Set to true to automatically refund the authorisation amount to the customer after the subscription
                is authorised. Set to false if you do not want the authorisation amount refunded automatically.
            payment_methods:
              type: array
              description: Payment methods for the subscription. enach, pnach, upi, card are possible values.
              items:
                type: string
        subscription_meta:
          type: object
          properties:
            return_url:
              type: string
              description: The url to redirect after checkout.
            notification_channel:
              type: array
              description: Notification channel for the subscription. SMS, EMAIL are possible values.
              items:
                type: string
            session_id_expiry:
              type: string
              description: Expiry date for the subscription session.
        subscription_expiry_time:
          type: string
          description: "Expiry date for the subscription. Cashfree stores timestamps in IST, but you can provide them in a\
            \ valid ISO 8601 time format.\n\nFor IST this `2025-06-01T10:20:12+05:30` translates to `2025-06-01 10:20:12`\
            \ \n\n For UTC this `2025-06-01T10:20:12Z` translates to `2025-06-01 15:50:12+05:30`."
        subscription_first_charge_time:
          type: string
          description: "Time at which the first charge will be made for the subscription after authorization. Applicable only\
            \ for PERIODIC plans. Cashfree stores timestamps in IST, but you can provide them in a valid ISO 8601 time format.\n\
            \nFor IST this `2025-06-01T10:20:12+05:30` translates to `2025-06-01 10:20:12` \n\n For UTC this `2025-06-01T10:20:12Z`\
            \ translates to `2025-06-01 15:50:12+05:30`."
        subscription_tags:
          type: object
          description: >-
            Custom tags for this subscription. You can include up to 10 entries as string key-value pairs.
            Use any key names that suit your integration. A commonly used key is psp_note, which sets the note displayed to the customer in their payment service provider (PSP) app or on their statement. When using psp_note, the value must be between 1 and 255 characters.
          example:
            psp_note: "Monthly subscription payment"
            custom_field: "value"
        subscription_payment_splits:
          type: array
          description: Payment splits for the subscription.
          items:
            $ref: '#/components/schemas/SubscriptionPaymentSplitItem'
      required:
      - subscription_id
      - customer_details
      - plan_details
    ManageSubscriptionPaymentRequest:
      title: ManageSubscriptionPaymentRequest
      description: Request body to manage a subscription payment.
      example:
        payment_id: Demo_Payment
        action: RETRY
        action_details:
          next_scheduled_time: '2024-01-10T23:00:08+05:30'
      properties:
        subscription_id:
          type: string
          description: The unique ID which was used to create subscription.
        payment_id:
          type: string
          description: The unique ID which was used to create payment.
        action:
          type: string
          description: Action to be performed on the payment. Possible values - CANCEL, RETRY.
        action_details:
          type: object
          description: Details of the action to be performed. Needed for retry action.
          properties:
            next_scheduled_time:
              type: string
              description: "Next scheduled time for the retry of the FAILED payment. Required for retry action. \n\n Please\
                \ note that only the date component is considered. Any time value provided will be ignored."
      required:
      - subscription_id
      - payment_id
      - action
    CreateSubscriptionPaymentRequest:
      title: CreateSubscriptionPaymentRequest
      description: Request body to raise a charge or create an authorisation for a subscription.
      properties:
        subscription_id:
          type: string
          description: A unique ID passed by merchant for identifying the subscription.
        subscription_session_id:
          type: string
          description: Session ID for the subscription. Required only for Auth.
        payment_id:
          type: string
          description: A unique ID passed by merchant for identifying the subscription payment.
        payment_amount:
          type: number
          format: float64
          description: The charge amount of the payment. Required in case of charge.
        payment_schedule_date:
          type: string
          description: |-
            The date on which the payment is scheduled to be processed. This field is required for UPI and CARD payment modes. Cashfree stores timestamps in IST, but you can provide them in a valid ISO 8601 time format.
            For IST this `2025-06-01T10:20:12+05:30` translates to `2025-06-01 10:20:12`.
            For UTC this `2025-06-01T10:20:12Z` translates to `2025-06-01 15:50:12+05:30`.


            Please note that only the date component is considered. Any time value provided will be ignored.
        payment_remarks:
          type: string
          description: Payment remarks.
        payment_type:
          type: string
          description: Payment type. Can be AUTH or CHARGE.
        payment_method:
          type: object
          description: Payment method. Can be one of ["upi", "enach", "pnach", "card"]. This field is not required when raising
            a charge. It is only mandatory when raising an authorisation. In the case of a charge, this field is ignored,
            and the charge will be created using the same payment method that was used for the original authorisation.
          oneOf:
          - $ref: '#/components/schemas/CreateSubscriptionPaymentRequestUpi'
          - $ref: '#/components/schemas/CreateSubscriptionPaymentRequestEnach'
          - $ref: '#/components/schemas/CreateSubscriptionPaymentRequestPnach'
          - $ref: '#/components/schemas/CreateSubscriptionPaymentRequestCard'
      required:
      - subscription_id
      - payment_id
      - payment_type
    CreateSubscriptionPaymentRequestUpi:
      title: CreateSubscriptionPaymentRequestUpi
      description: payment method upi.
      type: object
      properties:
        upi:
          type: object
          properties:
            channel:
              description: |-
                Channel. can be link or qrcode.
              type: string
            upi_id:
              type: string
    CreateSubscriptionPaymentRequestCard:
      title: CreateSubscriptionPaymentRequestCard
      type: object
      description: payment method card.
      properties:
        card:
          type: object
          properties:
            card_cvv:
              description: Card CVV.
              type: string
            card_expiry_mm:
              description: Card expiry month.
              type: string
            card_expiry_yy:
              description: Card expiry year.
              type: string
            card_holder_name:
              description: Card holder name.
              type: string
            card_network:
              description: Card network.
              type: string
            card_number:
              description: Card number.
              type: string
            card_type:
              description: Card type.
              type: string
            channel:
              description: Channel. can be link.
              type: string
    CreateSubscriptionPaymentRequestEnach:
      title: CreateSubscriptionPaymentRequestEnach
      type: object
      description: payment method enach.
      properties:
        enach:
          type: object
          properties:
            account_bank_code:
              description: Account bank code (mandatory). Consists of the first four alphabetic characters of the IFSC.
              type: string
            account_holder_name:
              description: Account holder name.
              type: string
            account_ifsc:
              description: Account IFSC (optional). Complete 11-character alphanumeric code.
              type: string
            account_number:
              description: Account number.
              type: string
            account_type:
              enum:
              - SAVINGS
              - CURRENT
              description: Account type.
              type: string
            auth_mode:
              description: Authentication mode. can be `debit_card`, `aadhaar`, or `net_banking`.
              type: string
            channel:
              description: Channel. can be link.
              type: string
    CreateSubscriptionPaymentRequestPnach:
      title: CreateSubscriptionPaymentRequestPnach
      type: object
      description: payment method pnach.
      properties:
        pnach:
          type: object
          properties:
            account_bank_code:
              description: Account bank code. Consists of the first four alphabetic characters of the IFSC.
              type: string
            account_holder_name:
              description: Account holder name.
              type: string
            account_ifsc:
              description: Account IFSC. Complete 11-character alphanumeric code.
              type: string
            account_number:
              description: Account number.
              type: string
            account_type:
              description: Account type.
              type: string
            channel:
              description: Channel. can be post.
              type: string
            mandate_creation_date:
              description: Mandate creation date.
              type: string
            mandate_start_date:
              description: Mandate start date.
              type: string
    ControlledAttemptFailureDetails:
      title: ControlledAttemptFailureDetails
      type: object
      description: Details of the failure associated with a controlled notification or execution attempt.
      properties:
        failure_reason:
          type: string
          description: Failure reason for the failed attempt.
        failure_error_code:
          type: string
          description: Error code mapped for the failed attempt.
        failure_sub_error_code:
          type: string
          description: The sub-error code associated with the failure.
    CreateControlledNotificationRequest:
      title: CreateControlledNotificationRequest
      description: Request body to create a controlled payment notification for a subscription mandate.
      type: object
      example:
        notification_id: basePay123-pdn1
        payment_amount: 10
        payment_id: basePay123
        payment_remarks: remarks
        payment_schedule_date: '2026-09-09T15:07:15+05:30'
        subscription_id: abcd
      properties:
        notification_id:
          type: string
          description: A unique ID passed by the merchant for identifying the controlled notification attempt.
        payment_amount:
          type: number
          format: float64
          description: The amount for which the payment notification is being raised.
        payment_id:
          type: string
          description: Base Payment ID for the controlled payment notification.
        payment_remarks:
          type: string
          description: Remarks for the controlled payment notification.
        payment_schedule_date:
          type: string
          description: The date on which the payment is scheduled to be processed, in ISO 8601 format (`YYYY-MM-DDTHH:mm:ss+05:30`). Cashfree uses only the date portion and ignores the time component. If you omit this parameter, the payment is scheduled for T+1. If you provide this parameter, the date must fall between T+1 and T+7, inclusive.
        subscription_id:
          type: string
          description: A unique ID passed by the merchant for identifying the subscription.
      required:
        - notification_id
        - payment_amount
        - payment_id
        - subscription_id
    CreateControlledNotificationResponse:
      title: CreateControlledNotificationResponse
      description: A controlled payment notification, with its notification status, payment amount and payment status.
      type: object
      example:
        cf_notification_id: "3333"
        cf_payment_id: "123456"
        notification_id: basePay123-pdn1
        notification_initiated_time: "2025-06-01T22:14:58+05:30"
        notification_status: INITIALIZED
        payment_amount: 10
        payment_id: basePay123
        payment_status: INITIALIZED
        subscription_id: abcd
      properties:
        cf_notification_id:
          type: string
          description: Cashfree-generated identifier for the controlled notification.
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        notification_id:
          type: string
          description: Merchant-provided identifier for the controlled notification.
        notification_initiated_time:
          type: string
          description: The timestamp when the controlled notification was initiated. Timestamps are in IST.
          format: ISO8601
          example: "2025-06-01T22:14:58+05:30"
        notification_status:
          type: string
          description: Status of the controlled payment notification.
        payment_amount:
          type: number
          format: float64
          description: Amount associated with the controlled payment notification.
        payment_id:
          type: string
          description: Base Payment ID associated with the controlled payment notification.
        payment_status:
          type: string
          description: Current status of the parent payment entity.
        subscription_id:
          type: string
          description: Subscription ID associated with the controlled payment notification.
    FetchControlledNotificationResponse:
      title: FetchControlledNotificationResponse
      description: A controlled payment notification, with its status, timestamps, payment details and any failure details.
      type: object
      properties:
        cf_notification_id:
          type: string
          description: Cashfree-generated identifier for the controlled notification.
        cf_order_id:
          type: string
          description: Cashfree subscription payment order ID.
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        cf_subscription_id:
          type: string
          description: Cashfree subscription reference number.
        cf_txn_id:
          type: string
          description: Cashfree subscription payment transaction ID.
        notification_attempted_time:
          type: string
          description: The timestamp when the controlled notification was attempted. Timestamps are in IST.
          format: ISO8601
        notification_completed_time:
          type: string
          description: The timestamp when the controlled notification was completed. Timestamps are in IST.
          format: ISO8601
        notification_failure_details:
          $ref: "#/components/schemas/ControlledAttemptFailureDetails"
        notification_id:
          type: string
          description: The unique merchant-provided identifier for the controlled notification.
        notification_initiated_time:
          type: string
          description: The timestamp when the controlled notification was initiated. Timestamps are in IST.
          format: ISO8601
        notification_status:
          type: string
          description: Status of the controlled payment notification.
        payment_amount:
          type: number
          format: float64
          description: Amount associated with the controlled payment notification.
        payment_id:
          type: string
          description: Base Payment ID associated with the controlled payment notification.
        payment_remarks:
          type: string
          description: Payment remarks for the controlled payment notification.
        payment_status:
          type: string
          description: Current status of the parent payment entity.
        subscription_id:
          type: string
          description: Subscription ID associated with the controlled payment notification.
    FetchControlledNotificationsResponse:
      title: FetchControlledNotificationsResponse
      description: A list of controlled payment notifications.
      type: array
      items:
        $ref: "#/components/schemas/FetchControlledNotificationResponse"
    CreateControlledExecutionRequest:
      title: CreateControlledExecutionRequest
      description: Request body to create a controlled charge execution for a subscription mandate.
      type: object
      example:
        execution_id: basePay123-exec1
        payment_id: basePay123
      properties:
        execution_id:
          type: string
          description: A unique ID passed by the merchant to identify the controlled execution attempt.
        payment_id:
          type: string
          description: Base Payment ID for which the controlled execution is being raised.
      required:
        - execution_id
        - payment_id
    CreateControlledExecutionResponse:
      title: CreateControlledExecutionResponse
      description: A controlled payment execution, with its execution status, payment amount and payment status.
      type: object
      properties:
        cf_execution_id:
          type: string
          description: Cashfree-generated identifier for the controlled execution.
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        execution_id:
          type: string
          description: Merchant-provided identifier for the controlled execution.
        execution_initiated_time:
          type: string
          description: The timestamp when the controlled execution was initiated. Timestamps are in IST.
          format: ISO8601
        execution_status:
          type: string
          description: Status of the controlled execution.
        payment_amount:
          type: number
          format: float64
          description: Amount associated with the controlled execution.
        payment_id:
          type: string
          description: Base Payment ID associated with the controlled execution.
        payment_status:
          type: string
          description: Current status of the parent payment entity.
        subscription_id:
          type: string
          description: Subscription ID associated with the controlled execution.
    FetchControlledExecutionResponse:
      title: FetchControlledExecutionResponse
      description: A controlled payment execution, with its status, timestamps, payment details and any failure details.
      type: object
      properties:
        cf_execution_id:
          type: string
          description: Cashfree-generated identifier for the controlled execution.
        cf_order_id:
          type: string
          description: Cashfree subscription payment order ID.
        cf_payment_id:
          type: string
          description: Cashfree subscription payment reference number.
        cf_subscription_id:
          type: string
          description: Cashfree subscription reference number.
        cf_txn_id:
          type: string
          description: Cashfree subscription payment transaction ID.
        execution_attempted_time:
          type: string
          description: The timestamp when the controlled execution was attempted. Timestamps are in IST.
          format: ISO8601
        execution_completed_time:
          type: string
          description: The timestamp when the controlled execution was completed. Timestamps are in IST.
          format: ISO8601
        execution_id:
          type: string
          description: The unique merchant-provided identifier for the controlled execution.
        execution_initiated_time:
          type: string
          description: The timestamp when the controlled execution was initiated. Timestamps are in IST.
          format: ISO8601
        execution_status:
          type: string
          description: Status of the controlled execution.
        failure_details:
          $ref: "#/components/schemas/ControlledAttemptFailureDetails"
        payment_amount:
          type: number
          format: float64
          description: Amount associated with the controlled execution.
        payment_id:
          type: string
          description: Base Payment ID associated with the controlled execution.
        payment_remarks:
          type: string
          description: Payment remarks associated with the controlled execution.
        payment_status:
          type: string
          description: Current status of the parent payment entity.
        subscription_id:
          type: string
          description: Subscription ID associated with the controlled execution.
    FetchControlledExecutionsResponse:
      title: FetchControlledExecutionsResponse
      description: A list of controlled payment executions.
      type: array
      items:
        $ref: "#/components/schemas/FetchControlledExecutionResponse"
    UploadPnachImageRequest:
      title: UploadPnachImageRequest
      description: Request body to upload a physical NACH image.
      properties:
        file:
          type: string
          format: binary
          description: Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload a
            file that is more than 1MB in size.
        payment_id:
          type: string
          description: Authorization Payment Id for physical nach authorization.
        action:
          type: string
          description: Action to be performed on the file. Can be SUBMIT_DOCUMENT.
      required:
      - action
      - payment_id
      - file
    UploadPnachImageResponse:
      title: UploadPnachImageResponse
      description: The authorisation status of an uploaded physical NACH image, with the action performed and a payment message.
      properties:
        payment_id:
          type: string
          description: The payment_id against which the pnach image is uploaded.
        authorization_status:
          type: string
          description: Authorization status of the subscription.
        action:
          type: string
          description: Action performed on the file.
        payment_message:
          type: string
          description: Message of the API.
    SubscriptionEligibilityRequest:
      title: SubscriptionEligibilityRequest
      description: Request body to fetch the payment methods available for subscription payments.
      properties:
        queries:
          type: object
          description: Necessary parameters to fetch eligible payment methods.
          properties:
            subscription_id:
              type: string
              description: A unique ID passed by merchant for identifying the subscription.
          required:
          - subscription_id
        filters:
          type: object
          description: Filters to refine eligible payment method selection.
          properties:
            payment_methods:
              type: array
              description: Possbile values in array - enach, pnach, upi, card.
              items:
                type: string
      required:
      - queries
    SubscriptionBankDetails:
      type: object
      description: Bank details object.
      properties:
        bank_id:
          type: string
          description: ID of the bank.
        bank_name:
          type: string
          description: Name of the bank.
        account_auth_modes:
          type: array
          items:
            type: string
          description: List of account authentication modes supported by the bank. (e.g. DEBIT_CARD, NET_BANKING, AADHAAR).
    EligibilityMethodItem:
      title: EligibilityMethodItem
      description: Eligibile payment method object.
      properties:
        eligibility:
          type: boolean
          description: Indicates whether the payment method is eligible.
        entity_type:
          type: string
          description: Type of entity (e.g., "payment_methods").
        entity_value:
          type: string
          description: Payment method (e.g., enach, pnach, upi, card).
        entity_details:
          type: object
          properties:
            account_types:
              type: array
              items:
                type: string
              description: List of account types associated with the payment method. (e.g. SAVINGS or CURRENT).
            frequent_bank_details:
              type: array
              description: List of the most frequently used banks.
              items:
                $ref: '#/components/schemas/SubscriptionBankDetails'
            all_bank_details:
              type: array
              description: Details about all banks associated with the payment method.
              items:
                $ref: '#/components/schemas/SubscriptionBankDetails'
            available_handles:
              type: array
              description: List of supported VPA handles.
              items:
                type: object
                properties:
                  handle:
                    type: string
                    description: VPA handle.
                  application:
                    type: string
                    description: Application or service related to the VPA handle.
            allowed_card_types:
              type: array
              description: List of allowed card types. (e.g. DEBIT_CARD, CREDIT_CARD).
              items:
                type: string
                description: List of allowed card types associated with the payment method.
    SubscriptionEligibilityResponse:
      title: SubscriptionEligibilityResponse
      description: The payment methods available for subscription payments.
      properties:
        type:
          type: array
          description: List of eligibile payment methods for the subscription.
          items:
            $ref: '#/components/schemas/EligibilityMethodItem'
    PARRequest:
      description: Request body to fetch the Payment Account Reference (PAR) for a card.
      type: object
      properties:
        card_number:
          type: string
          example: '4111111111111111'
          description: The card number, containing 15 to 19 numeric digits without spaces or special characters.
        card_cvv:
          type: string
          example: '123'
          description: The Card Verification Value (CVV), a 3-digit code for most cards (Visa, Mastercard) and a 4-digit code
            for American Express, used for transaction authentication.
        card_expiry_mm:
          type: string
          example: '12'
          description: The two-digit expiry month (01-12), indicating when the card will expire.
        card_expiry_yy:
          type: string
          example: '27'
          description: The two-digit expiry year, representing the last two digits of the card’s expiration year.
        card_type:
          type: string
          description: Specifies the type of card, with the only accepted value being `PLAIN_CARD`.
          enum:
          - PLAIN_CARD
      required:
      - card_number
      - card_cvv
      - card_expiry_mm
      - card_expiry_yy
      - card_type.
    IncidentObject:
      title: IncidentObject
      description: Represents an active incident entry in the ecosystem.
      type: object
      example: '#/components/examples/incidents_entity_list_example'
      properties:
        incident_id:
          type: string
          description: Unique identifier for the incident.
          example: incident_202434253459071
        incident_impact:
          type: string
          description: Impact level of the incident.
          enum:
          - HIGH
          - MEDIUM
          - LOW
          example: HIGH
        incident_message:
          type: string
          description: Description of the incident.
          example: We are facing issues with HDFC UPI transactions.
        incident_start_time:
          type: string
          description: Start time of the incident.
          example: '2024-06-01T14:00:00+05:30'
        incident_end_time:
          type: string
          nullable: true
          description: End time of the incident, or null if ongoing.
          example: '2024-06-02T14:00:00+05:30'
        incident_status:
          type: string
          description: Status of the incident.
          enum:
          - ACTIVE
          - UPCOMING
          - RESOLVED
          example: ACTIVE
        incident_type:
          type: string
          description: Type of the incident.
          enum:
          - SCHEDULED
          - UNSCHEDULED
          example: UNSCHEDULED
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/UPIDowntime'
          - $ref: '#/components/schemas/CardDowntime'
          - $ref: '#/components/schemas/NetBankingDowntime'
          - $ref: '#/components/schemas/WalletDowntime'
    IncidentByIdResponse:
      title: IncidentByIdResponse
      description: A downtime incident, with its impact, status, start and end times, and affected payment method.
      type: object
      properties:
        incident_id:
          type: string
          description: Unique identifier for the incident.
          example: incident_20240415091057099071
        incident_impact:
          type: string
          description: Impact level of the incident.
          enum:
          - HIGH
          - MEDIUM
          - LOW
          example: MEDIUM
        incident_message:
          type: string
          description: Description of the issue.
          example: Some UPI transactions are failing due to intermittent issues with NPCI.
        incident_start_time:
          type: string
          description: Start time of the incident.
          example: '2025-04-15T08:00:00Z'
        incident_end_time:
          type: string
          nullable: true
          description: End time of the incident, if applicable; null if still ongoing.
          example: '2025-04-16T08:00:00Z'
        incident_status:
          type: string
          description: Current status of the incident.
          enum:
          - ACTIVE
          - UPCOMING
          - RESOLVED
          example: ACTIVE
        incident_type:
          type: string
          description: Type of the incident.
          example: SCHEDULED
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/UPIDowntime'
          - $ref: '#/components/schemas/CardDowntime'
          - $ref: '#/components/schemas/NetBankingDowntime'
          - $ref: '#/components/schemas/WalletDowntime'
    UPIDowntime:
      type: object
      title: UPI Incident
      description: The UPI incident object will show details about the incident affecting UPI payments.
      example:
        upi:
          upi_issuer:
          - ALL_BANKS
          upi_psp:
          - ALL_PSP
          upi_vpa:
          - ybl
          is_npci_downtime: false
      properties:
        upi:
          type: object
          properties:
            upi_issuer:
              type: array
              items:
                type: string
              example:
              - ALL_BANKS
            upi_psp:
              type: array
              items:
                type: string
              example:
              - ALL_PSP
            upi_vpa:
              type: array
              items:
                type: string
              example:
              - ybl
            is_npci_downtime:
              type: boolean
              example: false
    CardDowntime:
      type: object
      title: Card Incident
      description: The Card incident object will show details about the incident affecting card payments.
      example:
        card:
          card_issuer:
          - State Bank of India
          card_type:
          - CREDIT_CARD
          card_network:
          - VISA
      properties:
        card:
          type: object
          properties:
            card_issuer:
              type: array
              items:
                type: string
              example:
              - State Bank of India
            card_type:
              type: array
              items:
                $ref: '#/components/schemas/CardDowntimeCardTypeEnum'
              example:
              - ALL_CARDS
            card_network:
              type: array
              items:
                $ref: '#/components/schemas/CardDowntimeCardNetworkEnum'
              example:
              - VISA
    NetBankingDowntime:
      type: object
      title: NetBanking Incident
      description: The Net Banking incident object will show details about the incident affecting net banking payments.
      example:
        net_banking:
          net_banking_issuer:
          - State Bank of India
          bank_code: '3012'
      properties:
        net_banking:
          type: object
          properties:
            net_banking_issuer:
              type: array
              items:
                type: string
              example:
              - Bank of Baroda
            bank_code:
              type: string
              example: '3012'
    WalletDowntime:
      type: object
      title: Wallet incident
      description: The Wallet incident object will show details about the incident affecting wallet payments.
      example:
        wallet:
          wallet_issuer:
          - Mobikwik
      properties:
        wallet:
          type: object
          properties:
            wallet_issuer:
              type: array
              items:
                type: string
              example:
              - Mobikwik
    GetCardBinResponseSchema:
      title: GetCardBinResponse
      description: Details of a card BIN, including the issuing bank, country, scheme and card type.
      example:
        bank_name: canara bank
        country_code: in
        scheme: visa
        sub_type: retail
        type: credit
      properties:
        bank_name:
          type: string
          description: Issuing bank name of the card. For example `hdfc bank`, `icici bank`, `axis bank`.
        country_code:
          type: string
          description: Issuing country of the card. For example `in`, `us`.
        scheme:
          type: string
          description: Card scheme/network of the card. For example `visa`, `mastercard`, `rupay`, `amex`, `diners`.
        sub_type:
          type: string
          description: Sub-type of card. Available options are `retail`, `premium` and `corporate`.
        type:
          type: string
          description: Type of card. Available options are `credit`, `debit` and `prepaid`.
    GetCardBinRequest:
      description: Request body to fetch card BIN details.
      type: object
      properties:
        card_number:
          type: string
          description: Card number, minimum first 8 digits are required.
          example: xxxx...xxx
      required:
      - card_number
    TransactionReturnSummary200Response:
      title: TransactionReturnSummary200Response
      description: A transaction return summary, with its generation status and a message.
      type: object
      example:
        data:
          paymentId: 123456
          status: GENERATED
          link: <download-link>
        message: Transaction return summary status fetched successfully.
        status: 200
      properties:
        data:
          type: object
          description: Transaction return summary data.
          properties:
            paymentId:
              type: integer
              description: Payment ID for which the summary is generated.
              example: 123456
            status:
              type: string
              description: Status of the summary generation (GENERATED or INITIALIZED).
              example: GENERATED
            link:
              type: string
              description: Download link for the summary (if status is GENERATED).
              example: <download-link>
        message:
          type: string
          description: Status message.
          example: Transaction return summary status fetched successfully.
        status:
          type: integer
          description: Status code of the response.
          example: 200
    CreateLinkPlanRequest:
      title: CreateLinkPlanRequest
      description: Request body to create a plan.
      properties:
        plan_id:
          type: string
          description: Unique ID to identify the plan. Only alpha-numerics, dot, hyphen and underscore allowed.
          minLength: 1
          maxLength: 40
        plan_name:
          type: string
          description: Name of the plan.
          minLength: 1
          maxLength: 40
        plan_type:
          type: string
          description: Type of the plan. Possible values - PERIODIC, ON_DEMAND.
        plan_currency:
          type: string
          description: Currency of the plan.
        plan_amount:
          type: number
          format: float64
          description: The amount to be charged for PERIODIC plan. This is a conditional parameter, only required for PERIODIC
            plans.
        plan_max_amount:
          type: number
          format: float64
          description: Maximum amount for the plan.
        plan_max_cycles:
          type: integer
          description: Maximum number of payment cycles for the plan.
        plan_intervals:
          type: integer
          description: Number of billing cycles between charges.
        plan_interval_type:
          type: string
          description: Interval type for the plan. Possible values - DAY, WEEK, MONTH, YEAR.
        plan_note:
          type: string
          description: Note for the plan.
      required:
      - plan_id
      - plan_name
      - plan_type
      - plan_max_amount
      example:
        plan_id: plan_12345
        plan_name: Plan 12345
        plan_type: PERIODIC
        plan_currency: INR
        plan_amount: 10
        plan_max_amount: 100
        plan_max_cycles: 10
        plan_intervals: 2
        plan_interval_type: WEEK
        plan_note: Test Plan
    LinkPlanEntity:
      title: link_plan
      description: Subscription plan details for recurring payments.
      type: object
      properties:
        plan_id:
          type: string
          description: Unique ID to identify the plan. Only alpha-numerics, dot, hyphen and underscore allowed.
        plan_name:
          type: string
          description: Name of the plan.
        plan_type:
          type: string
          description: Type of the plan. Possible values - PERIODIC, ON_DEMAND.
        plan_currency:
          type: string
          description: Currency of the plan.
        plan_amount:
          type: number
          format: float64
          description: The amount to be charged for PERIODIC plan. This is a conditional parameter, only required for PERIODIC
            plans.
        plan_max_amount:
          type: number
          format: float64
          description: Maximum amount for the plan.
        plan_max_cycles:
          type: integer
          description: Maximum number of payment cycles for the plan.
        plan_intervals:
          type: integer
          description: Number of billing cycles between charges.
        plan_interval_type:
          type: string
          description: Interval type for the plan. Possible values - DAY, WEEK, MONTH, YEAR.
        plan_note:
          type: string
          description: Note for the plan.
      example:
        plan_id: plan_12345
        plan_name: Plan 12345
        plan_type: PERIODIC
        plan_currency: INR
        plan_amount: 10
        plan_max_amount: 100
        plan_max_cycles: 10
        plan_intervals: 2
        plan_interval_type: WEEK
        plan_note: Test Plan
    LinkSubscriptionEntity:
      title: link_subscription
      description: Payment link subscription object for recurring payments.
      type: object
      properties:
        plan_details:
          $ref: '#/components/schemas/LinkPlanEntity'
        authorization_amount_refund:
          type: boolean
          description: Indicates whether the authorisation amount is refunded to the customer automatically after the
            subscription is authorised. If true, the authorisation amount is refunded automatically. If false, it is not
            refunded automatically.
        subscription_expiry_time:
          type: string
          description: Time at which the subscription will expire.
        subscription_first_charge_time:
          type: string
          description: Time at which the first charge for the subscription will be processed.
      example:
        plan_details:
          plan_id: plan_12345
          plan_name: Plan 12345
          plan_type: PERIODIC
          plan_currency: INR
          plan_amount: 10
          plan_max_amount: 100
          plan_max_cycles: 10
          plan_intervals: 2
          plan_interval_type: WEEK
          plan_note: Test Plan
        authorization_amount_refund: false
        subscription_expiry_time: '2029-10-14T15:04:05+05:30'
        subscription_first_charge_time: '2026-03-14T15:04:05+05:30'
    PayOrderAuthorizeOnlyRequest:
      title: PayOrderAuthorizeOnlyRequest
      type: object
      description: Request body to create an authorisation-only transaction using `payment_session_id`.
      properties:
        payment_session_id:
          type: string
          example: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        authorization_data:
          type: object
          description: Details required for authorization, received in authentication response from processor.
          properties:
            authentication_token:
              type: string
              example: kBJNBl+1CMCuowBk3i8SFDVh3f72
            directory_server_transaction_id:
              type: string
              example: 1171177d-1fa3-469f-8855-915b89645835
            three_ds_server_transaction_id:
              type: string
              example: d9661043-e83d-4fbd-9acf-4325572bd624
            eci:
              type: string
              example: '05'
            token_number:
              type: string
              example: token_number_example
            token_expiry_year:
              type: string
              example: '2030'
            token_expiry_month:
              type: string
              example: '12'
            token_cryptogram:
              type: string
              example: ANvr5FNoqJVmAW/uSVPHAAADFA==
            transaction_type:
              type: string
              enum:
              - ALT_ID
              - TOKEN
              - APPLE_PAY
              description: One of ALT_ID, TOKEN, APPLE_PAY, Indicator for authentication mode.
              example: TOKEN
      required:
      - payment_session_id
      - authorization_data
    Subscription:
      title: Subscription
      description: Use to create a subscription for a customer.
      type: object
      properties:
        authorization_amount:
          type: number
          description: Amount to charge for the authorisation payment. For eNACH, authorization_amount is always 0. For
            UPI and card, the minimum value is ₹1.
        plan_details:
          $ref: '#/components/schemas/CreateLinkPlanRequest'
        authorization_amount_refund:
          type: boolean
          description: Set to true to automatically refund the authorisation amount to the customer after the subscription
            is authorised. Set to false if you do not want the authorisation amount refunded automatically.
        subscription_expiry_time:
          type: string
          description: Time at which the subscription will expire.
        subscription_first_charge_time:
          type: string
          description: Time at which the first charge for the subscription will be processed.
      example:
        plan_details:
          plan_id: plan_12345
          plan_name: Plan 12345
          plan_type: PERIODIC
          plan_currency: INR
          plan_amount: 10
          plan_max_amount: 100
          plan_max_cycles: 10
          plan_intervals: 2
          plan_interval_type: WEEK
          plan_note: Test Plan
        authorization_amount: 1
        authorization_amount_refund: false
        subscription_expiry_time: '2100-01-01T05:29:59+05:30'
        subscription_first_charge_time: '2100-01-01T04:29:59+05:30'
  parameters:
    apiVersionHeader:
      in: header
      name: x-api-version
      required: true
      description: API version to be used. Format is in YYYY-MM-DD.
      schema:
        type: string
        description: API version to be used.
        default: '2026-01-01'
      example: '2026-01-01'
      x-ignore: true
    cfPaymentIDParam:
      name: cf_payment_id
      in: path
      required: true
      description: The Cashfree payment or transaction ID.
      schema:
        type: string
      example: '121224562'
    customerIDParam:
      name: customer_id
      in: path
      required: true
      description: The customer ID provided by the merchant during the [Create Order API](https://www.cashfree.com/docs/api-reference/payments/latest/orders/create)
        call, used to save cards for the customer.
      schema:
        type: string
      example: your-customer-id
    linkIDParam:
      name: link_id
      in: path
      required: true
      description: The payment link ID for which you want to view the details.
      schema:
        type: string
      example: your-link-id
    statusQueryParam:
      name: status
      in: query
      required: false
      description: 'Mention What is status of orders you want to fetch, default is PAID. Possible value: ALL, PAID.'
      schema:
        type: string
      example: ALL
    incidentIdQueryParam:
      name: incident_id
      in: query
      required: false
      description: Valid incident id for fetching incident details.
      schema:
        type: string
      example: your-incident-id
    incidentStatusQueryParam:
      name: incident_status
      in: query
      required: false
      description: 'Filter incidents by status. Possible values: ACTIVE, UPCOMING, RESOLVED.'
      schema:
        type: array
        items:
          type: string
          enum:
          - ACTIVE
          - UPCOMING
          - RESOLVED
      example:
      - ACTIVE
      - RESOLVED
    incidentImpactQueryParam:
      name: incident_impact
      in: query
      required: false
      description: 'Filter incidents by impact level. Possible values: HIGH, MEDIUM, LOW.'
      schema:
        type: array
        items:
          type: string
          enum:
          - HIGH
          - MEDIUM
          - LOW
      example:
      - HIGH
      - MEDIUM
    incidentTypeQueryParam:
      name: incident_type
      in: query
      required: false
      description: 'Filter incidents by type. Possible values: SCHEDULED, UNSCHEDULED.'
      schema:
        type: array
        items:
          type: string
          enum:
          - SCHEDULED
          - UNSCHEDULED
      example:
      - UNSCHEDULED
    incidentStartTimeQueryParam:
      name: incident_start_time
      in: query
      required: false
      description: 'Filter incidents by start time. Format: YYYY-MM-DD HH:MM:SS.'
      schema:
        type: string
        format: date-time
      example: '2024-06-01 14:00:00'
    incidentEndTimeQueryParam:
      name: incident_end_time
      in: query
      required: false
      description: 'Filter incidents by end time. Format: YYYY-MM-DD HH:MM:SS.'
      schema:
        type: string
        format: date-time
      example: '2024-06-02 14:00:00'
    incidentPaymentMethodQueryParam:
      name: payment_method
      in: query
      required: false
      description: 'Filter incidents by payment method. Possible values: UPI, CARD, NET_BANKING, WALLET.'
      schema:
        type: array
        items:
          type: string
          enum:
          - UPI
          - CARD
          - NET_BANKING
          - WALLET
      example:
      - UPI
      - CARD
    orderIDParam:
      name: order_id
      in: path
      required: true
      description: The ID which uniquely identifies your order.
      schema:
        type: string
      example: your-order-id
    vendorIDParam:
      name: vendor_id
      in: path
      required: true
      description: The id which uniquely identifies your vendor.
      schema:
        type: string
      example: your-vendor-id
    amountParam:
      name: amount
      in: path
      required: true
      description: Specify the amount for which you want to view the service charges and service taxes in the response.
      schema:
        type: number
        format: float64
      example: 1000
    rateTypeParam:
      name: rate_type
      in: query
      required: true
      description: 'Mention the type of rate for which you want to check the charges. Possible value: VENDOR_ON_DEMAND.'
      schema:
        type: string
      example: VENDOR_ON_DEMAND
    docTypeParam:
      name: doc_type
      in: path
      required: true
      description: Mention the document type that has to be downloaded. Only an uploaded document can be downloaded.
      schema:
        type: string
    xIdempotencyKeyHeader:
      in: header
      name: x-idempotency-key
      required: false
      description: |
        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.
      schema:
        type: string
        format: UUID
      example: 47bf8872-46fe-11ee-be56-0242ac120002
    xRequestIDHeader:
      in: header
      name: x-request-id
      description: Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related
        queries to Cashfree.
      required: false
      schema:
        type: string
      example: 4dfb9780-46fe-11ee-be56-0242ac120002
    planIdParam:
      name: plan_id
      in: path
      example: plan-id-123
      required: true
      description: Provide the plan ID for which the details have to be fetched.
      schema:
        type: string
    subscriptionIdParam:
      name: subscription_id
      in: path
      example: subscription-id-123
      required: true
      description: Provide the SubscriptionId using which the subscription was created.
      schema:
        type: string
    subscriptionPaymentIdParam:
      name: payment_id
      in: path
      example: payment-id-123
      required: true
      description: Provide the PaymentId using which the payment was created.
      schema:
        type: string
    controlledNotificationIdParam:
      name: notification_id
      in: path
      example: basePay123-pdn1
      required: true
      description: Provide the Notification ID for which the details have to be fetched.
      schema:
        type: string
    controlledExecutionIdParam:
      name: execution_id
      in: path
      example: basePay123-exec1
      required: true
      description: Provide the Execution ID for which the details have to be fetched.
      schema:
        type: string
    subscriptionRefundIdParam:
      name: refund_id
      in: path
      example: refund-id-123
      required: true
      description: Provide the PaymentId for which the details have to be fetched.
      schema:
        type: string
    xClientBrowserHeader:
      in: header
      name: x-client-browser
      required: false
      description: Accepted values are `safari`, `chrome`, `firefox`, and `edge`. Required for UPI Collect requests.
      schema:
        type: string
        enum:
        - safari
        - chrome
        - firefox
        - edge
      example: safari
    xClientDeviceHeader:
      in: header
      name: x-client-device
      required: false
      description: Accepted values are `mobile`, `desktop`, and `tablet`. Required for UPI Collect requests.
      schema:
        type: string
        enum:
        - mobile
        - desktop
        - tablet
      example: mobile
    xClientOsHeader:
      in: header
      name: x-client-os
      required: false
      description: The client device's operating system. This header is required for UPI Collect requests. The only accepted value is `ios`.
      schema:
        type: string
        enum:
        - ios
      example: ios
    xClientRenderingTypeHeader:
      in: header
      name: x-client-rendering-type
      required: false
      description: Accepted values are `mweb`, `webview`, and `native`. Required for UPI Collect requests when `x-client-device`
        is `mobile`. `mweb` renders the payment in a mobile browser, `webview` renders it inside an in-app browser, and `native`
        renders it natively inside a mobile app using SDKs.
      schema:
        type: string
        enum:
        - mweb
        - webview
        - native
      example: mweb
  requestBodies:
    VendorReconRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorReconRequest'
    AuthorizeOrderRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthorizeOrderRequest'
          examples:
            capture:
              value:
                action: CAPTURE
                amount: 100
            void:
              value:
                action: VOID
    CreateCustomerRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateCustomerRequest'
          examples:
            create_customer:
              $ref: '#/components/examples/create_customer'
    CreateLinkRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateLinkRequest'
    SimulateRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimulateRequest'
          examples:
            payment_failure_simulation:
              value:
                entity: PAYMENTS
                entity_id: '14934289844'
                entity_simulation:
                  payment_status: FAILED
                  payment_error_code: ISSUER_NOT_AVAILABLE
            subscription_payment_success_simulation:
              value:
                entity: SUBS_PAYMENTS
                entity_id: '9881282748'
                entity_simulation:
                  payment_status: SUCCESS
                  payment_error_code: ''
            vba_payment_success_simulation:
              value:
                entity: VBA_TRANSFER
                entity_id: 808080800132ORIGIN
                vba_simulation:
                  vba_ifsc: YESB0CMSNOC
                  utr: utr
                  amount: 10
                  remitter_account: 808081pxqp242614HW
                  remitter_ifsc: IFSC,
                  remitter_name: Test,
                  phone: 1234567891
    SimulateSettlementRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimulateSettlementRequest'
          examples:
            success_simulation:
              value:
                merchantOrderIds:
                - 7b6bd177-ce98-43bd-b4b2-0d341fbb0d63
                - 7b6bd2b7-c8h8-43bd-7g2h-9hc98h3482h2
                - 99bfb2b7-c8h8-0hbd-7g93-9uw9hg93bh93
                status: SUCCESS
            failed_simulation:
              value:
                txnTime: '2025-05-01 13:00:00'
                status: FAILED
                errorReason: Due to some technical issues, your amount will be settled in the next settlement cycle.
            pending_simulation:
              value:
                merchantOrderIds:
                - 7b6bd177-ce98-43bd-b4b2-0d341fbb0d63
                - 7b6bd2b7-c8h8-43bd-7g2h-9hc98h3482h2
                status: PENDING
    SimulateVendorSettlementRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimulateVendorSettlementRequest'
          examples:
            success_simulation:
              value:
                merchant_vendor_id: vendor-001
                txn_time: '2026-01-01 10:00:00'
                status: SUCCESS
            failed_simulation:
              value:
                merchant_vendor_id: vendor-001
                merchant_order_ids:
                - 7b6bd177-ce98-43bd-b4b2-0d341fbb0d63
                status: FAILED
                error_reason: Due to some technical issues, your amount will be settled in the next settlement cycle.
            initiated_simulation:
              value:
                merchant_vendor_id: vendor-001
                txn_time: '2026-01-01 10:00:00'
                status: INITIATED
    CreateOfferRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOfferRequest'
          examples:
            card_offer:
              $ref: '#/components/examples/card_offer'
            net_banking_offer:
              $ref: '#/components/examples/net_banking_offer'
            emi_offer:
              $ref: '#/components/examples/no_cost_emi_offer'
    CreateOrderRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOrderRequest'
          examples:
            order_with_minimum_fields:
              $ref: '#/components/examples/order_with_minimum_fields'
            order_with_order_id:
              $ref: '#/components/examples/order_with_order_id'
            order_with_customer_details:
              $ref: '#/components/examples/order_with_customer_details'
            order_with_return_url:
              $ref: '#/components/examples/order_with_return_url'
            order_with_payment_methods:
              $ref: '#/components/examples/order_with_payment_methods'
            order_with_tags:
              $ref: '#/components/examples/order_with_tags'
            order_split_by_amount_tags:
              $ref: '#/components/examples/order_split_by_amount_tags'
            order_split_by_percentage:
              $ref: '#/components/examples/order_split_by_percentage'
            order_with_invoice_details:
              $ref: '#/components/examples/order_with_invoice_details'
            order_tpv:
              $ref: '#/components/examples/order_tpv'
            order_with_payment_methods_filters:
              $ref: '#/components/examples/order_with_payment_methods_filters'
            order_bbps:
              $ref: '#/components/examples/order_bbps'
            order_bbps_bills:
              $ref: '#/components/examples/order_bbps_bills'
            order_bbps_pay_together:
              $ref: '#/components/examples/order_bbps_pay_together'
    UpdateOrderExtendedRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateOrderExtendedRequest'
          examples:
            order_extended_minimum:
              $ref: '#/components/examples/order_extended_minimum'
            order_extended_delivery_status:
              $ref: '#/components/examples/order_extended_delivery_status'
            order_extended_all_field:
              $ref: '#/components/examples/order_extended_all_field'
    CreateTerminalRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateTerminalRequest'
    CreateTerminalTransactionRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateTerminalTransactionRequest'
    EligibilityFetchCardlessEMIRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EligibilityFetchCardlessEMIRequest'
          examples:
            eligibility_cardless_emi:
              $ref: '#/components/examples/eligibility_cardless_emi'
    EligibilityFetchOffersRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EligibilityFetchOffersRequest'
          examples:
            offers:
              $ref: '#/components/examples/eligible_offers'
            no_cost_emi_offers:
              $ref: '#/components/examples/eligible_no_cost_emi_offers'
    EligibilityFetchPaylaterRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EligibilityFetchPaylaterRequest'
          examples:
            eligible_paylater:
              $ref: '#/components/examples/eligible_paylater'
    EligibilityFetchPaymentMethodsRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EligibilityFetchPaymentMethodsRequest'
          examples:
            eligible_all_payment_methods:
              $ref: '#/components/examples/eligible_all_payment_methods'
            eligible_card_payment_methods:
              $ref: '#/components/examples/eligible_card_payment_methods'
            eligible_netbanking_payment_methods:
              $ref: '#/components/examples/eligible_netbanking_payment_methods'
    FetchReconRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FetchReconRequest'
    FetchSettlementsRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FetchSettlementsRequest'
    OrderAuthenticatePaymentRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrderAuthenticatePaymentRequest'
          examples:
            submit_otp:
              $ref: '#/components/examples/submit_otp'
            resend_otp:
              $ref: '#/components/examples/resend_otp'
    OrderCreateRefundRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrderCreateRefundRequest'
    OrderUpdateRefundRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrderUpdateRefundRequest'
    GetAllTerminalTransactionRequest:
      required: false
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetAllTerminalTransactionRequest'
          examples:
            filter:
              $ref: '#/components/examples/terminal_filter'
    PayOrderRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayOrderRequest'
          examples:
            upi_intent:
              $ref: '#/components/examples/upi_intent'
            upi_collect:
              $ref: '#/components/examples/upi_collect'
            upi_qr:
              $ref: '#/components/examples/upi_qr'
            upi_podqr:
              $ref: '#/components/examples/upi_podqr'
            upi_collect_redirect:
              $ref: '#/components/examples/upi_collect_redirect'
            card_plain:
              $ref: '#/components/examples/card_plain'
            card_saved_token:
              $ref: '#/components/examples/card_saved_token'
            card_external_alt_id:
              $ref: '#/components/examples/card_external_alt_id'
            card_external_token:
              $ref: '#/components/examples/card_external_token'
            card_headless_otp_payment:
              $ref: '#/components/examples/card_headless_otp_payment'
            netbanking_by_name:
              $ref: '#/components/examples/netbanking_by_name'
            netbanking_by_code:
              $ref: '#/components/examples/netbanking_by_code'
            emi_cc:
              $ref: '#/components/examples/emi_cc'
            wallet_app:
              $ref: '#/components/examples/wallet_app'
            banktransfer:
              $ref: '#/components/examples/banktransfer'
    SettlementFetchReconRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SettlementFetchReconRequest'
    CreateOrderSettlementRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOrderSettlementRequestBody'
          example:
            order_id: order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H
            meta_data:
              cbriks_id: CBRIKS_004
              settlement_date: '2024-04-12'
    CreateVendorRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateVendorRequest'
          examples:
            PG - Bank Account:
              value:
                vendor_id: vendortest123
                status: ACTIVE
                name: customer
                email: johndoe@cashfree.com
                phone: 9876543210
                verify_account: true
                dashboard_access: true
                schedule_option: 1
                bank:
                  account_number: 12345678890
                  account_holder: John Doe
                  ifsc: HDFC019345
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  uidai: 753624181019
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                  pan: BIAPA2934N
                  passport_number: L6892603
            PG - UPI:
              value:
                vendor_id: vendortest123
                status: ACTIVE
                name: customer
                email: johndoe@cashfree.com
                phone: 9876543210
                verify_account: true
                dashboard_access: true
                schedule_option: 1
                upi:
                  vpa: success@upi
                  account_holder: JOHN DOE
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  uidai: 753624181019
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                  pan: BIAPA2934N
                  passport_number: L6892603
            PG - Auto Collect:
              value:
                vendor_id: devtest23
                name: customer
                email: johndoe@cashfree.com
                phone: 9876543454
                verify_account: false
                dashboard_access: true
                bank:
                  account_number: 026291800001191
                  account_holder: John Doe
                  ifsc: YESB0000262
                kyc_details:
                  account_type: INDIVIDUAL
                  business_type: NBFC
                  uidai: 456712345678
                  pan: AFDHK1234F
    StaticSplitRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StaticSplitRequest'
          examples:
            PG:
              value:
                active: true
                terminal_id: 0
                product_type: PG
                scheme:
                - merchant_vendor_id: EsTest1Success
                  percentage: 10
            Subscriptions:
              value:
                active: true
                terminal_id: 152718
                product_type: SBC
                scheme:
                - merchant_vendor_id: da15
                  percentage: 10
                - merchant_vendor_id: vsinte1
                  percentage: 10
    ESOrderReconRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ESOrderReconRequest'
          example:
            filters:
              start_date: null
              end_date: null
              order_ids:
              - order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X
    SplitAfterPaymentRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SplitAfterPaymentRequest'
          examples:
            PG:
              value:
                split:
                - vendor_id: test03
                  percentage: 10
                  tags:
                    product: Dri-Fit trouser
                    size: L
                    AWB: NIKE12334
                disable_split: true
            Auto Collect:
              value:
                split:
                - vendorId: Vendor001
                  percentage: 10
                disable_split: true
    AdjustVendorBalanceRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AdjustVendorBalanceRequest'
          examples:
            PG:
              value:
                transfer_from: VENDOR
                transfer_type: ON_DEMAND
                transfer_amount: 10
                remark: Testing
                tags:
                  size: 1
                  product: SHRT
    UpdateVendorRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateVendorRequest'
          examples:
            PG - Bank Account:
              value:
                status: ACTIVE
                name: customer
                email: johndoe@cashfree.com
                phone: 9876543210
                verify_account: true
                dashboard_access: true
                schedule_option: 1
                bank:
                  account_number: 12345678890
                  account_holder: John Doe
                  ifsc: HDFC019345
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  uidai: 753624181019
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                  pan: BIAPA2934N
                  passport_number: L6892603
            PG - UPI:
              value:
                status: ACTIVE
                name: customer
                email: johndoe@cashfree.com
                phone: 9876543210
                verify_account: true
                dashboard_access: true
                schedule_option: 1
                upi:
                  vpa: success@upi
                  account_holder: JOHN DOE
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  uidai: 753624181019
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                  pan: BIAPA2934N
                  passport_number: L6892603
            PG - Auto Collect:
              value:
                name: john
                email: john.s@cashfree.com
                phone: 9600176784
                upi:
                  vpa: number@paytm
                  account_holder: holder
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  uidai: 753624181019
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                  pan: BIAPA2934N
                  passport_number: L6892603
    VendorAdjustmentRequestBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorAdjustmentRequest'
          examples:
            PG:
              value:
                vendor_id: test_123
                adjustment_id: 1234567
                amount: 10
                type: CREDIT
                remarks: Testing
    UpdateTerminalRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateTerminalRequest'
    UpdateTerminalStatusRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateTerminalStatusRequest'
    UploadTerminalDocs:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UploadTerminalDocs'
    TerminateOrderRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TerminateOrderRequest'
    CreateSubscriptionRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionRequest'
    ManageSubscriptionRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ManageSubscriptionRequest'
    CreatePlanRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreatePlanRequest'
    CreateSubscriptionPaymentRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionPaymentRequest'
          examples:
            create_subscription_charge:
              $ref: '#/components/examples/create_subscription_charge'
            create_subscription_auth_upi_link:
              $ref: '#/components/examples/create_subscription_auth_upi_link'
            create_subscription_auth_upi_collect:
              $ref: '#/components/examples/create_subscription_auth_upi_collect'
            create_subscription_auth_upi_qrcode:
              $ref: '#/components/examples/create_subscription_auth_upi_qrcode'
            create_subscription_auth_card:
              $ref: '#/components/examples/create_subscription_auth_card'
            create_subscription_auth_enach:
              $ref: '#/components/examples/create_subscription_auth_enach'
            create_subscription_auth_pnach:
              $ref: '#/components/examples/create_subscription_auth_pnach'
    CreateControlledNotificationRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateControlledNotificationRequest"
          examples:
            create_controlled_notification:
              $ref: "#/components/examples/create_controlled_notification"
    CreateControlledExecutionRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateControlledExecutionRequest"
          examples:
            create_controlled_execution:
              $ref: "#/components/examples/create_controlled_execution"
    UploadPnachImageRequest:
      required: true
      content:
        multipart/form-data:
          schema:
            title: UploadPnachImageRequest
            description: Request Body to upload Physical Nach Image.
            properties:
              file:
                type: string
                format: binary
                description: Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload
                  a file that is more than 1MB in size.
              payment_id:
                type: string
                description: Authorization Payment Id for physical nach authorization.
              action:
                type: string
                description: Action to be performed on the file. Can be SUBMIT_DOCUMENT.
            required:
            - action
            - payment_id
            - file
          examples:
            Physical Nach Image:
              value:
                action: UPLOAD
                file: '@''/Users/john/Downloads/pan.jpeg'''
                payment_id: payment-1234
    SubscriptionEligibilityRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionEligibilityRequest'
          examples:
            no filters:
              value:
                queries:
                  subscription_id: test-subscription-1
                filters:
                  payment_methods: []
            upi and enach filter:
              value:
                queries:
                  subscription_id: test-subscription-1
                filters:
                  payment_methods:
                  - upi
                  - enach
    CreateSubscriptionRefundRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSubscriptionRefundRequest'
    ManageSubscriptionPaymentRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ManageSubscriptionPaymentRequest'
    PARRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PARRequest'
    GetCardBinRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetCardBinRequest'
    PayOrderAuthorizeOnlyRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayOrderAuthorizeOnlyRequest'
  responses:
    Response400VendorRecon:
      description: Vendor Recon Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Minimum pagination limit:
              value:
                message: 'pagination.limit : should be at least 10'
                code: pagination.limit_invalid
                type: invalid_request_error
            Maximum pagination limit:
              value:
                message: 'pagination.limit : should be at max 1000'
                code: pagination.limit_invalid
                type: invalid_request_error
            Invalid start or end time format:
              value:
                message: time should be ISO8601 string. Example 2021-07-02T10:20:12+05:30 for IST, 2021-07-02T10:20:12Z for
                  UTC
                code: order_expiry_time_invalid
                type: invalid_request_error
            Start date greater than end date:
              value:
                message: start date can not be greater than end date
                code: order_expiry_time_invalid
                type: invalid_request_error
            Invalid cursor:
              value:
                message: invalid character '\n' in literal null (expecting 'l')
                code: request_failed
                type: invalid_request_error
    Response400:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
      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'
    Response401:
      description: Authentication Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthenticationError'
      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'
    Response404:
      description: Resource Not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError404'
      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'
    Response409:
      description: Resource already present.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError409'
      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'
    Response422:
      description: Idempotency error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IdempotencyError'
      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'
    Response429:
      description: Rate Limit Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
      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'
    Response500:
      description: API related Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      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'
    Response502:
      description: Bank related Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError502'
      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'
    GetVendorBalanceSuccessResponse:
      description: Success response for fetching a vendor's on-demand balance.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorBalance'
          examples:
            PG:
              value:
                merchant_id: 152707
                vendor_id: test03
                merchant_unsettled: 2412
                vendor_unsettled: 0
    GetVendorBalanceTransferChargesSuccessResponse:
      description: Success response for fetching vendor balance transfer charges.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorBalanceTransferCharges'
          examples:
            PG:
              value:
                service_charges: 20
                service_tax: 3.6
                amount: 1000
                billed_to: MERCHANT
                is_postpaid: true
    uploadVendorDocsSuccessResponse:
      description: Success response for uploading vendor documents.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UploadVendorDocumentsResponse'
          examples:
            PG:
              value:
                vendor_id: johntest11111
                doc_type: CIN
                doc_value: easySplit/vendorKycDocs/152707/93117/CIN-Fue.pdf
                status: IN_REVIEW
                remarks: null
            Auto Collect:
              value:
                vendor_id: johntest11111
                doc_type: CIN
                doc_value: easySplit/vendorKycDocs/152707/93117/CIN-Fue.pdf
                status: IN_REVIEW
                remarks: null
    StaticSplitSuccessResponse:
      description: Success response for creating a static split configuration.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StaticSplitResponse'
          examples:
            PG:
              value:
                product_type: PG
                terminal_id: 0
                terminal_reference_id: null
                active: true
                scheme:
                - merchant_vendor_id: EsTest1Success
                  percentage: 10
                added_on: '2023-06-08 15:45:46'
            Subscription:
              value:
                active: true
                productType: SBC
                terminalId: 152718
                terminalRefId: null
                scheme:
                - merchantVendorId: vsinte1
                  amount: null
                  percentage: 10
                  tags: null
                - merchantVendorId: da15
                  amount: null
                  percentage: 10
                  tags: null
                addedOn: '2023-07-04 16:44:53'
    ESOrderReconSuccessResponse:
      description: Success response for fetching split and settlement details by order ID.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ESOrderReconResponse'
          examples:
            PG:
              value:
                cursor: null
                data:
                - amount: 900000
                  settlement_eligibility_time: '2024-01-08 11:30:00'
                  merchant_order_id: order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X
                  tx_time: '2024-01-08 17:00:00'
                  settled: 'NO'
                  entity_id: '14910180251'
                  merchant_settlement_utr: N/A
                  currency: INR
                  sale_type: CREDIT
                  customer_name: Manideep
                  customer_email: manideep.ellur@cashfree.com
                  customer_phone: '8281554863'
                  merchant_vendor_commission: '810000.00'
                  split_service_charge: '900.00'
                  split_service_tax: '162.00'
                  pg_service_tax: '4698.90'
                  pg_service_charge: '26105.00'
                  pg_charge_postpaid: '1'
                  merchant_settlement_id: N/A
                  added_on: '2024-01-08 17:00:00'
                  tags: tags
                  entity_type: transaction
                  settlement_initiated_on: N/A
                  settlement_time: N/A
                  order_splits:
                  - split:
                    - merchant_vendor_id: vendor20Lakh
                      percentage: 90
                      tags: null
                    created_at: '2024-01-08 17:00:01'
                  eligible_split_balance: '0.00'
                - amount: 810000
                  merchant_order_id: order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X
                  tx_time: '2024-01-08 17:00:00'
                  settled: 'YES'
                  entity_id: '305293'
                  merchant_vendor_id: vendor20Lakh
                  currency: INR
                  sale_type: CREDIT
                  customer_name: Manideep
                  customer_email: manideep.ellur@cashfree.com
                  customer_phone: '8281554863'
                  added_on: '2024-01-08 17:00:01'
                  entity_type: vendor_commission
                  past_settlements:
                  - settlement_id: 54878
                    settlement_initiated_on: '2024-01-08 17:14:38'
                    status: SUCCESS
                  vendor_split_service_charges: '0.00'
                  vendor_split_service_tax: '0.00'
                  vendor_settlement_time: '2024-01-08 17:14:39'
                  vendor_settlement_initiated_on: '2024-01-08 17:14:38'
                  vendor_settlement_eligibility_time: '2024-01-08 16:50:00'
                  vendor_settlement_id: '54878'
                  vendor_settlement_utr: '1704714278653975'
                  vendor_commission: '810000.00'
                  vendor_pg_service_charge: '0.00'
                  vendor_pg_service_tax: '0.00'
                  status: N/A
                limit: 2
            Auto Collect:
              value:
                message: Order settlement details
                status: OK
                orderAmount: 500
                orderSplit:
                - vendorId: vendorId1
                  amount: 123
                - vendorId: vendorId2
                  percentage: 20
                - vendorId: vendorId3
                  amount: 150
                serviceCharge: 5
                serviceTax: 0.9
                splitServiceCharge: 7.5
                splitServiceTax: 1.35
                settlementAmount: 112.25
                settlementEligiblityDate: '2022-10-14 15:00:00'
                vendors:
                - id: vendorId1
                  settlementId: 81
                  settlementAmount: 123
                  settlementEligibilityDate: '2022-10-14 15:00:00'
                - id: vendorId2
                  settlementId: 82
                  settlementAmount: 100
                  settlementEligibilityDate: '2022-10-14 15:00:00'
                - id: vendorId3
                  settlementId: 84
                  settlementAmount: 150
                  settlementEligibilityDate: '2022-10-14 15:00:00'
    SplitAfterPaymentSuccessResponse:
      description: Success response for creating a split after payment.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SplitAfterPaymentResponse'
          examples:
            PG:
              value:
                message: Order split created
                status: OK
            Auto Collect:
              value:
                message: Order split created
                status: OK
    adjustVendorBalanceSuccessResponse:
      description: Success response for creating an on-demand transfer for a vendor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AdjustVendorBalanceResponse'
          examples:
            PG:
              value:
                settlement_id: 1050232
                transfer_details:
                  vendor_id: test03
                  transfer_from: VENDOR
                  transfer_type: ON_DEMAND
                  transfer_amount: 10
                  remark: Testing
                  tags:
                    product: Paneer Tikka
                    size: L
                    AWB: PNRTKKA12334
                balances:
                  merchant_id: 152707
                  vendor_id: test03
                  merchant_unsettled: 2442
                  vendor_unsettled: 4757.42
                charges:
                  service_charges: 2
                  service_tax: 0.36
                  amount: 10
                  billed_to: MERCHANT
                  is_postpaid: true
    downloadVendorDocsSuccessResponse:
      description: Success response for downloading a vendor document.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorDocumentDownloadResponse'
          examples:
            PG:
              value:
                download_url: https://cashfreelogo.cashfree.com/cashfree
            Auto Collect:
              value:
                download_url: https://cashfreelogo.cashfree.com/cashfree
    getVendorDocsSuccessResponse:
      description: Success response for fetching the status of a vendor's documents.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorDocumentsResponse'
          examples:
            PG:
              value:
                related_docs:
                - vendor_id: johntest11111
                  doc_type: CIN_NUMBER
                  doc_value: L00000Aa0000AaA000000
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: GSTIN_NUMBER
                  doc_value: 11AAAAA1111A1Z0
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PAN_NUMBER
                  doc_value: BIAPA2934N
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PASSPORT_NUMBER
                  doc_value: L6892603
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: UIDAI_NUMBER
                  doc_value: 753624181019
                  status: IN_REVIEW
                  remarks: null
            Auto Collect:
              value:
                related_docs:
                - vendor_id: johntest11111
                  doc_type: CIN_NUMBER
                  doc_value: L00000Aa0000AaA000000
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: GSTIN_NUMBER
                  doc_value: 11AAAAA1111A1Z0
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PAN_NUMBER
                  doc_value: BIAPA2934N
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PASSPORT_NUMBER
                  doc_value: L6892603
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: UIDAI_NUMBER
                  doc_value: 753624181019
                  status: IN_REVIEW
                  remarks: null
    getVendorSuccessResponse:
      description: Success response for fetching a vendor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorEntity'
          examples:
            PG:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                phone: 9876543210
                name: customer
                vendor_id: johntest11111
                added_on: '2023-03-02 12:12:56'
                updated_on: '2023-03-02 12:12:57'
                bank:
                  account_number: 11219276360
                  account_holder: JOHNDOE
                  ifsc: YESB0000262
                upi: null
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: true
                vendor_type: PG
                account_type: BUSINESS
                business_type: NBFC
                related_docs:
                - vendor_id: johntest11111
                  doc_type: CIN_NUMBER
                  doc_value: L00000Aa0000AaA000000
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: GSTIN_NUMBER
                  doc_value: 11AAAAA1111A1Z0
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PAN_NUMBER
                  doc_value: BIAPA2934N
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PASSPORT_NUMBER
                  doc_value: L6892603
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: UIDAI_NUMBER
                  doc_value: 753624181019
                  status: IN_REVIEW
                  remarks: null
            Auto Collect:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                phone: 9876543210
                name: customer
                vendor_id: johntest11111
                added_on: '2023-03-02 12:12:56'
                updated_on: '2023-03-02 12:12:57'
                bank:
                  account_number: 11219276360
                  account_holder: JOHNDOE
                  ifsc: YESB0000262
                upi: null
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: true
                vendor_type: PG
                account_type: BUSINESS
                business_type: NBFC
                related_docs:
                - vendor_id: johntest11111
                  doc_type: CIN_NUMBER
                  doc_value: L00000Aa0000AaA000000
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: GSTIN_NUMBER
                  doc_value: 11AAAAA1111A1Z0
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PAN_NUMBER
                  doc_value: BIAPA2934N
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PASSPORT_NUMBER
                  doc_value: L6892603
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: UIDAI_NUMBER
                  doc_value: 753624181019
                  status: IN_REVIEW
                  remarks: null
    createVendorSuccessResponse:
      description: Success response for creating a vendor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateVendorResponse'
          examples:
            PG - Bank Account:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                bank:
                  account_number: 026291800001191
                  account_holder: JOHN DOE
                  ifsc: YESB0000262
                upi: null
                phone: 9876543210
                name: customer
                vendor_id: TestAccount11
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: false
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  pan: AFDHK1234F
                  uidai: null
                  passport_number: null
                  driving_license: null
                  voter_id: null
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                dashboard_access: false
                bank_details: null
            PG - UPI:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                bank: null
                upi:
                  vpa: john@ybl
                  account_holder: JOHN DOE
                phone: 9876543210
                name: customer
                vendor_id: TestA2ccount211
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: false
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  pan: AFDHK1234F
                  uidai: null
                  passport_number: null
                  driving_license: null
                  voter_id: null
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                dashboard_access: false
                bank_details: null
            PG - Auto Collect:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                bank: null
                upi:
                  vpa: success@upi
                  account_holder: JOHN DOE
                phone: 9876543210
                name: customer
                vendor_id: vendortest123
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: false
                kyc_details:
                  account_type: INDIVIDUAL
                  business_type: NBFC
                  pan: AFDHK1234F
                  uidai: 456712345678
                  passport_number: null
                  driving_license: null
                  voter_id: null
                  gst: null
                  cin: null
                dashboard_access: false
                bank_details: null
    UpdateVendorSuccessResponse:
      description: Success response for updating a vendor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateVendorResponse'
          examples:
            PG - Bank Account:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                bank:
                  account_number: 026291800001191
                  account_holder: JOHN DOE
                  ifsc: YESB0000262
                upi: null
                phone: 9876543210
                name: customer
                vendor_id: TestAccount11
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: false
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  pan: AFDHK1234F
                  uidai: null
                  passport_number: null
                  driving_license: null
                  voter_id: null
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                dashboard_access: false
                bank_details: null
            PG - UPI:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                bank: null
                upi:
                  vpa: john@ybl
                  account_holder: JOHN DOE
                phone: 9876543210
                name: customer
                vendor_id: TestA2ccount211
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: false
                kyc_details:
                  account_type: BUSINESS
                  business_type: NBFC
                  pan: AFDHK1234F
                  uidai: null
                  passport_number: null
                  driving_license: null
                  voter_id: null
                  gst: 11AAAAA1111A1Z0
                  cin: L00000Aa0000AaA000000
                dashboard_access: false
                bank_details: null
            PG - Auto Collect:
              value:
                email: johndoe@cashfree.com
                status: IN_BENE_CREATION
                phone: 9876543210
                name: customer
                vendor_id: johntest11111
                added_on: '2023-03-02 12:12:56'
                updated_on: '2023-03-02 12:12:57'
                bank:
                  account_number: 11219276360
                  account_holder: JOHNDOE
                  ifsc: YESB0000262
                upi: null
                schedule_option:
                  settlement_schedule_message: T+1 settlement at 11:00 AM
                  schedule_id: 1
                  merchant_default: true
                vendor_type: PG
                account_type: BUSINESS
                business_type: NBFC
                related_docs:
                - vendor_id: johntest11111
                  doc_type: CIN_NUMBER
                  doc_value: L00000Aa0000AaA000000
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: GSTIN_NUMBER
                  doc_value: 11AAAAA1111A1Z0
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PAN_NUMBER
                  doc_value: BIAPA2934N
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: PASSPORT_NUMBER
                  doc_value: L6892603
                  status: IN_REVIEW
                  remarks: null
                - vendor_id: johntest11111
                  doc_type: UIDAI_NUMBER
                  doc_value: 753624181019
                  status: IN_REVIEW
                  remarks: null
    VendorAdjustmentSuccessResponse:
      description: Success response for creating an adjustment for a vendor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VendorAdjustmentSuccessResponse'
          examples:
            PG:
              value:
                message: Vendor & merchant balances updated
                status: OK
    SplitOrderReconSuccessResponse:
      description: Success response for fetching split and settlement details for an order.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SplitOrderReconSuccessResponse'
          examples:
            PG:
              value:
                settlement:
                  entity: settlement
                  cf_settlement_id: 4301319325
                  cf_payment_id: 5114912996630
                  order_id: order_1527072nQIWwJ96IRVKmGnysmYtqekXLv
                  order_currency: INR
                  transfer_id: null
                  order_amount: 3000.0
                  service_charge: 57.0
                  service_tax: 10.26
                  settlement_amount: 2100.0
                  settlement_currency: INR
                  transfer_utr: null
                  transfer_time: null
                  payment_time: '2024-10-14T15:12:08+05:30'
                refunds: []
                vendors:
                - vendor_id: test02
                  settlement_id: 87168
                  settlement_amount: 600.0
                  settlement_eligibility_date: '2024-10-14 15:27:08'
                - vendor_id: test03
                  settlement_id: 87167
                  settlement_amount: 300.0
                  settlement_eligibility_date: '2024-10-14 15:27:08'
    Response404SplitOrderRecon:
      description: Split Order Recon Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Order not present:
              value:
                message: Order Reference Id does not exist
                code: order_not_found
                type: invalid_request_error
    Response400VendorAdjustment:
      description: Adjust Vendor Balance Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Vendor does not exist:
              value:
                message: vendor does not exist
                code: api_request_failed
                type: invalid_request_error
            Invalid transfer amount:
              value:
                message: Amount should be greater than zero
                code: api_request_failed
                type: invalid_request_error
            No sufficient balance with vendor:
              value:
                message: Vendor does not have sufficient balance
                code: api_request_failed
                type: invalid_request_error
    Response400InvalidVendorId:
      description: Get Vendor Docs Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Invalid vendorID:
              value:
                message: vendor does not exist
                code: api_request_failed
                type: invalid_request_error
    Response400CreateSettlementorder:
      description: Create Settlement Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Duplicate Request:
              value:
                message: Duplicate request
                code: api_request_failed
                type: invalid_request_error
            Invalid date or null date:
              value:
                message: Invalid settlementDate Format
                code: api_request_failed
                type: INVALID_REQUEST_TYPE
    Response404CreateSettlementorder:
      description: Create Settlement Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Duplicate Request:
              value:
                message: Order Reference Id does not exist
                code: order_not_found
                type: invalid_request_error
    Response400GetVendorBalanceTransferCharges:
      description: Get Vendor Balance Transfer Charges Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Invalid rate type:
              value:
                message: 'The parameter rateType must have a value among : VENDOR_ON_DEMAND,'
                code: api_request_failed
                type: invalid_request_error
            Rate not found:
              value:
                message: Rate not found
                code: api_request_failed
                type: invalid_request_error
    Response404SplitAfterPayment:
      description: Split After Payment Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError404'
          examples:
            404:
              value:
                message: Order not found
                code: order_not_found,
                type: invalid_request_error
    Response409SplitAfterPayment:
      description: Split After Payment Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError409'
          examples:
            409:
              value:
                message: Transaction already processed, not eligible for split
                code: api_request_failed
                type: invalid_request_error
    Response400StaticSplit:
      description: Static Split Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Vendor does not exist:
              value:
                message: vendor does not exist
                code: api_request_failed
                type: invalid_request_error
            Easy Split not enabled:
              value:
                message: Merchant not enabled with easy splits
                code: api_request_failed
                type: invalid_request_error
            Invalid product type:
              value:
                message: 'product_type : should be STATIC_QR SBC PG EPOS. Value received: P2G'
                code: product_type_invalid
                type: invalid_request_error
            Split percentage less than min:
              value:
                message: split percentage cannot be <=0 for a vendor
                code: INVALID_REQUEST_TYPE
                type: invalid_request_error
            Split percentage greater than max:
              value:
                message: total split percentage cannot be > 100
                code: api_request_failed
                type: invalid_request_error
    Response400ESOrderRecon:
      description: ES Order Recon Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Filter not present:
              value:
                message: At least one of the filters needs to be present orderIds or Date
                code: request_failed
                type: invalid_request_error
    Response404ESOrderRecon:
      description: ES Order Recon Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Order not found:
              value:
                message: Order not found
                code: order_not_found
                type: invalid_request_error
    TransactionSummary400:
      description: Transaction return summary Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            status PENDING is not valid:
              value:
                code: api_request_failed
                help: 'Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document:
                  https://bit.ly/4eeZYO9'
                message: Payment status PENDING is not valid for transaction return summary generation.
                type: invalid_request_error
    Response409ESOrderRecon:
      description: ES Order Recon Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Settlement already initiated to merchant:
              value:
                message: Transaction already processed, not eligible for split
                code: api_request_failed
                type: invalid_request_error
    Response400SplitAfterPayment:
      description: Split After Payment Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Invalid vendor ID:
              value:
                message: vendor does not exist
                code: api_request_failed
                type: invalid_request_error
            Split amount greater than order amount:
              value:
                message: Total split amount can not be greater than transaction amount / eligible split balance
                code: api_request_failed
                type: invalid_request_error
            Both amount and percentage mentioned:
              value:
                message: 'Invalid Request: Both Amount and percentage are present'
                code: api_request_failed
                type: invalid_request_error
            Invalid percentage:
              value:
                message: Invalid vendor split percentage
                code: api_request_failed
                type: invalid_request_error
            Split already exist:
              value:
                message: Transaction already processed, not eligible for split
                code: api_request_failed
                type: invalid_request_error
            Transaction not synced yet:
              value:
                message: Transaction is not synced, please retry after 2 mins
                code: api_request_failed
                type: invalid_request_error
            Order not paid:
              value:
                message: Order not paid
                code: api_request_failed
                type: invalid_request_error
    Response400AdjustVendorBalance:
      description: Adjust Vendor Balance Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Vendor does not exist:
              value:
                message: vendor does not exist
                code: api_request_failed
                type: invalid_request_error
            Invalid transfer amount:
              value:
                message: Transfer amount should be greater than or equal to 10
                code: api_request_failed
                type: invalid_request_error
            No sufficient balance with vendor:
              value:
                message: VENDOR does not have sufficient funds for express settlement
                code: api_request_failed
                type: invalid_request_error
            No sufficient balance with merchant:
              value:
                message: MERCHANT does not have sufficient funds for express settlement
                code: api_request_failed
                type: invalid_request_error
    Response400CreateVendor:
      description: Create Vendor Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Invalid vendorID:
              value:
                message: 'vendor_id: should be alpha numeric. Value received: testvend@or'
                code: vendor_id_invalid
                type: invalid_request_error
            Invalid vendor status:
              value:
                message: 'status: should be ACTIVE BLOCKED. Value received: NEW'
                code: status_invalid
                type: invalid_request_error
            Invalid customer name size:
              value:
                message: '[size must be between 0 and 100 but it was nG3apOaiBGT0AS4C0Qmq7QdW25IEHv8Y1hACb60dBdkdMbRBgaBS3bePo0yRTLAZB0yoYlZfjktsHSGWsGlCSeq18Z5SeOIY7mliE]'
                code: api_request_failed
                type: invalid_request_error
            Customer name missing:
              value:
                message: 'name: is missing in the request. Value received: ""'
                code: name_missing
                type: invalid_request_error
            Invalid customer name:
              value:
                message: '[Invalid Name. Name should not have any special character except . / - & but it was @Devraj]'
                code: api_request_failed
                type: invalid_request_error
            Invalid email ID:
              value:
                message: 'email: should be valid email. Value received: arun@@cashfree.com'
                code: email_invalid
                type: invalid_request_error
            Email ID missing:
              value:
                message: 'email: is missing in the request. Value received: ""'
                code: email_missing
                type: invalid_request_error
            Invalid phone number:
              value:
                message: '[Enter valid phone number. but it was 8867456990734887837434]'
                code: api_request_failed
                type: invalid_request_error
            Invalid verify status:
              value:
                message: invalid character '2' in literal true (expecting 'u')
                code: request_failed
                type: invalid_request_error
            Invalid dashboard access status:
              value:
                message: invalid character '2' in literal true (expecting 'u')
                code: request_failed
                type: invalid_request_error
            Invalid VPA:
              value:
                message: 'upi.vpa: invalid VPA provided. Value received: 026291800001191'
                code: upi.vpa_invalid
                type: invalid_request_error
            Invalid account holder name:
              value:
                message: '[Invalid account holder name. Account holder name should not have any special character except .
                  / - & but it was John_Doe]'
                code: api_request_failed
                type: invalid_request_error
            Invalid UIDAI number:
              value:
                message: '[Please enter valid UIDAI number but it was 456712345678]]'
                code: api_request_failed
                type: invalid_request_error
            Invalid GST number:
              value:
                message: '[Please enter valid GST number but it was 11AAAAA1111A1@Z0]'
                code: api_request_failed
                type: invalid_request_error
            Invalid CIN number:
              value:
                message: '[Please enter valid CIN number but it was L00000Aa0000AaA@000000]'
                code: api_request_failed
                type: invalid_request_error
            Invalid PAN number:
              value:
                message: 'kyc_details.pan: is missing in the request. Value received: ""'
                code: kyc_details.pan_missing
                type: invalid_request_error
            Invalid Passport number:
              value:
                message: '[Please enter valid PASSPORT number but it was L68926@03]]'
                code: api_request_failed
                type: invalid_request_error
    Response400UploadVendorDocs:
      description: Upload Vendor Docs Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Invalid vendorID:
              value:
                message: 'vendor_id: should be alpha numeric. Value received: testvend@or'
                code: vendor_id_invalid
                type: invalid_request_error
            Doc Type Missing:
              value:
                message: 'doc_type : is missing in the request. Value received: ""'
                code: doc_type_missing
                type: invalid_request_error
    Response400UpdateVendor:
      description: Update Vendor Failure Response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            Invalid vendorID:
              value:
                message: 'vendor_id: should be alpha numeric. Value received: testvend@or'
                code: vendor_id_invalid
                type: invalid_request_error
            Invalid vendor status:
              value:
                message: 'status: should be ACTIVE BLOCKED. Value received: NEW'
                code: status_invalid
                type: invalid_request_error
            Invalid customer name size:
              value:
                message: '[size must be between 0 and 100 but it was nG3apOaiBGT0AS4C0Qmq7QdW25IEHv8Y1hACb60dBdkdMbRBgaBS3bePo0yRTLAZB0yoYlZfjktsHSGWsGlCSeq18Z5SeOIY7mliE]'
                code: api_request_failed
                type: invalid_request_error
            Invalid customer name:
              value:
                message: '[Invalid Name. Name should not have any special character except . / - & but it was @Devraj]'
                code: api_request_failed
                type: invalid_request_error
            Invalid email ID:
              value:
                message: 'email: should be valid email. Value received: arun@@cashfree.com'
                code: email_invalid
                type: invalid_request_error
            Invalid phone number:
              value:
                message: '[Enter valid phone number. but it was 8867456990734887837434]'
                code: api_request_failed
                type: invalid_request_error
            Invalid VPA:
              value:
                message: 'upi.vpa: invalid VPA provided. Value received: 026291800001191'
                code: upi.vpa_invalid
                type: invalid_request_error
            Invalid account holder name:
              value:
                message: '[Invalid account holder name. Account holder name should not have any special character except .
                  / - & but it was John_Doe]'
                code: api_request_failed
                type: invalid_request_error
            Invalid UIDAI number:
              value:
                message: '[Please enter valid UIDAI number but it was 456712345678]]'
                code: api_request_failed
                type: invalid_request_error
            Invalid GST number:
              value:
                message: '[Please enter valid GST number but it was 11AAAAA1111A1@Z0]'
                code: api_request_failed
                type: invalid_request_error
            Invalid CIN number:
              value:
                message: '[Please enter valid CIN number but it was L00000Aa0000AaA@000000]'
                code: api_request_failed
                type: invalid_request_error
            Invalid PAN number:
              value:
                message: 'kyc_details.pan: is missing in the request. Value received: ""'
                code: kyc_details.pan_missing
                type: invalid_request_error
            Invalid Passport number:
              value:
                message: '[Please enter valid PASSPORT number but it was L68926@03]]'
                code: api_request_failed
                type: invalid_request_error
    UploadPnachImage200Response:
      description: Success response for uploading a physical NACH image.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UploadPnachImageResponse'
          examples:
            successful_upload:
              value:
                payment_id: payment-1234
                authorization_status: INITIALIZED
                action: SUBMIT_DOCUMENT
                payment_message: file uploaded successfully.
    SubscriptionEligibility200Response:
      description: Success response for fetching the payment methods available for subscription payments.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionEligibilityResponse'
          examples:
            all payment methods response:
              value:
              - eligibility: true
                entity_type: payment_methods
                entity_value: enach
                entity_details:
                  account_types:
                  - SAVINGS
                  - CURRENT
                  frequent_bank_details:
                  - bank_id: SBIN
                    bank_name: STATE BANK OF INDIA
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                  - bank_id: BARB
                    bank_name: BANK OF BARODA
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                  - bank_id: ICIC
                    bank_name: ICICI BANK LTD
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                    - AADHAAR
                  - bank_id: HDFC
                    bank_name: HDFC BANK LTD
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                    - AADHAAR
                  all_bank_details:
                  - bank_id: SBIN
                    bank_name: STATE BANK OF INDIA
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                  - bank_id: BARB
                    bank_name: BANK OF BARODA
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                  - bank_id: ICIC
                    bank_name: ICICI BANK LTD
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                    - AADHAAR
                  - bank_id: HDFC
                    bank_name: HDFC BANK LTD
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                    - AADHAAR
                  - bank_id: UTKS
                    bank_name: UTKARSH SMALL FINANCE BANK LTD
                    account_auth_modes:
                    - DEBIT_CARD
                  - bank_id: YESB
                    bank_name: YES BANK
                    account_auth_modes:
                    - DEBIT_CARD
                    - NET_BANKING
                    - AADHAAR
              - eligibility: true
                entity_type: payment_methods
                entity_value: upi
                entity_details:
                  available_handles:
                  - handle: okaxis
                    application: Google Pay
                  - handle: ybl
                    application: PhonePe
              - eligibility: true
                entity_type: payment_methods
                entity_value: card
                entity_details:
                  allowed_card_types:
                  - CREDIT_CARD
                  - DEBIT_CARD
              - eligibility: true
                entity_type: payment_methods
                entity_value: pnach
                entity_details:
                  account_types:
                  - SAVINGS
                  - CURRENT
                  all_bank_details:
                  - bank_id: SRIX
                    bank_name: SRI SATYA SAI NAGRIK SAHAKARI BANK MYDT, BHOPAL
                  - bank_id: ISUX
                    bank_name: THE ISLAMPUR URBAN CO OPERATIVE BANK LIMITED
                  - bank_id: ZCBL
                    bank_name: THE ZOROASTRIAN CO OP BANK LTD
    GetCardBinResponse:
      description: Success response for fetching card BIN details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetCardBinResponseSchema'
  examples:
    create_controlled_notification:
      description: Create a controlled payment notification.
      summary: Create Controlled Notification
      value:
        notification_id: basePay123-pdn1
        payment_amount: 10
        payment_id: basePay123
        payment_remarks: remarks
        payment_schedule_date: '2026-09-09T15:07:15+05:30'
        subscription_id: abcd
    create_controlled_execution:
      description: Create a controlled payment execution.
      summary: Create Controlled Execution
      value:
        execution_id: basePay123-exec1
        payment_id: basePay123
    VendorReconACResponseExample:
      value:
        cursor: null
        data:
        - amount: 200
          settlement_eligibility_time: '2022-09-07 08:00:00'
          merchant_order_id: order_1527072EOGQLB2sEuL206y2hcXzB0ITu6
          tx_time: '2022-09-06 15:43:20'
          settlement_id: 10253
          settled: true
          fee: NA
          tax: NA
          entity_id: '885568174'
          type: transaction
          merchant_vendor_id: test01
          added_on_time: '2022-09-06 15:43:28'
          settlement_time: '2022-09-06 16:15:03'
          settlement_utr: '1662461103581582'
          currency: INR
          debit: NA
          credit: '200.0'
          refund_arn: order_1527072EOGQLB2sEuL206y2hcXzB0ITu6
        - settlement_eligibility_time: NA
          merchant_order_id: NA
          tx_time: '2022-09-06 16:15:01'
          settlement_id: 10253
          settled: true
          fee: '0.0'
          tax: '0.0'
          entity_id: '10253'
          type: vendor_settlement
          merchant_vendor_id: test01
          added_on_time: '2022-09-06 16:15:01'
          settlement_time: '2022-09-06 16:15:03'
          settlement_utr: '1662461103581582'
          currency: INR
          debit: '400.0'
          credit: NA
          refund_arn: NA
        - amount: 100
          settlement_eligibility_time: NA
          merchant_order_id: order_1527072EOGQLB2sEuL206y2hcXzB0ITu6
          tx_time: '2022-09-06 16:32:49'
          fee: NA
          tax: NA
          entity_id: REF_ee880c02-6438-4f4f-ba0a-b422da63e195
          type: REFUND
          merchant_vendor_id: test01
          added_on_time: '2022-09-06 16:32:49'
          settlement_time: NA
          settlement_utr: NA
          currency: INR
          debit: '100.0'
          credit: NA
          refund_arn: order_1527072EOGQLB2sEuL206y2hcXzB0ITu6
        limit: 3
    VendorReconPGResponseExample:
      value:
        cursor: eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTI4ODVdLCJlbXB0eSI6ZmFsc2V9LCJyZXBvcnRUeXBlIjoidmVuZG9yX2FkanVzdG1lbnRfcmVjb24ifQ==
        data:
        - amount: 70
          settlement_eligibility_time: '2023-08-18 13:47:09'
          merchant_order_id: order_1527072U9JADzyG7V93d9xG7goO6xo8C6
          tx_time: '2023-08-18 13:32:09'
          settlement_id: 51709
          settled: true
          fee: NA
          tax: NA
          entity_id: '2148545831'
          type: transaction
          merchant_vendor_id: test03
          added_on_time: '2023-08-18 13:32:21'
          settlement_time: '2023-08-22 10:34:11'
          settlement_utr: '1692680651484925'
          currency: INR
          debit: NA
          credit: '70.0'
          refund_arn: order_1527072U9JADzyG7V93d9xG7goO6xo8C6
        - amount: 2500
          settlement_eligibility_time: '2023-08-18 18:25:04'
          merchant_order_id: order_1527072U9qz76SXfmFPbu1Z1BfTa4lNW5
          tx_time: '2023-08-18 18:10:04'
          settlement_id: 51709
          settled: true
          fee: NA
          tax: NA
          entity_id: '2148548184'
          type: transaction
          merchant_vendor_id: test03
          added_on_time: '2023-08-18 18:10:06'
          settlement_time: '2023-08-22 10:34:11'
          settlement_utr: '1692680651484925'
          currency: INR
          debit: NA
          credit: '2500.0'
          refund_arn: order_1527072U9qz76SXfmFPbu1Z1BfTa4lNW5
        - amount: 2500
          settlement_eligibility_time: '2023-08-18 18:33:00'
          merchant_order_id: order_1527072U9rwyUDlUqtkYpRyGtu3A6tfgy
          tx_time: '2023-08-18 18:18:00'
          settlement_id: 51709
          settled: true
          fee: NA
          tax: NA
          entity_id: '2148548225'
          type: transaction
          merchant_vendor_id: test03
          added_on_time: '2023-08-18 18:18:02'
          settlement_time: '2023-08-22 10:34:11'
          settlement_utr: '1692680651484925'
          currency: INR
          debit: NA
          credit: '2500.0'
          refund_arn: order_1527072U9rwyUDlUqtkYpRyGtu3A6tfgy
        - settlement_eligibility_time: NA
          merchant_order_id: NA
          tx_time: '2023-08-18 17:54:55'
          settlement_id: 51678
          fee: '10.0'
          tax: '1.8'
          entity_id: '51678'
          type: vendor_settlement
          merchant_vendor_id: test03
          added_on_time: '2023-08-18 17:54:55'
          currency: INR
          debit: '0.0'
          credit: NA
          refund_arn: NA
        - settlement_eligibility_time: NA
          merchant_order_id: NA
          tx_time: '2023-08-18 17:58:49'
          settlement_id: 51680
          settled: true
          fee: '10.0'
          tax: '1.8'
          entity_id: '51680'
          type: vendor_settlement
          merchant_vendor_id: test03
          added_on_time: '2023-08-18 17:58:49'
          settlement_time: '2023-08-18 17:58:51'
          settlement_utr: '1692361731372244'
          currency: INR
          debit: '0.0'
          credit: NA
          refund_arn: NA
        limit: 15
    card_offer:
      summary: Create a Card Offer
      description: card offer example.
      value:
        offer_meta:
          offer_title: Test Offer
          offer_description: Offer Description
          offer_code: CFTESTOFFER
          offer_start_time: '2023-03-21T08:09:51Z'
          offer_end_time: '2024-03-21T08:09:51Z'
        offer_tnc:
          offer_tnc_type: text
          offer_tnc_value: Terms and Condition of the Offer
        offer_details:
          offer_type: DISCOUNT_AND_CASHBACK
          discount_details:
            discount_type: flat
            discount_value: '10'
            max_discount_amount: '10'
          cashback_details:
            cashback_type: percentage
            cashback_value: '10'
            max_cashback_amount: '10'
        offer_validations:
          min_amount: 15
          max_allowed: 100
          payment_method:
            card:
              type:
              - cc
              bank_name: hdfc bank
              scheme_name:
              - visa
    create_customer:
      description: Example request to create a customer.
      value:
        customer_phone: '9999999999'
        customer_email: prasun@example.com
        customer_name: Prasun
    customer_entity_example:
      description: CustomerEntityExample.
      summary: CustomerEntityExample
      value:
      - customer_uid: cfcustom_78364873648723
        customer_phone: '9999999999'
        customer_email: prasun@example.com
        customer_name: Prasun
    eligibility_cardless_emi:
      summary: Get Eligible Cardless EMI
      description: Check cardless emi eligibilty.
      value:
        queries:
          amount: 10000
          customer_details:
            customer_phone: '9898989898'
    eligible_all_payment_methods:
      description: Check eligibilty of Payment Methods.
      summary: Eligible Payment Methods - All
      value:
        queries:
          amount: 100
    eligible_card_payment_methods:
      description: Check eligibilty of Payment Methods.
      summary: Eligible Payment Methods - Card
      value:
        filters:
          payment_methods:
          - debit_card
          - credit_card
          - prepaid_card
          - corporate_credit_card
        queries:
          amount: 100
    eligible_netbanking_payment_methods:
      description: Check eligibilty of Payment Methods.
      summary: Eligible Payment Methods - Netbanking
      value:
        filters:
          payment_methods:
          - netbanking
        queries:
          amount: 100
    eligible_no_cost_emi_offers:
      summary: Eligible No-Cost EMI Offers
      description: Check nocost emi eligibilty.
      value:
        queries:
          amount: 1000
        filters:
          offer_type:
          - NO_COST_EMI
    eligible_offers:
      summary: Eligible Offers
      description: Check offers eligibilty.
      value:
        queries:
          amount: 1000
    eligible_paylater:
      summary: Eligible Paylater
      description: Check Paylater eligibilty.
      value:
        queries:
          amount: 10000
          customer_details:
            customer_phone: '9898989898'
    fetch_all_saved_cards_example:
      summary: Saved Instruments
      description: All saved instrument example.
      value:
      - customer_id: akshita2106
        afa_reference: '2223295743'
        instrument_id: 0d6b0245-f417-41a0-8151-0b03790de1f9
        instrument_type: card
        instrument_uid: a89b6054bd18f3f4a2e6663190c23aa7f39573dfde2ea2e5d3dbf1b31705f0da
        instrument_display: XXXXXXXXXXXX5717
        instrument_status: ACTIVE
        created_at: '2023-11-01T04:55:07.000+00:00'
        instrument_meta:
          card_network: visa
          card_bank_name: AXIS BANK
          card_country: IN
          card_type: credit_card
          card_sub_type: P
          card_token_details:
            par: V0010013823048595023916090696
            expiry_month: '05'
            expiry_year: '2028'
      - customer_id: akshita2106
        afa_reference: '2372080606'
        instrument_id: 36e3b8ab-27e5-4a33-baf6-31a2d412a530
        instrument_type: card
        instrument_uid: b6f4e24db8ab83e59dc57049b25f0fdfa9b730e329b9730d3d3fe0aba3ccfaa3
        instrument_display: XXXXXXXXXXXX7293
        instrument_status: ACTIVE
        created_at: '2024-01-04T09:16:37.000+00:00'
        instrument_meta:
          card_network: mastercard
          card_bank_name: PUNJAB NATIONAL BANK
          card_country: IN
          card_type: debit_card
          card_sub_type: R
          card_token_details:
            par: 5001D6TQMCHMY7SHM2SFANC3AWFSD
            expiry_month: 09
            expiry_year: '2028'
      - customer_id: akshita2106
        afa_reference: '3128531647'
        instrument_id: 0d6b0245-f417-41a0-8151-0b03790de1f9
        instrument_type: card
        instrument_uid: a89b6054bd18f3f4a2e6663190c23aa7f39573dfde2ea2e5d3dbf1b31705f0da
        instrument_display: XXXXXXXXXXXX1001
        instrument_status: ACTIVE
        created_at: '2024-10-10T10:16:18.000+00:00'
        instrument_meta:
          card_network: mastercard
          card_bank_name: ICICI BANK
          card_country: IN
          card_type: credit_card
          card_sub_type: P
          card_token_details:
            par: 5001AJE6CSF757UMKRTKK61PRVYGC
            expiry_month: '11'
            expiry_year: '2027'
    fetch_specific_saved_cards_example:
      summary: Saved Instruments
      description: Specific saved instrument example.
      value:
      - customer_id: akshita2106
        afa_reference: '3128531647'
        instrument_id: 41ad34ee-36a0-409e-aec9-bdc9d232add0
        instrument_type: card
        instrument_uid: 78c2a3b90265436eceb4c09d8b09c85432ee1bb57512cc24ba998a12cd0180c2
        instrument_display: XXXXXXXXXXXX1001
        instrument_status: INACTIVE
        created_at: '2024-10-10T10:16:18.000+00:00'
        instrument_meta:
          card_network: mastercard
          card_bank_name: ICICI BANK
          card_country: IN
          card_type: credit_card
          card_sub_type: P
          card_token_details:
            par: 5001AJE6CSF757UMKRTKK61PRVYGC
            expiry_month: '11'
            expiry_year: '2027'
    submit_otp:
      summary: Submit OTP for Native OTP flow
      description: Submit OTP for Native OTP flow.
      value:
        action: SUBMIT_OTP
        otp: 111000
    resend_otp:
      summary: Resend OTP for Native OTP flow
      description: Resend OTP for Native OTP flow.
      value:
        action: RESEND_OTP
    terminal_filter:
      description: filter terminal transactions based on payment time,payment mode etc.
      summary: filter terminal transactions based on payment time,payment mode etc
      value:
        filter:
          start_date: '2023-08-04T13:12:58+05:30'
          end_date: '2023-08-04T13:12:58+05:30'
          cf_terminal_id: '1234'
          terminal_vpa: cf.epos@cash
          terminal_phone_no: '9696969696'
          payment_status: SUCCESS
          payment_group: UPI
          sort_by: start_date
          sort_order: ASC
        pagination:
          page_number: 1
          page_size: 50
    issuer_token_number:
      description: Pay using Issuer Token Number.
      summary: Pay using Issuer Token Number
      value:
        payment_method:
          card:
            card_cvv: '900'
            card_display: '3243'
            card_expiry_mm: '03'
            card_expiry_yy: '26'
            card_number: '4111111111111111'
            channel: link
            cryptogram: AQBBBBBBZatIlaIAmWKSghwBBBB=
            token_requestor_id: '22457512314'
            token_type: ISSUER_TOKEN
        payment_session_id: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
    net_banking_offer:
      summary: Create a Net Banking Offer
      description: Offer Netbanking.
      value:
        offer_meta:
          offer_title: Test Offer
          offer_description: Offer Description
          offer_code: CFTESTOFFER
          offer_start_time: '2023-03-21T08:09:51Z'
          offer_end_time: '2024-03-21T08:09:51Z'
        offer_tnc:
          offer_tnc_type: text
          offer_tnc_value: Terms and Condition of the Offer
        offer_details:
          offer_type: DISCOUNT_AND_CASHBACK
          discount_details:
            discount_type: flat
            discount_value: '10'
            max_discount_amount: '10'
          cashback_details:
            cashback_type: percentage
            cashback_value: '10'
            max_cashback_amount: '10'
        offer_validations:
          min_amount: 12
          max_allowed: 100
          payment_method:
            netbanking:
              bank_name: all
    no_cost_emi_offer:
      summary: Create a No Cost EMI Offer
      description: No cost EMI.
      value:
        offer_meta:
          offer_title: Test Offer
          offer_description: Offer Description
          offer_code: CFTESTOFFER
          offer_start_time: '2023-03-21T08:09:51Z'
          offer_end_time: '2024-03-21T08:09:51Z'
        offer_tnc:
          offer_tnc_type: text
          offer_tnc_value: Terms and Condition of the Offer
        offer_details:
          offer_type: NO_COST_EMI
        offer_validations:
          max_allowed: 10000
          payment_method:
            emi:
              type: cardless_emi
              issuer: hdfc bank
              tenures:
              - 3
              - 6
    offer_entity_example:
      description: offer entity example.
      summary: OfferEntityExample
      value:
      - offer_id: d2b430fb-1afe-455a-af31-66d00377b29a
        offer_status: active
        offer_meta:
          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'
        offer_tnc:
          offer_tnc_type: text
          offer_tnc_value: TnC for the Offer.
        offer_details:
          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'
        offer_validations:
          min_amount: 10
          payment_method:
            wallet:
              issuer: paytm
          max_allowed: 2
        redemption_amount: 10
        platform: CASHFREE
    order_with_customer_details:
      summary: Customer Details
      description: Complete customer details.
      value:
        order_id: playstation_purchase_1
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_name: John Doe
          customer_phone: 9908734801
          customer_email: john@example.com
          customer_bank_ifsc: XDFC0000045
          customer_bank_account_number: 123124123123123
          customer_bank_code: 3021
    order_tpv:
      summary: Customer TPV
      description: Customer with bank details if provided he or she can pay by only that bank account.
      value:
        order_id: playstation_purchase_1
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_name: John Doe
          customer_phone: '9908734801'
          customer_email: john@example.com
          customer_bank_ifsc: XDFC0000045
          customer_bank_account_number: '123124123123123'
          customer_bank_code: 3021
    order_entity_list_example:
      description: OrderEntityListExample.
      summary: OrderEntityListExample
      value:
      - cf_order_id: '2149460581'
        created_at: '2023-08-11T18:02:46+05:30'
        customer_details:
          customer_id: '409128494'
          customer_name: Johmn Doe
          customer_email: pmlpayme@ntsas.com
          customer_phone: '9876543210'
          customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
        entity: order
        order_amount: 22
        payment_session_id: session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH
        order_currency: INR
        order_expiry_time: '2023-09-09T18:02:46+05:30'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        order_meta:
          return_url: https://www.cashfree.com/devstudio/thankyou
          payment_methods: cc
          notify_url: https://example.com/cf_notify
          payment_methods_filters:
            methods:
              action: ALLOW
              values:
              - debit_card
              - credit_card
              - credit_card_emi
              - debit_card_emi
            filters:
              card_bins:
                action: ALLOW
                values:
                - 441144
                - 554455
              card_schemes:
                action: ALLOW
                values:
                - VISA
                - MASTERCARD
              card_suffix:
                action: ALLOW
                values:
                - 4433
                - 8910
              card_emi_bins:
                action: ALLOW
                values:
                - 441144
                - 554455
              card_emi_schemes:
                action: ALLOW
                values:
                - VISA
                - MASTERCARD
              card_emi_suffix:
                action: ALLOW
                values:
                - 4433
                - 8910
        order_note: some order note LIST
        order_splits: []
        order_status: ACTIVE
        order_tags:
          name: John
          age: '19'
        terminal_data: null
        cart_details:
          cart_id: '1'
    order_extended_data_entity_list_example:
      description: OrderExtendedEntityDataExample.
      summary: OrderExtendedEntityDataExample
      value:
      - cf_order_id: '2149460581'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        order_amount: 22
        order_currency: INR
        created_at: '2023-08-11T18:02:46+05:30'
        charges:
          shipping_charges: 5
          cod_handling_charges: 10
        customer_details:
          customer_id: '409128494'
          customer_name: Aditya Keshri
          customer_email: pmlpayme@ntsas.com
          customer_phone: '9876543210'
          customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
        shipping_address:
          name: Saurav Singh
          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
        billing_address:
          name: Saurav Singh
          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
        cart:
          name: test
          items:
          - item_id: '26'
            item_name: Sample Product
            item_description: item-description
            item_tags:
            - '1'
            - '2'
            item_details_url: http://cashfree.com
            item_image_url: http://cashfree.com
            item_original_unit_price: '1'
            item_discounted_unit_price: '1'
            item_quantity: 1
            item_currency: INR
          - item_id: '35'
            item_name: Sample Product
            item_description: item-description
            item_tags:
            - '1'
            - '2'
            item_details_url: http://cashfree.com
            item_image_url: http://cashfree.com
            item_original_unit_price: '1'
            item_discounted_unit_price: '1'
            item_quantity: 1
            item_currency: INR
        offer:
          offer_id: d2b430fb-1afe-455a-af31-66d00377b29a
          offer_status: active
          offer_meta:
            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'
          offer_tnc:
            offer_tnc_type: text
            offer_tnc_value: TnC for the Offer.
          offer_details:
            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'
          offer_validations:
            min_amount: 10
            payment_method:
              wallet:
                issuer: paytm
            max_allowed: 2
    update_order_extended_data_entity_list_example:
      description: UpdateOrderExtendedEntityDataExample.
      summary: UpdateOrderExtendedEntityDataExample
      value:
      - cf_order_id: '2149460581'
        order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
        shipment_details:
        - tracking_company: DHL
          tracking_urls:
          - https://dhl.com/track/123456
          tracking_numbers:
          - TRACK123456
        order_delivery_status:
          status: CANCELLED
          reason: wrong address
    order_with_invoice_details:
      summary: With order invoice
      description: Add invoice details for your order.
      value:
        order_id: playstation_purchase_6
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_tags:
          gst: '1'
          gstin: 27AAFCN5072P1ZV
          invoice_date: '2023-06-20T04:35:16.748Z'
          invoice_number: inv1687149916474
          invoice_link: https://example.com/cf/nextgen.php#section-2
          invoice_name: Walters Invoice
          cgst: '1'
          sgst: '1'
          igst: '1'
          cess: '1'
          gst_incentive: '1'
          gst_percentage: '1'
          pincode: '560034'
          city_tier: TIER1
    order_with_minimum_fields:
      summary: Minimun required details
      description: Minimum set of parameters needed to create an order at cashfree.
      value:
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
    order_with_order_id:
      summary: Specify your order_id
      description: You should always send `order_id`. If not sent Cashfree will generate one for you. This is useful during
        other api calls.
      value:
        order_id: playstation_purchase_1
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9908734801'
    order_split_by_amount_tags:
      summary: With order split Amount
      description: Create an order where the amount received will be split between vendor and merchant based on absolute amount.
      value:
        order_id: playstation_purchase_8
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_splits:
        - vendor_id: Jane
          amount: 1.45
          tags:
            address: Hyderabad
        - vendor_id: Barbie
          amount: 3.45
          tags:
            address: Bengaluru, India.
    order_split_by_percentage:
      summary: With order split Percentage
      description: "Create an order where the amount received will be split between vendors and merchant based on percentage.\n\
        In the below example order amount, let us say INR 200 will be divided like this\n- 33% to merchant becomes INR 66\
        \ \n- 20% to Jane becomes INR 40\n- 47% to Barbie becomes INR 94\n"
      value:
        order_id: playstation_purchase_8
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_splits:
        - vendor_id: Jane
          percentage: 20
        - vendor_id: Barbie
          percentage: 47
    order_with_tags:
      summary: With order tags
      description: Add key value pairs to your order. Can be used later in your workflow.
      value:
        order_id: playstation_purchase_6
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_tags:
          address: Bengaluru, India
          pincode: '560034'
    order_with_payment_methods:
      summary: With Payment Methods URL
      description: add payment methods, customer can pnly pay using these payment methods only.
      value:
        order_id: playstation_purchase_4
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_meta:
          return_url: https://www.cashfree.com/devstudio/thankyou
          payment_methods: cc,dc,upi
    order_with_payment_methods_filters:
      summary: With Payment Methods Filters
      description: add payment methods, customer can pay using these payment methods only.
      value:
        order_id: playstation_purchase_4
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_meta:
          return_url: https://www.cashfree.com/devstudio/thankyou
          payment_methods_filters:
            methods:
              action: ALLOW
              values:
              - debit_card
              - credit_card
              - credit_card_emi
              - debit_card_emi
            filters:
              card_bins:
              - 441144
              - 554455
              card_schemes:
              - VISA
              - MASTERCARD
              card_suffix:
              - 4433
              - 8910
              card_emi_tenure: 6
              card_emi_bins:
              - 441144
              - 554455
              card_emi_schemes:
              - VISA
              - MASTERCARD
              card_emi_suffix:
              - 4433
              - 8910
              card_emi_issuing_bank:
              - HDFC
              - ICICI
    order_bbps:
      summary: BBPS bill payment (legacy)
      description: "Create an order for a BBPS bill payment using legacy fields. Supported only for prefunding Agent Institutions. Pass `bill_fetch_ref_id`, `biller_id`, and `agent_id` directly in the `bbps` block."
      value:
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: "9898989898"
        bbps:
          bill_fetch_ref_id: b73a14a591874eb3a22296b2dd861511952
          biller_id: SWAR00027NAT2J
          agent_id: CH01CH02INB516193128
    order_bbps_bills:
      summary: BBPS bill payment (bills array)
      description: "Create an order for a BBPS bill payment using the `bills` array. This is the standard format and is mandatory for postfunding (shortfall) Agent Institutions."
      value:
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: "9898989898"
        bbps:
          bills:
            - bill_fetch_ref_id: b73a14a591874eb3a22296b2dd861511952
              biller_id: SWAR00027NAT2J
              agent_id: CH01CH02INB516193128
              amount_to_be_paid: 10.34
    order_bbps_pay_together:
      summary: BBPS Pay Together (postfunding)
      description: "Pay bills across multiple billers in a single order using the `bills` array. Includes `shortfall_amount`, `vendor_splits` per bill, and top-level `order_splits` for a postfunding Agent Institution. For postfunding Agent Institutions, `order_amount` must equal the sum of all `amount_to_be_paid` values minus the sum of all `shortfall_amount` values plus the sum of all `vendor_splits` amounts across all bills. The sum of all bill-level `vendor_splits` amounts must equal the top-level `order_splits` amount."
      value:
        order_currency: INR
        order_amount: 362.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: "9898989898"
        order_splits:
          - vendor_id: VENDOR_001
            amount: 52.00
        bbps:
          bills:
            - bill_fetch_ref_id: b73a14a591874eb3a22296b2dd861511952
              biller_id: SWAR00027NAT2J
              agent_id: CH01CH02INB516193128
              amount_to_be_paid: 10.34
              shortfall_amount: 0
              vendor_splits:
                - vendor_id: VENDOR_001
                  amount: 2.00
            - bill_fetch_ref_id: a92b25b691874eb3a33407c3ee972622063
              biller_id: ELEC00045DEL1K
              agent_id: CH01CH02INB516193128
              amount_to_be_paid: 500.00
              shortfall_amount: 200.00
              vendor_splits:
                - vendor_id: VENDOR_001
                  amount: 50.00
    order_with_return_url:
      summary: With return/callback URL
      description: add a return url to your order.
      value:
        order_id: playstation_purchase_2
        order_currency: INR
        order_amount: 10.34
        customer_details:
          customer_id: 7112AAA812234
          customer_phone: '9898989898'
        order_meta:
          return_url: https://www.cashfree.com/devstudio/thankyou
    order_extended_minimum:
      summary: Minimun required details
      description: Minimum set of parameters needed to update shipment details.
      value:
        shipment_details:
        - tracking_company: DHL
          tracking_urls:
          - https://dhl.com/track/123456
          tracking_numbers:
          - TRACK123456
    order_extended_delivery_status:
      summary: Minimum required deatils for status
      description: Minimum set of parameters needed to update shipment details.
      value:
        order_delivery_status:
          status: CANCELLED
          reason: wrong address
    order_extended_all_field:
      summary: With Shipment detail and delivery status
      description: Request with all fields.
      value:
        shipment_details:
        - tracking_company: DHL
          tracking_urls:
          - https://dhl.com/track/123456
          tracking_numbers:
          - TRACK123456
        order_delivery_status:
          status: CANCELLED
          reason: wrong address
    card_headless_otp_payment:
      description: Zero redirect Card Payment.
      summary: Card Headless OTP
      value:
        payment_session_id: session_Cke8Y9LKs2CQP9KuTzsomExG1x5CKBLo8MynNCv8QT
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          card:
            channel: post
            card_number: '4111111111111111'
            card_expiry_mm: '03'
            card_expiry_yy: '25'
            card_cvv: '326'
            card_holder_name: john
        save_instrument: true
    emi_cc:
      description: Use Credit Card EMI 3 months.
      summary: CreditCard EMI
      value:
        payment_session_id: session_ccemi
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          emi:
            channel: link
            card_number: '4748461111111111'
            card_expiry_mm: '12'
            card_expiry_yy: '24'
            card_cvv: '123'
            card_bank_name: ICICI
            emi_tenure: 3
    netbanking_by_name:
      description: Pay by netbanking name.
      summary: NetBanking By Name
      value:
        payment_session_id: session_someid
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          netbanking:
            channel: link
            netbanking_bank_name: TESTR
    netbanking_by_code:
      description: Pay by netbanking Code.
      summary: NetBanking By Code
      value:
        payment_session_id: session_someid
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          netbanking:
            channel: link
            netbanking_bank_code: 3021
    upi_collect:
      description: Customer will receive a notification on their phone to pay via UPI.
      summary: UPI Collect
      value:
        payment_session_id: session_cChK4rQ9
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          upi:
            channel: collect
            upi_id: testsuccess@gocash
    upi_collect_redirect:
      description: Redirect to loader page for UPI Collect.
      summary: UPI Collect Loader Page
      value:
        payment_session_id: session_ehHbh0NXtVqlWwKS3acRxeT0uz5QuzHYgIBt8uLZ
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          upi:
            channel: collect
            upi_id: rajnandan1@oksomebank
            upi_redirect_url: true
    upi_intent:
      description: UPI intent. Opens UPI APP. Mobile only.
      summary: UPI Intent
      value:
        payment_session_id: session__someidwhichislongandhasnumbers1232132andcharacterscn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          upi:
            channel: link
    upi_qr:
      description: Get a `base64` QR Image.
      summary: QR Code
      value:
        payment_session_id: session_somesessionid
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          upi:
            channel: qrcode
    upi_podqr:
      description: Get a `base64` QR Image.
      summary: POD QR Code
      value:
        payment_session_id: session_somesessionid
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          upi:
            channel: podQrCode
    wallet_app:
      description: Pay using PhonePe Wallet.
      summary: Wallet/APP
      value:
        payment_session_id: session_ehHbh0NXtVqlWwKS3acRxeT0uz5t8uLZ
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          app:
            provider: phonepe
            channel: link
            phone: '8474090589'
    banktransfer:
      description: Bank transfer payment method. The channel for bank transfer is always link.
      summary: Bank Transfer
      value:
        payment_session_id: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          banktransfer:
            channel: link
    payments_entity_list_example:
      description: Payments Entity List Example.
      summary: Payments Entity List Example
      value:
      - cf_payment_id: '12376123'
        order_id: order_8123
        entity: payment
        payment_currency: INR
        error_details: null
        order_amount: 10.01
        order_currency: INR
        is_captured: true
        payment_group: upi
        authorization:
          action: CAPTURE
          status: PENDING
          captured_amount: 100
          start_time: '2022-02-09T18:04:34+05:30'
          end_time: '2022-02-19T18:04:34+05:30'
          approve_by: '2022-02-09T18:04:34+05:30'
          action_reference: '6595231908096894505959'
          action_time: '2022-08-03T16:09:51'
        payment_method:
          upi:
            channel: collect
            upi_id: rohit@xcxcx
            upi_payer_ifsc: AXL1234
            upi_payer_account_number: XXXXXXX6024
        payment_amount: 10.01
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: SUCCESS
        payment_surcharge:
          payment_surcharge_service_charge: 0
          payment_surcharge_service_tax: 0
        payment_message: Transaction successful
        bank_reference: P78112898712
        auth_id: A898101
        international_payment:
          international: false
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 1234421ABD
          gateway_payment_id: XABDJ2213
          gateway_order_reference_id: BDIWO233
          gateway_settlement: cashfree
          gateway_reference_name: ''
      - cf_payment_id: '12376124'
        order_id: order_8123
        entity: payment
        payment_currency: INR
        error_details:
          error_code: TRANSACTION_DECLINED
          error_description: issuer bank or payment service provider declined the transaction
          error_reason: auth_declined
          error_source: customer
        order_amount: 10.01
        order_currency: INR
        is_captured: true
        payment_group: credit_card
        authorization: null
        payment_method:
          card:
            channel: link
            card_number: xxxxxx1111
        payment_amount: 10.01
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: FAILED
        payment_surcharge:
          payment_surcharge_service_charge: 0
          payment_surcharge_service_tax: 0
        payment_message: Transaction failed
        bank_reference: P78112898712
        auth_id: A898101
        international_payment:
          international: false
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 1234421ABD
          gateway_payment_id: XABDJ2213
          gateway_order_reference_id: BDIWO233
          gateway_settlement: cashfree
          gateway_reference_name: ''
      - cf_payment_id: '12376152'
        order_id: order_8125
        entity: payment
        payment_currency: USD
        error_details:
          error_code: TRANSACTION_DECLINED
          error_description: issuer bank or payment service provider declined the transaction
          error_reason: auth_declined
          error_source: customer
        order_amount: 100
        order_currency: INR
        is_captured: true
        payment_group: credit_card
        authorization: null
        payment_method:
          card:
            channel: link
            card_number: xxxxxx1111
        payment_amount: 1.25
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: FAILED
        payment_surcharge:
          payment_surcharge_service_charge: 0
          payment_surcharge_service_tax: 0
        payment_message: Transaction failed
        bank_reference: P78112812312
        auth_id: A851201
        international_payment:
          international: true
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 3462421ABD
          gateway_payment_id: XAUIH2213
          gateway_order_reference_id: ZD5WO253
          gateway_settlement: cashfree
          gateway_reference_name: ''
    terminal_payments_entity_list_example:
      description: Payments Entity List Example.
      summary: Payments Entity List Example
      value:
      - cf_payment_id: '12376123'
        order_id: order_8123
        entity: payment
        payment_currency: INR
        error_details: null
        order_amount: 10.01
        is_captured: true
        payment_group: upi
        authorization:
          action: CAPTURE
          status: PENDING
          captured_amount: 100
          start_time: '2022-02-09T18:04:34+05:30'
          end_time: '2022-02-19T18:04:34+05:30'
          approve_by: '2022-02-09T18:04:34+05:30'
          action_reference: '6595231908096894505959'
          action_time: '2022-08-03T16:09:51'
        payment_method:
          upi:
            channel: collect
            upi_id: rohit@xcxcx
            upi_payer_ifsc: AXL1234
            upi_payer_account_number: XXXXXXX6024
        payment_amount: 10.01
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: SUCCESS
        payment_message: Transaction successful
        bank_reference: P78112898712
        auth_id: A898101
        customer_details:
          customer_id: 7112AAA812234
          customer_email: john@cashfree.com
          customer_phone: '9908734801'
          customer_name: John Doe
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 1234421ABD
          gateway_payment_id: XABDJ2213
          gateway_order_reference_id: BDIWO233
          gateway_settlement: cashfree
          gateway_reference_name: ''
      - cf_payment_id: '12376124'
        order_id: order_8123
        entity: payment
        payment_currency: INR
        error_details:
          error_code: TRANSACTION_DECLINED
          error_description: issuer bank or payment service provider declined the transaction
          error_reason: auth_declined
          error_source: customer
        order_amount: 10.01
        is_captured: true
        payment_group: credit_card
        authorization: null
        payment_method:
          card:
            channel: link
            card_number: xxxxxx1111
        payment_amount: 10.01
        payment_time: '2021-07-23T12:15:06+05:30'
        payment_completion_time: '2021-07-23T12:18:59+05:30'
        payment_status: FAILED
        payment_message: Transaction failed
        bank_reference: P78112898712
        auth_id: A898101
        customer_details:
          customer_id: 7112AAA812234
          customer_email: john@cashfree.com
          customer_phone: '9908734801'
          customer_name: John Doe
        payment_gateway_details:
          gateway_name: CASHFREE
          gateway_order_id: 1234421ABD
          gateway_payment_id: XABDJ2213
          gateway_order_reference_id: BDIWO233
          gateway_settlement: cashfree
          gateway_reference_name: ''
    card_plain:
      summary: Pay using plain card
      description: Plain card payment method.
      value:
        payment_session_id: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          card:
            channel: link
            card_number: '4111111111111111'
            card_holder_name: Tushar Gupta
            card_expiry_mm: '06'
            card_expiry_yy: '22'
            card_cvv: '900'
        save_instrument: true
    refunds_entity_example:
      summary: Refund Entity
      description: complete refund object.
      value:
      - cf_payment_id: '918812'
        cf_refund_id: '1553338'
        refund_id: REF-123
        order_id: c6G-QMcbm1848
        entity: refund
        refund_amount: 100.81
        refund_currency: INR
        refund_note: 'Refund for order #123'
        refund_status: SUCCESS
        refund_type: MERCHANT_INITIATED
        refund_splits: []
        status_description: In Progress
        refund_arn: RF12312
        metadata: null
        created_at: '2021-07-25T08:57:52+05:30'
        processed_at: '2021-07-25T12:57:52+05:30'
        refund_charge: 0
        refund_mode: STANDARD
        forex_conversion_handling_charge: 11.12
        forex_conversion_handling_tax: 1.12
        forex_conversion_rate: 84.24
        charges_currency: INR
    cancelled_refunds_entity_example:
      summary: Refund Entity
      description: cancelled refund object.
      value:
        cf_payment_id: '918812'
        cf_refund_id: '1553338'
        refund_id: REF-123
        order_id: c6G-QMcbm1848
        entity: refund
        refund_amount: 100.81
        refund_currency: INR
        refund_note: 'Refund for order #123'
        refund_status: CANCELLED
        refund_type: MERCHANT_INITIATED
        refund_splits: []
        status_description: Refund is cancelled
        refund_speed:
          requested: INSTANT,
          accepted: INSTANT,
          processed: null,
          message: null
        refund_arn: RF12312
        metadata:
          key1: myValue
        created_at: '2021-07-25T08:57:52+05:30'
        processed_at: '2021-07-25T12:57:52+05:30'
        refund_charge: 0
        refund_mode: STANDARD
        forex_conversion_handling_charge: 11.12
        forex_conversion_handling_tax: 1.12
        forex_conversion_rate: 84.24
        charges_currency: INR
    card_saved_token:
      summary: Instrument id of saved card
      description: pay using instrument id or saved card.
      value:
        payment_session_id: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          card:
            channel: link
            instrument_id: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
    card_external_alt_id:
      summary: Instrument id of saved card
      description: Payload for external alt ID payment for cards.
      value:
        payment_session_id: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          card:
            channel: link
            card_number: '4111111111111111'
            card_expiry_mm: '03'
            card_expiry_yy: '26'
            cryptogram: AQBBBBBBZatIlaIAmWKSghwBBBB=
            card_cvv: '900'
            token_type: NETWORK_GC_TOKEN
            card_holder_name: Tushar Gupta
            card_display: '3243'
            token_reference_id: '22457512314'
    card_external_token:
      summary: Card network token and cryptogram
      description: Pay using card network token and cryptogram.
      value:
        payment_session_id: session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn
        transaction_expiry_time: "2021-07-02T10:20:12+05:30"
        payment_method:
          card:
            channel: link
            card_number: '4111111111111111'
            card_expiry_mm: '03'
            card_expiry_yy: '26'
            cryptogram: AQBBBBBBZatIlaIAmWKSghwBBBB=
            card_cvv: '900'
            token_requestor_id: '22457512314'
            card_holder_name: Tushar Gupta
            card_display: '3243'
    create_subscription_charge:
      description: Create Payment. Charge Subscription.
      summary: Create Payment
      value:
        subscription_id: test-subscription-id
        payment_id: test-payment-id
        payment_amount: 10
        payment_schedule_date: '2025-06-01T16:40:00'
        payment_remarks: 2nd EMI payment
        payment_type: CHARGE
        payment_method:
          upi:
            upi_id: john@upi
            channel: collect
    create_subscription_auth_upi_link:
      description: Create Auth using UPI Link.
      summary: Create Auth - UPI Link
      value:
        subscription_id: test-subscription-id
        subscription_session_id: sub_session_Vf5ZOcJTbGkcw4kcpayment
        payment_id: test-payment-id
        payment_type: AUTH
        payment_method:
          upi:
            channel: link
            upi_id: john.doe@okbank
    create_subscription_auth_upi_collect:
      description: Create Auth using UPI Collect.
      summary: Create Auth - UPI Collect
      value:
        subscription_id: test-subscription-id
        subscription_session_id: sub_session_Vf5ZOcJTbGkcw4kcpayment
        payment_id: test-payment-id
        payment_type: AUTH
        payment_method:
          upi:
            channel: collect
            upi_id: john.doe@okbank
    create_subscription_auth_upi_qrcode:
      description: Create Auth using UPI QR Code.
      summary: Create Auth - UPI QR Code
      value:
        subscription_id: test-subscription-id
        subscription_session_id: sub_session_Vf5ZOcJTbGkcw4kcpayment
        payment_id: test-payment-id
        payment_type: AUTH
        payment_method:
          upi:
            channel: qrcode
    create_subscription_auth_card:
      description: Create Auth using Card.
      summary: Create Auth - Card
      value:
        subscription_id: test-subscription-id
        subscription_session_id: sub_session_Vf5ZOcJTbGkcw4kcpayment
        payment_id: test-payment-id
        payment_type: AUTH
        payment_method:
          card:
            channel: link
            card_number: '4111111111111111'
            card_holder_name: John Doe
            card_expiry_mm: '12'
            card_expiry_yy: '25'
            card_cvv: '123'
            card_network: VISA
            card_type: CREDIT
    create_subscription_auth_enach:
      description: Create Auth using eNACH.
      summary: Create Auth - eNACH
      value:
        subscription_id: test-subscription-id
        subscription_session_id: sub_session_Vf5ZOcJTbGkcw4kcpayment
        payment_id: test-payment-id
        payment_type: AUTH
        payment_method:
          enach:
            channel: link
            auth_mode: net_banking
            account_holder_name: John Doe
            account_number: '1518121112'
            account_type: SAVINGS
            account_bank_code: ICIC
    create_subscription_auth_pnach:
      description: Create Auth using Physical NACH.
      summary: Create Auth - Physical NACH
      value:
        subscription_id: test-subscription-id
        subscription_session_id: sub_session_Vf5ZOcJTbGkcw4kcpayment
        payment_id: test-payment-id
        payment_type: AUTH
        payment_method:
          pnach:
            channel: post
            account_holder_name: John Doe
            account_number: '1518121112'
            account_type: SAVINGS
            account_bank_code: ICIC
            account_ifsc: ICIC0000123
            mandate_creation_date: '2025-06-01'
            mandate_start_date: '2025-06-05'
    incident_entity_list_example:
      description: Example list of active incident entries in the ecosystem.
      summary: Incident Object List Example
      value:
        count: 4
        incidents:
        - incident_id: INCIDENT_MEDIUM_HDFCBank_a7259c79-25a8-4b86-bcab-715623fras86
          incident_impact: MEDIUM
          incident_message: We are facing issues with HDFC bank UPI payments.
          incident_start_time: '2021-04-16T14:00:00+05:30'
          incident_end_time: null
          incident_status: OPEN
          incident_type: UNSCHEDULED
          payment_method:
            upi:
              upi_issuer:
              - ALL_BANKS
              upi_psp:
              - GPAY
              - PHONEPE
              upi_vpa:
              - ybl
              is_npci_downtime: false
        - incident_id: INCIDENT_HIGH_sbiBank_a7259c79-4r42-t5f2-fsdd-87987sdf79as
          incident_impact: HIGH
          incident_message: We are facing issues with SBI bank VISA SBI cards payments.
          incident_start_time: '2024-06-01T14:00:00+05:30'
          incident_end_time: '2024-06-01T15:30:00+05:30'
          incident_status: RESOLVED
          incident_type: SCHEDULED
          payment_method:
            card:
              card_issuer:
              - State Bank of India
              card_type:
              - ALL_CARDS
              card_network:
              - VISA
        - incident_id: INCIDENT_HIGH_axisBank_a7259c79-4r42-t5f2-fsdd-87987sdf79as
          incident_impact: HIGH
          incident_message: We are facing issues with Axis bank netbanking payments.
          incident_start_time: '2024-06-01T14:00:00+05:30'
          incident_end_time: null
          incident_status: OPEN
          incident_type: UNSCHEDULED
          payment_method:
            net_banking:
              net_banking_issuer:
              - Axis Bank
              - Bank of Baroda
        - incident_id: INCIDENT_HIGH_hdfcWallet_a7259c79-4r42-t5f2-fsdd-87987sdf79as
          incident_impact: LOW
          incident_message: We are facing issues with HDFC wallet payments.
          incident_start_time: '2024-06-01T14:00:00+05:30'
          incident_end_time: null
          incident_status: UPDATE
          incident_type: UNSCHEDULED
          payment_method:
            wallet:
              wallet_issuer:
              - Mobikwik
              - Paytm
  callbacks:
    PaymentWebhook:
      object Object:
        description: payment webhook object.
        post:
          summary: Received payment success webhook
          security: []
          requestBody:
            required: true
            content:
              application/json:
                schema:
                  type: object
                  properties:
                    data:
                      type: object
                      description: webhook object.
                      properties:
                        order:
                          type: object
                          description: order entity in webhook.
                          properties:
                            order_id:
                              type: string
                            order_amount:
                              type: number
                              format: double
                            order_currency:
                              type: string
                            order_tags:
                              type: object
                              maxProperties: 15
                              description: Custom Tags in the form of {"key":"value"} which can be passed for an order. A
                                maximum of 10 tags can be added.
                              additionalProperties:
                                type: string
                                minLength: 1
                                maxLength: 255
                        payment:
                          allOf:
                          - $ref: '#/components/schemas/PaymentEntity'
                        payment_gateway_details:
                          $ref: '#/components/schemas/PaymentGatewayDetails'
                        payment_surcharge:
                          type: object
                          properties:
                            payment_surcharge_service_charge:
                              type: number
                              format: float64
                            payment_surcharge_service_tax:
                              type: number
                              format: float64
                        payment_offers:
                          type: array
                          items:
                            $ref: '#/components/schemas/OfferEntity'
                        customer_details:
                          type: object
                          description: customer details object in webhook.
                          properties:
                            customer_name:
                              type: string
                              example: Yogesh
                            customer_id:
                              type: string
                              example: '12121212'
                            customer_email:
                              type: string
                              example: yogesh.miglani@gmail.com
                            customer_phone:
                              type: string
                              example: '9666699999'
                    event_time:
                      type: string
                      example: '2021-10-07T19:42:44+05:30'
                    type:
                      type: string
                      example: PAYMENT_SUCCESS_WEBHOOK
          responses:
            '200':
              description: OK
            4XX:
              description: NOT OK. Webhook will be retried.
            5XX:
              description: NOT OK. Webhook will be retried.
  headers:
    x-api-version:
      schema:
        type: string
        format: YYYY-MM-DD
        enum:
        - '2026-01-01'
      description: This header has the version of the API. The current version is `2026-01-01`.
    x-idempotency-key:
      schema:
        type: string
      example: some-idem-id
      description: 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.
    x-idempotency-replayed:
      schema:
        type: string
        format: boolean
      example: 'true'
      description: |-
        In conjunction with `x-idempotency-key` this means
        - `true` if the response was replayed
        - `false` if the response has not been replayed.
    x-ratelimit-limit:
      schema:
        type: integer
      example: 200
      description: Ratelimit set for your account for this API per minute.
    x-ratelimit-remaining:
      schema:
        type: integer
      example: 2
      description: Rate limit remaning for your account for this API in the next minute. Uses sliding window.
    x-ratelimit-retry:
      schema:
        type: integer
      example: 4
      description: |
        Contains number of seconds to wait if rate limit is breached
        - Is 0 if withing the limit
        - Is between 1 and 59 if breached
    x-ratelimit-type:
      schema:
        type: string
        enum:
        - app_id
        - ip
      example: ip
      description: |
        either ip or app_id
        - `ip` if making a call from the browser. True for api where you don't need `x-client-id` and `x-client-secret`
        - `app_id` for authenticated api calls i.e using `x-client-id` and `x-client-secret`
    x-request-id:
      schema:
        type: string
      example: some-req-id
      description: Request id for your api call. Is blank or null if no `x-request-id` is sent during the request.
paths:
  /customers:
    post:
      summary: Create Customer at Cashfree
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      description: Use this API to register a customer in Cashfree's system before initiating payments, subscriptions, tokenisation,
        or other customer-linked actions. It creates a reusable *customer profile* and returns a unique identifier for future
        transactions.
      tags:
      - Customers
      operationId: PGCreateCustomer
      deprecated: false
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateCustomerRequest'
      responses:
        '200':
          description: Success response for creating a customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerEntity'
          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'
  /customers/{customer_id}/instruments?instrument_type=card:
    get:
      summary: Fetch All Saved Card Instrument
      description: Use this API to fetch all saved cards stored for the customer in Cashfree’s [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault).
      tags:
      - Token Vault
      operationId: PGCustomerFetchInstruments
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/customerIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: query
        name: instrument_type
        required: true
        description: Payment mode or type of saved instrument.
        example: card
        schema:
          type: string
          enum:
          - card
      responses:
        '200':
          description: Success response for fetching all saved cards for a customer. Filter the saved cards by token expiry to show only active cards on your checkout.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InstrumentEntityForAllSavedCard'
              examples:
                fetch_all_saved_cards_example:
                  $ref: '#/components/examples/fetch_all_saved_cards_example'
          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'
  /customers/{customer_id}/instruments/{instrument_id}:
    get:
      summary: Fetch Specific Saved Card Instrument
      description: Use this API to fetch a specific saved card stored for the customer in Cashfree’s [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault).
      tags:
      - Token Vault
      operationId: PGCustomerFetchInstrument
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/customerIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: instrument_id
        example: some-instrument-id
        required: true
        description: The instrument_id of the saved instrument which needs to be queried.
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching a saved card.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstrumentEntity'
              examples:
                fetch_all_saved_cards_example:
                  $ref: '#/components/examples/fetch_all_saved_cards_example'
          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'
        '502':
          $ref: '#/components/responses/Response502'
    delete:
      summary: Delete Saved Card Instrument
      description: Use this API to delete a specific saved card stored for the customer in Cashfree’s [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault).
      tags:
      - Token Vault
      operationId: PGCustomerDeleteInstrument
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/customerIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: instrument_id
        required: true
        example: some-instrument-id
        description: The instrument_id which needs to be deleted.
        schema:
          type: string
      responses:
        '200':
          description: Success response for deleting a saved card.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedInstrumentEntity'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /customers/{customer_id}/instruments/{instrument_id}/cryptogram:
    get:
      summary: Fetch Cryptogram for a Saved Card Instrument
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      description: 'Use this API to retrieve the token and cryptogram for a specific saved card stored in Cashfree''s [Token
        Vault](https://www.cashfree.com/docs/payments/features/token-vault). '
      tags:
      - Token Vault
      operationId: PGCustomerInstrumentsFetchCryptogram
      deprecated: false
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/customerIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: instrument_id
        required: true
        example: some-instrument-id
        description: Identifier for the specific card to fetch its details.
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching a cryptogram for a saved card.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptogramEntity'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /eligibility/cardlessemi:
    post:
      summary: Get Eligible Cardless EMI Payment Methods for a customer on an order
      description: Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their
        phone number.
      tags:
      - Eligibility
      operationId: PGEligibilityFetchCardlessEMI
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/EligibilityFetchCardlessEMIRequest'
      responses:
        '200':
          description: Success response for fetching eligible cardless EMI options.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EligibilityCardlessEMIEntity'
              example:
              - eligibility: true
                entity_type: cardlessemi
                entity_value: idfc
                entity_details:
                  payment_method: idfc
                  emi_plans:
                  - tenure: 1
                    interest_rate: 10
                    currency: INR
                    emi: 400
                    total_interest: 10
                    total_amount: 40
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /eligibility/offers:
    post:
      summary: Get Eligible Offers for an Order
      description: Use this API to get eligible offers for an order_id or order amount.
      tags:
      - Eligibility
      operationId: PGEligibilityFetchOffers
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/EligibilityFetchOffersRequest'
      responses:
        '200':
          description: Success response for fetching eligible offers.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EligibilityOfferEntity'
              examples:
                offer_entity_example:
                  $ref: '#/components/examples/offer_entity_example'
          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'
  /eligibility/paylater:
    post:
      summary: Get Eligible Paylater for a customer on an order
      description: Use this API to get eligible Paylater Payment Methods for a customer on an order.
      tags:
      - Eligibility
      operationId: PGEligibilityFetchPaylater
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/EligibilityFetchPaylaterRequest'
      responses:
        '200':
          description: Success response for fetching eligible Pay Later options.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EligibilityPaylaterEntity'
              example:
              - eligibility: true
                entity_type: paylater
                entity_value: olapostpaid
                entity_details:
                  payment_method: olapostpaid
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /eligibility/payment_methods:
    post:
      summary: Get eligible Payment Methods
      description: Use this API to get eligible Payment Methods.
      tags:
      - Eligibility
      operationId: PGEligibilityFetchPaymentMethods
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - &id001
        $ref: '#/components/parameters/xClientDeviceHeader'
      - &id002
        $ref: '#/components/parameters/xClientOsHeader'
      - &id003
        $ref: '#/components/parameters/xClientRenderingTypeHeader'
      - &id004
        $ref: '#/components/parameters/xClientBrowserHeader'
      requestBody:
        $ref: '#/components/requestBodies/EligibilityFetchPaymentMethodsRequest'
      responses:
        '200':
          description: Success response for fetching eligible payment methods.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EligibilityPaymentMethodsEntity'
              example:
              - eligibility: true
                entity_type: payment_methods
                entity_value: netbanking
                entity_details:
                  payment_method_details:
                  - nick: motak_kahindra_bank
                    display: Motak Kahindra Bank
                    eligibility: true
                    code: 3032
                  - nick: bank_of_india
                    display: Bank Of India
                    eligibility: true
                    code: 3031
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /links:
    post:
      summary: Create Payment Link
      description: Use this API to create a new payment link. The created payment link url will be available in the API response
        parameter link_url.
      tags:
      - Payment Links
      operationId: PGCreateLink
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateLinkRequest'
      responses:
        '200':
          description: Success response for creating a payment link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkEntity'
          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'
  /links/{link_id}:
    get:
      summary: Fetch Payment Link Details
      description: Use this API to view all details and status of a payment link.
      tags:
      - Payment Links
      operationId: PGFetchLink
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/linkIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          description: Success response for fetching a payment link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkEntity'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /links/{link_id}/cancel:
    post:
      summary: Cancel Payment Link
      description: Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a
        link in ACTIVE status can be cancelled.
      tags:
      - Payment Links
      operationId: PGCancelLink
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/linkIDParam'
      responses:
        '200':
          description: Success response for cancelling a payment link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkEntity'
          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'
  /links/{link_id}/orders:
    get:
      summary: Get Orders for a Payment Link
      description: Use this API to view all order details for a payment link.
      tags:
      - Payment Links
      operationId: PGLinkFetchOrders
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/linkIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/statusQueryParam'
      responses:
        '200':
          description: Success response for fetching orders for a payment link.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PaymentLinkOrderEntity'
              examples:
                order_entity_list_example:
                  $ref: '#/components/examples/order_entity_list_example'
          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'
  /offers:
    post:
      summary: Create Offer
      description: Use this API to create offers with Cashfree from your backend.
      tags:
      - Offers
      operationId: PGCreateOffer
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateOfferRequest'
      responses:
        '200':
          description: Success response for creating an offer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfferEntity'
          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'
  /offers/{offer_id}:
    get:
      summary: Get Offer by ID
      description: Use this API to get offer by offer_id.
      tags:
      - Offers
      operationId: PGFetchOffer
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: offer_id
        required: true
        example: d2b430fb-1afe-455a-af31-66d00377b29a
        description: The offer ID for which you want to view the offer details.
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching an offer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfferEntity'
          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:
    post:
      summary: Create Order
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      description: "\n\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: Success response for creating an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEntity'
              examples:
                create_order_success:
                  value:
                    cf_order_id: '2149460581'
                    created_at: '2023-08-11T18:02:46+05:30'
                    customer_details:
                      customer_id: '409128494'
                      customer_name: John Doe
                      customer_email: pmlpayme@ntsas.com
                      customer_phone: '9876543210'
                      customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
                    entity: order
                    order_amount: 22
                    payment_session_id: session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH
                    order_currency: INR
                    order_expiry_time: '2023-09-09T18:02:46+05:30'
                    order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
                    order_meta:
                      return_url: https://www.cashfree.com/devstudio/thankyou
                      payment_methods: cc
                      notify_url: https://example.com/cf_notify
                    order_note: Order created for payment
                    order_splits: []
                    order_status: ACTIVE
                    order_tags:
                      name: John
                      age: '19'
                    terminal_data: null
                    cart_details:
                      cart_id: '1'
          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'
      callbacks:
        PaymentWebhook:
          $ref: '#/components/callbacks/PaymentWebhook'
  /orders/pay/authenticate/{cf_payment_id}:
    post:
      summary: Submit or Resend OTP
      description: Use this API to submit or resend OTP if you use [Native OTP](https://www.cashfree.com/docs/payments/features/native-otp) for authentication of card payments. Native OTP must be enabled for your account.
      tags:
      - Payments
      operationId: PGOrderAuthenticatePayment
      deprecated: false
      security: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/cfPaymentIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/OrderAuthenticatePaymentRequest'
      responses:
        '200':
          description: Success response for submitting or resending an OTP.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderAuthenticateEntity'
              examples:
                submit_otp:
                  value:
                    action: SUBMIT_OTP
                    authenticate_status: SUCCESS
                    cf_payment_id: '3991872901'
                    payment_message: payment successful
                resend_otp:
                  value:
                    action: RESEND_OTP
                    authenticate_status: SUCCESS
                    cf_payment_id: '5114916442998'
                    payment_message: otp sent successfully
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/sessions:
    post:
      summary: Order Pay
      description: |
        Use this API when you have already created the order using [Create Order API](https://www.cashfree.com/docs/api-reference/payments/latest/orders/create) and want Cashfree to process the payment. To use this API S2S flag needs to be enabled from the backend. In case you want to use this API for plain cards payments also, the PCI DSS flag is required, for more information fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1).
      operationId: PGPayOrder
      deprecated: false
      tags:
      - Payments
      security: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - *id001
      - *id002
      - *id003
      - *id004
      requestBody:
        $ref: '#/components/requestBodies/PayOrderRequest'
      responses:
        '200':
          description: Success response for creating a transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayOrderEntity'
              examples:
                card:
                  value:
                    action: link
                    cf_payment_id: '4105073870'
                    channel: link
                    payment_amount: 1.75
                    payment_method: card
                    data:
                      url: https://api.cashfree.com/pg/view/gateway/session_FEeYTISZ-xOJcuR7YeOZOm1MhVIrjHa2l1G79Pg_ZktVJxPSdu7oAKf9RTFZQlR19lkBU7VGIh8dARedu9otO8VstZVT3-HpjLpIn75v-hKCNOxYuEOV_wJ975ed89f2-ad57-4094-8728-7cff9f1928f2
                      payload: null
                      content_type: null
                      method: null
                upi:
                  value:
                    action: custom
                    cf_payment_id: '7845123001'
                    payment_method: upi
                    channel: collect
                    payment_amount: 250.0
                    data:
                      vpa: testsuccess@gocash
                      expiry: '2025-10-07T18:30:00+05:30'
                      payload: null
                      content_type: null
                      method: null
                netbanking:
                  value:
                    action: link
                    cf_payment_id: '7845123101'
                    payment_method: netbanking
                    channel: link
                    payment_amount: 999.0
                    data:
                      url: https://api.cashfree.com/pg/view/gateway/session_...
                      bank:
                        code: TESTR
                        name: TEST Bank
                      payload: null
                      content_type: null
                      method: null
                app:
                  value:
                    action: link
                    cf_payment_id: '7845123301'
                    payment_method: app
                    channel: link
                    payment_amount: 75.0
                    data:
                      url: https://api.cashfree.com/pg/view/gateway/session_...
                      provider: TEST_WALLET
                      payload: null
                      content_type: null
                      method: null
                card_emi:
                  value:
                    action: link
                    cf_payment_id: '7845123401'
                    payment_method: card_emi
                    channel: link
                    payment_amount: 1200.0
                    data:
                      url: https://api.cashfree.com/pg/view/gateway/session_...
                      emi_plan:
                        tenure: 6
                        rate: 14.0
                      payload: null
                      content_type: null
                      method: null
                cardless_emi:
                  value:
                    action: link
                    cf_payment_id: '7845123501'
                    payment_method: cardless_emi
                    channel: link
                    payment_amount: 1500.0
                    data:
                      url: https://api.cashfree.com/pg/view/gateway/session_...
                      provider: TEST_CARDLESS_EMI
                      payload: null
                      content_type: null
                      method: null
                paylater:
                  value:
                    action: link
                    cf_payment_id: '7845123601'
                    payment_method: paylater
                    channel: link
                    payment_amount: 899.0
                    data:
                      url: https://api.cashfree.com/pg/view/gateway/session_...
                      provider: TEST_PAYLATER
                      payload: null
                      content_type: null
                      method: null
                banktransfer:
                  value:
                    action: custom
                    cf_payment_id: '7845123701'
                    payment_method: banktransfer
                    channel: qrcode
                    payment_amount: 500.0
                    data:
                      account_number: XXXXXXXX1234
                      ifsc: CASHF000XXX
                      virtual_vpa: order_8123@cashfree
                      payload: null
                      content_type: null
                      method: null
                card_native_otp:
                  value:
                    action: post
                    cf_payment_id: '3991346241'
                    channel: post
                    payment_amount: 1.75
                    payment_method: card
                    data:
                      url: https://api.cashfree.com/pg/orders/pay/authenticate/3991346241
                      payload: null
                      content_type: application/json
                      method: post
                      redirect_to_bank: https://api.cashfree.com/pg/view/redirecttobank/MV47yJlEMkr8X_Er5YDZ-uiKHU7IGrK2kH7CTtcjeaU8v10fAeLoLL9osqoUQrmBxnbV809FFzyQTKQy
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/{order_id}:
    get:
      summary: Get Order
      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"
      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: Success response for fetching an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEntity'
              examples:
                get_order_active:
                  summary: Active Order
                  value:
                    cf_order_id: '2149460581'
                    created_at: '2023-08-11T18:02:46+05:30'
                    customer_details:
                      customer_id: '409128494'
                      customer_name: John Doe
                      customer_email: pmlpayme@ntsas.com
                      customer_phone: '9876543210'
                      customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
                    entity: order
                    order_amount: 22
                    payment_session_id: session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH
                    order_currency: INR
                    order_expiry_time: '2023-09-09T18:02:46+05:30'
                    order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
                    order_meta:
                      return_url: https://www.cashfree.com/devstudio/thankyou
                      payment_methods: cc
                      notify_url: https://example.com/cf_notify
                    order_note: Order created for payment
                    order_splits: []
                    order_status: ACTIVE
                    order_tags:
                      name: John
                      age: '19'
                    terminal_data: null
                    cart_details:
                      cart_id: '1'
                get_order_paid:
                  summary: Paid Order
                  value:
                    cf_order_id: '2149460582'
                    created_at: '2023-08-10T14:30:20+05:30'
                    customer_details:
                      customer_id: '409128495'
                      customer_name: Jane Smith
                      customer_email: jane.smith@example.com
                      customer_phone: '9876543211'
                      customer_uid: 64deabb4-ca45-4b60-9e6a-9c016fe7ab11
                    entity: order
                    order_amount: 150.5
                    payment_session_id: session_b2VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH
                    order_currency: INR
                    order_expiry_time: '2023-09-08T14:30:20+05:30'
                    order_id: order_4353Ur5Fgk0DD6SEfNfpcnKPXPCKjk
                    order_meta:
                      return_url: https://www.cashfree.com/devstudio/thankyou
                      payment_methods: upi,card,netbanking
                      notify_url: https://example.com/cf_notify
                    order_note: Payment completed successfully
                    order_splits: []
                    order_status: PAID
                    order_tags:
                      product: Premium Plan
                      category: subscription
                    terminal_data: null
                    cart_details:
                      cart_id: '2'
          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: Success response for terminating an order.
          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
      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.
      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: Success response for fetching extended data for an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderExtendedDataEntity'
              examples:
                get_order_extended_success:
                  value:
                    cf_order_id: '2149460581'
                    order_id: order_3242Tq4Edj9CC5RDcMeobmJOWOBJij
                    order_amount: 22
                    order_currency: INR
                    created_at: '2023-08-11T18:02:46+05:30'
                    charges:
                      shipping_charges: 5
                      cod_handling_charges: 10
                    customer_details:
                      customer_id: '409128494'
                      customer_name: Aditya Keshri
                      customer_email: pmlpayme@ntsas.com
                      customer_phone: '9876543210'
                      customer_uid: 54deabb4-ba45-4a60-9e6a-9c016fe7ab10
                    shipping_address:
                      name: Saurav Singh
                      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
                    billing_address:
                      name: Saurav Singh
                      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
                    cart:
                      name: test
                      items:
                      - item_id: '26'
                        item_name: Sample Product
                        item_description: item-description
                        item_tags:
                        - '1'
                        - '2'
                        item_details_url: http://cashfree.com
                        item_image_url: http://cashfree.com
                        item_original_unit_price: '1'
                        item_discounted_unit_price: '1'
                        item_quantity: 1
                        item_currency: INR
                    offer:
                      offer_id: d2b430fb-1afe-455a-af31-66d00377b29a
                      offer_status: active
                      offer_meta:
                        offer_title: some title
                        offer_description: some offer description
          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'
    put:
      summary: Update Order Extended
      description: |
        Use this api to update the order related data like shipment details,order delivery status etc.
        ## When to use this API
        - To provide/update the shipment details or order delivery status.
        - Once the order is PAID.
      tags:
      - Orders
      operationId: PGUpdateOrderExtendedData
      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/UpdateOrderExtendedRequest'
      responses:
        '200':
          description: Success response for updating extended data for an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrderExtendedDataEntity'
          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}/authorization:
    post:
      summary: Preauthorisation
      description: Use this API to capture or void a [pre-authorised](/docs/payments/features/pre-authorisation) payment.
      operationId: PGAuthorizeOrder
      deprecated: false
      tags:
      - Payments
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/orderIDParam'
      requestBody:
        $ref: '#/components/requestBodies/AuthorizeOrderRequest'
      responses:
        '200':
          description: Success response for capturing or voiding a pre-authorised payment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentEntity'
              examples:
                card_capture:
                  value:
                    auth_id: 016381
                    authorization:
                      action: CAPTURE
                      status: SUCCESS
                      captured_amount: 1
                      start_time: '2025-07-15T16:40:24+05:30'
                      end_time: '2025-07-18T16:40:24+05:30'
                      approve_by: null
                      action_reference: '7525782703466058805917'
                      action_time: '2025-07-15T16:47:50.285775'
                    bank_reference: '519611740779'
                    cf_payment_id: '4129256397'
                    entity: payment
                    error_details: null
                    international_payment:
                      international: false
                    is_captured: true
                    order_amount: 1
                    order_currency: INR
                    order_id: abhishek-287
                    payment_amount: 1
                    payment_completion_time: '2025-07-15T16:40:51+05:30'
                    payment_currency: INR
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: null
                      gateway_payment_id: null
                      gateway_order_reference_id: null
                      gateway_status_code: null
                      gateway_settlement: cashfree
                      gateway_reference_name: null
                    payment_group: debit_card
                    payment_message: PRE_AUTH|Transaction Success
                    payment_method:
                      card:
                        card_bank_name: KOTAK MAHINDRA BANK
                        card_country: IN
                        card_network: visa
                        card_network_reference_id: null
                        card_number: XXXXXXXXXXXX4738
                        card_sub_type: R
                        card_type: debit_card
                        channel: link
                    payment_offers: null
                    payment_status: SUCCESS
                    payment_surcharge: null
                    payment_time: '2025-07-15T16:40:24+05:30'
                card_void:
                  value:
                    auth_id: '023166'
                    authorization:
                      action: VOID
                      status: SUCCESS
                      captured_amount: null
                      start_time: '2025-07-15T16:49:06+05:30'
                      end_time: '2025-07-18T16:49:06+05:30'
                      approve_by: null
                      action_reference: '7525784179616489005910'
                      action_time: '2025-07-15T16:50:17.911008'
                    bank_reference: '519611251479'
                    cf_payment_id: '4129285491'
                    entity: payment
                    error_details: null
                    international_payment:
                      international: false
                    is_captured: false
                    order_amount: 1
                    order_currency: INR
                    order_id: abhishek-288
                    payment_amount: 1
                    payment_completion_time: '2025-07-15T16:49:40+05:30'
                    payment_currency: INR
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: null
                      gateway_payment_id: null
                      gateway_order_reference_id: null
                      gateway_status_code: null
                      gateway_settlement: cashfree
                      gateway_reference_name: null
                    payment_group: debit_card
                    payment_message: PRE_AUTH|Transaction Success
                    payment_method:
                      card:
                        card_bank_name: KOTAK MAHINDRA BANK
                        card_country: IN
                        card_network: visa
                        card_network_reference_id: null
                        card_number: XXXXXXXXXXXX4738
                        card_sub_type: R
                        card_type: debit_card
                        channel: link
                    payment_offers: null
                    payment_status: VOID
                    payment_surcharge: null
                    payment_time: '2025-07-15T16:49:06+05:30'
                upi_capture:
                  value:
                    cf_payment_id: '12376123'
                    order_id: order_8123
                    entity: payment
                    payment_currency: INR
                    error_details: null
                    order_amount: 10.01
                    order_currency: INR
                    is_captured: true
                    payment_group: upi
                    authorization:
                      action: CAPTURE
                      status: PENDING
                      captured_amount: 100
                      start_time: '2022-02-09T18:04:34+05:30'
                      end_time: '2022-02-19T18:04:34+05:30'
                      approve_by: '2022-02-09T18:04:34+05:30'
                      action_reference: '6595231908096894505959'
                      action_time: '2022-08-03T16:09:51'
                    payment_method:
                      upi:
                        channel: collect
                        upi_id: rohit@xcxcx
                        upi_payer_ifsc: AXL1234
                        upi_payer_account_number: XXXXXXX6024
                    payment_amount: 10.01
                    payment_time: '2021-07-23T12:15:06+05:30'
                    payment_completion_time: '2021-07-23T12:18:59+05:30'
                    payment_status: SUCCESS
                    payment_message: Transaction successful
                    bank_reference: P78112898712
                    auth_id: A898101
                    international_payment:
                      international: false
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: 1234421ABD
                      gateway_payment_id: XABDJ2213
                      gateway_order_reference_id: BDIWO233
                      gateway_settlement: cashfree
                      gateway_reference_name: ''
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/{order_id}/payments:
    get:
      summary: Get Payments for an Order
      description: Use this API to view all payment details for an order.
      tags:
      - Payments
      operationId: PGOrderFetchPayments
      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: Success response for fetching payments for an order.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PaymentEntity'
              examples:
                upi:
                  $ref: '#/components/examples/payments_entity_list_example'
                card:
                  value:
                  - auth_id: '749842'
                    authorization: null
                    bank_reference: '519615460937'
                    cf_payment_id: '4128924251'
                    entity: payment
                    error_details: null
                    international_payment:
                      international: false
                    is_captured: true
                    order_amount: 1
                    order_currency: INR
                    order_id: order_18482zuD6LhQGYO3OOihGjnlDV4OzpD
                    payment_amount: 1
                    payment_completion_time: '2025-07-15T15:02:48+05:30'
                    payment_currency: INR
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: null
                      gateway_payment_id: null
                      gateway_order_reference_id: null
                      gateway_status_code: null
                      gateway_settlement: cashfree
                      gateway_reference_name: null
                    payment_group: debit_card
                    payment_message: Transaction Success
                    payment_method:
                      card:
                        card_bank_name: KOTAK MAHINDRA BANK
                        card_country: IN
                        card_network: visa
                        card_network_reference_id: null
                        card_number: XXXXXXXXXXXX4738
                        card_sub_type: R
                        card_type: debit_card
                        channel: link
                      payment_offers: null
                      payment_status: SUCCESS
                      payment_surcharge:
                        payment_surcharge_service_charge: 0
                        payment_surcharge_service_tax: 0
                      payment_time: '2025-07-15T15:01:53+05:30'
                  - auth_id: null
                    authorization: null
                    bank_reference: null
                    cf_payment_id: '4128923713'
                    entity: payment
                    error_details:
                      error_code: ''
                      error_description: ''
                      error_reason: ''
                      error_source: ''
                      error_code_raw: '05'
                      error_description_raw: AUTHENTICATION_FAILURE - (01 - Cardholder selected Cancel)
                      error_subcode_raw: ''
                    international_payment:
                      international: false
                    is_captured: false
                    order_amount: 1
                    order_currency: INR
                    order_id: order_18482zuD6LhQGYO3OOihGjnlDV4OzpD
                    payment_amount: 1
                    payment_completion_time: '2025-07-15T15:01:49+05:30'
                    payment_currency: INR
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: null
                      gateway_payment_id: null
                      gateway_order_reference_id: null
                      gateway_status_code: null
                      gateway_settlement: cashfree
                      gateway_reference_name: null
                    payment_group: debit_card
                    payment_message: Transaction Failed -  (01 - Cardholder selected Cancel)
                    payment_method:
                      card:
                        card_bank_name: KOTAK MAHINDRA BANK
                        card_country: IN
                        card_network: visa
                        card_network_reference_id: null
                        card_number: XXXXXXXXXXXX4738
                        card_sub_type: R
                        card_type: debit_card
                        channel: link
                      payment_offers: null
                      payment_status: FAILED
                      payment_surcharge:
                        payment_surcharge_service_charge: 0
                        payment_surcharge_service_tax: 0
                      payment_time: '2025-07-15T15:01:53+05:30'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/{order_id}/payments/{cf_payment_id}:
    get:
      summary: Get Payment by ID
      description: Use this API to view payment details of an order for a payment ID.
      tags:
      - Payments
      operationId: PGOrderFetchPayment
      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/cfPaymentIDParam'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          description: Success response for fetching a payment by ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentEntity'
              examples:
                upi:
                  value:
                    cf_payment_id: '12376123'
                    order_id: order_8123
                    entity: payment
                    payment_currency: INR
                    error_details: null
                    order_amount: 10.01
                    order_currency: INR
                    is_captured: true
                    payment_group: upi
                    authorization:
                      action: CAPTURE
                      status: PENDING
                      captured_amount: 100
                      start_time: '2022-02-09T18:04:34+05:30'
                      end_time: '2022-02-19T18:04:34+05:30'
                      approve_by: '2022-02-09T18:04:34+05:30'
                      action_reference: '6595231908096894505959'
                      action_time: '2022-08-03T16:09:51'
                    payment_method:
                      upi:
                        channel: collect
                        upi_id: rohit@xcxcx
                        upi_payer_ifsc: AXL1234
                        upi_payer_account_number: XXXXXXX6024
                    payment_amount: 10.01
                    payment_time: '2021-07-23T12:15:06+05:30'
                    payment_completion_time: '2021-07-23T12:18:59+05:30'
                    payment_status: SUCCESS
                    payment_surcharge:
                      payment_surcharge_service_charge: 0
                      payment_surcharge_service_tax: 0
                    payment_message: Transaction successful
                    bank_reference: P78112898712
                    auth_id: A898101
                    international_payment:
                      international: false
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: 1234421ABD
                      gateway_payment_id: XABDJ2213
                      gateway_order_reference_id: BDIWO233
                      gateway_settlement: cashfree
                      gateway_reference_name: ''
                card:
                  value:
                    auth_id: '749842'
                    authorization: null
                    bank_reference: '519615460937'
                    cf_payment_id: '4128924251'
                    entity: payment
                    error_details: null
                    international_payment:
                      international: false
                    is_captured: true
                    order_amount: 1
                    order_currency: INR
                    order_id: order_18482zuD6LhQGYO3OOihGjnlDV4OzpD
                    payment_amount: 1
                    payment_completion_time: '2025-07-15T15:02:48+05:30'
                    payment_currency: INR
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: null
                      gateway_payment_id: null
                      gateway_order_reference_id: null
                      gateway_status_code: null
                      gateway_settlement: cashfree
                      gateway_reference_name: null
                    payment_group: debit_card
                    payment_message: Transaction Success
                    payment_method:
                      card:
                        card_bank_name: KOTAK MAHINDRA BANK
                        card_country: IN
                        card_network: visa
                        card_network_reference_id: null
                        card_number: XXXXXXXXXXXX4738
                        card_sub_type: R
                        card_type: debit_card
                        channel: link
                    payment_offers: []
                    payment_status: SUCCESS
                    payment_surcharge:
                      payment_surcharge_service_charge: 0
                      payment_surcharge_service_tax: 0
                    payment_time: '2025-07-15T15:01:53+05:30'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/{order_id}/refunds:
    post:
      summary: Create Refund
      description: Use this API to initiate refunds. <Note> You can initiate refunds only within six months of the original
        successful transaction's date and time.</Note>
      tags:
      - Refunds
      operationId: PGOrderCreateRefund
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/orderIDParam'
      requestBody:
        $ref: '#/components/requestBodies/OrderCreateRefundRequest'
      responses:
        '200':
          description: Success response for creating a refund for an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundEntity'
              examples:
                refunds_entity_example:
                  $ref: '#/components/examples/refunds_entity_example'
          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'
        '502':
          $ref: '#/components/responses/Response502'
    get:
      summary: Get All Refunds for an Order
      description: Use this API to fetch all refunds processed against an order.
      tags:
      - Refunds
      operationId: PGOrderFetchRefunds
      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: Success response for fetching all refunds for an order.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RefundEntity'
              examples:
                refunds_entity_example:
                  $ref: '#/components/examples/refunds_entity_example'
          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}/refunds/{refund_id}:
    get:
      summary: Get Refund
      description: Use this API to fetch a specific refund processed on your Cashfree Account.
      tags:
      - Refunds
      operationId: PGOrderFetchRefund
      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'
      - in: path
        name: refund_id
        description: Refund Id of the refund you want to fetch.
        required: true
        example: some-refund-id
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching a refund.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundEntity'
          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'
        '502':
          $ref: '#/components/responses/Response502'
    put:
      summary: Update Refund
      description: Use this API to Update refunds.
      tags:
      - Refunds
      operationId: PGOrderUpdateRefund
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/orderIDParam'
      - in: path
        name: refund_id
        description: Refund Id of the refund you want to update.
        required: true
        example: some-refund-id
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/OrderUpdateRefundRequest'
      responses:
        '200':
          description: Success response for updating a refund.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundEntity'
              examples:
                refunds_entity_example:
                  $ref: '#/components/examples/cancelled_refunds_entity_example'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/{order_id}/settlements:
    get:
      summary: Get Settlements by Order ID
      tags:
      - Settlements
      operationId: PGOrderFetchSettlement
      deprecated: false
      description: Use this API to view the latest linked settlement details for a particular order, including pending and failed settlements.
      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: Success response for fetching settlements for an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderSettlementEntity'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /orders/settlements:
    post:
      summary: Mark Order For Settlement
      tags:
      - Settlements
      operationId: MarkForSettlement
      deprecated: false
      description: Use this API to pass the CBRIKS ID to Cashfree and mark an order for settlement.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateOrderSettlementRequestBody'
      responses:
        '200':
          description: Success response for marking an order for settlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkOrderSettlementResponse'
          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/Response400CreateSettlementorder'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404CreateSettlementorder'
        '429':
          $ref: '#/components/responses/Response429'
  /easy-split/vendors/{vendor_id}:
    get:
      summary: Get Vendor All Details
      tags:
      - Easy-Split
      operationId: PGESFetchVendors
      deprecated: false
      description: Use this API to get the details of a specific vendor associated with your Easy Split account.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/getVendorSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400InvalidVendorId'
    patch:
      summary: Update vendor Details
      tags:
      - Easy-Split
      operationId: PGESUpdateVendors
      deprecated: false
      description: Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details
        such as name, email, phone number, upi details, and any of the KYC details.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateVendorRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/UpdateVendorSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400UpdateVendor'
  /easy-split/vendors:
    post:
      summary: Create vendor
      tags:
      - Easy-Split
      operationId: PGESCreateVendors
      deprecated: false
      description: Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details
        such as account_type, business_type, gst, cin, pan, passport number and so on.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/CreateVendorRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/createVendorSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400CreateVendor'
  /easy-split/vendor-docs/{vendor_id}:
    get:
      summary: Get Vendor All Documents Status
      tags:
      - Easy-Split
      operationId: PGESGetVendorsDocs
      deprecated: false
      description: Use this API to fetch the details of all the KYC details of a particular vendor.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/getVendorDocsSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400InvalidVendorId'
    post:
      summary: Upload Vendor Docs
      tags:
      - Easy-Split
      operationId: PGESUploadVendorsDocs
      deprecated: false
      description: Use this API to upload KYC documents of a specific vendor.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              description: Request body to upload vendor documents.
              properties:
                doc_type:
                  type: string
                  description: 'Mention the type of the document you are uploading. Possible values: UIDAI_FRONT, UIDAI_BACK,
                    UIDAI_NUMBER, DL, DL_NUMBER, PASSPORT_FRONT, PASSPORT_BACK, PASSPORT_NUMBER, VOTER_ID, VOTER_ID_NUMBER,
                    PAN, PAN_NUMBER, GST, GSTIN_NUMBER, CIN, CIN_NUMBER, NBFC_CERTIFICATE. If the doc type ends with a number
                    you should add the doc value else upload the doc file.'
                doc_value:
                  type: string
                  description: Enter the display name of the uploaded file.
                file:
                  type: string
                  format: binary
                  description: Select the document that should be uploaded or provide the path of that file. You cannot upload
                    a file that is more than 2MB in size.
            examples:
              PG:
                value:
                  doc_type: PAN
                  file: '@''/Users/john/Downloads/pan.jpeg'''
                  doc_value: ABCD1234
              Auto Collect:
                value:
                  doc_type: PAN
                  file: '@''/Users/john/Downloads/pan.jpeg'''
                  doc_value: ABCD1234
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/uploadVendorDocsSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400UploadVendorDocs'
  /easy-split/vendor-docs/{vendor_id}/download/{doc_type}:
    get:
      summary: Download Vendor Documents
      tags:
      - Easy-Split
      operationId: PGESDownloadVendorsDocs
      deprecated: false
      description: Use this API to download the uploaded KYC documents of that particular vendor. Provide the document type.
        Click the link from the sample request to download the KYC document.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/docTypeParam'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/downloadVendorDocsSuccessResponse'
  /easy-split/vendors/{vendor_id}/balances:
    get:
      summary: Get On Demand Balance
      tags:
      - Easy-Split
      operationId: PGESGetVendorBalance
      deprecated: false
      description: This API fetches the available amount with the merchant, vendor, and the unsettled amount for the merchant
        as well as the vendor.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/GetVendorBalanceSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400InvalidVendorId'
  /easy-split/amount/{amount}/charges:
    get:
      summary: Get Vendor Balance Transfer Charges
      tags:
      - Easy-Split
      operationId: PGESGetVendorBalanceTransferCharges
      deprecated: false
      description: This API returns the applicable service charge and service tax for a vendor balance transfer, based on
        the provided amount and rate type.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/amountParam'
      - $ref: '#/components/parameters/rateTypeParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/GetVendorBalanceTransferChargesSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400GetVendorBalanceTransferCharges'
  /easy-split/vendors/{vendor_id}/transfer:
    post:
      summary: Create On Demand Transfer
      tags:
      - Easy-Split
      operationId: PGESCreateOnDemandTransfer
      deprecated: false
      description: The Create On Demand Transfer API will create a new on-demand request either from to the merchant or from
        to the vendor.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/AdjustVendorBalanceRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/adjustVendorBalanceSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400AdjustVendorBalance'
  /easy-split/orders/{order_id}/split:
    post:
      summary: Split After Payment
      tags:
      - Easy-Split
      operationId: PGOrderSplitAfterPayment
      deprecated: false
      description: The Split After Payment API splits payments to vendors after customers successfully complete a payment.
        After you receive a successful payment confirmation, wait 2 minutes before you call this API endpoint.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/SplitAfterPaymentRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/orderIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/SplitAfterPaymentSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400SplitAfterPayment'
        '404':
          $ref: '#/components/responses/Response404SplitAfterPayment'
        '409':
          $ref: '#/components/responses/Response409SplitAfterPayment'
  /easy-split/static-split:
    post:
      summary: Create Static Split Configuration
      tags:
      - Easy-Split
      operationId: PGOrderStaticSplit
      deprecated: false
      description: This API will create a static split scheme wherein you can define the split type and the vendor-wise split
        percentage.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/StaticSplitRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/StaticSplitSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400StaticSplit'
  /easy-split/vendors/{vendor_id}/adjustment:
    post:
      summary: Create Adjustment
      tags:
      - Easy-Split
      operationId: PGESCreateAdjustment
      deprecated: false
      description: The Create Adjustment API will create a adjustment request either from vendor to the merchant or from merchant
        to the vendor.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/VendorAdjustmentRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/vendorIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/VendorAdjustmentSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400VendorAdjustment'
  /easy-split/orders/{order_id}:
    get:
      summary: Get Split and Settlement Details by OrderID
      tags:
      - Easy-Split
      operationId: PGSplitOrderRecon
      deprecated: false
      description: Use this API to get all the split details, settled and unsettled transactions details of each vendor who
        were part of a particular order by providing order Id or start date and end date.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/orderIDParam'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/SplitOrderReconSuccessResponse'
        '404':
          $ref: '#/components/responses/Response404SplitOrderRecon'
  /split/order/vendor/recon:
    post:
      summary: Get Split and Settlement Details by OrderID v2.0
      tags:
      - Easy-Split
      operationId: PGESOrderRecon
      deprecated: false
      description: Use this API to get all the split details, settled and unsettled transactions details of each vendor who
        were part of a particular order by providing order Id or start date and end date.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      requestBody:
        $ref: '#/components/requestBodies/ESOrderReconRequestBody'
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          $ref: '#/components/responses/ESOrderReconSuccessResponse'
        '400':
          $ref: '#/components/responses/Response400ESOrderRecon'
        '404':
          $ref: '#/components/responses/Response404ESOrderRecon'
        '409':
          $ref: '#/components/responses/Response409ESOrderRecon'
  /recon:
    post:
      tags:
      - PG Reconciliation
      summary: PG Reconciliation
      operationId: PGFetchRecon
      description: |
        - Use this API to get the payment gateway reconciliation details with date range.
        - It will have events for your payment account
      requestBody:
        $ref: '#/components/requestBodies/FetchReconRequest'
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      responses:
        '200':
          description: Success response for fetching payment gateway reconciliation details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReconEntity'
          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}/disputes:
    get:
      tags:
      - Disputes
      summary: Get Disputes by Order ID
      operationId: PGFetchOrderDisputes
      description: Use this API to get all Dispute details by specifying the Order ID.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: order_id
        required: true
        schema:
          type: string
          description: Order or the invoice ID for which you want to view the disputes details.
      responses:
        '200':
          description: Success response for fetching disputes for an order.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DisputesEntity'
              example:
              - cf_dispute_id: 422427
                cf_dispute_remarks: ''
                created_at: '2025-09-04T19:58:31'
                customer_details:
                  customer_name: ''
                  customer_phone: ''
                  customer_email: ''
                dispute_amount: 6916
                dispute_amount_currency: ''
                dispute_evidence: []
                dispute_status: CHARGEBACK_CREATED
                dispute_type: CHARGEBACK
                order_details:
                  cf_payment_id: '0'
                  order_amount: 0
                  order_currency: ''
                  order_id: ''
                  payment_amount: 0
                  payment_currency: ''
                preferred_evidence:
                - document_type: Delivery/Service Proof
                  document_description: Proof that the cardholder/customer received the goods or services.
                - document_type: Statement of Service
                  document_description: Account Statement of wallet where funds were loaded by customer.
                - document_type: Cancellation of Service Proof
                  document_description: Document showing that you were able to provide merchandise to the customer and that
                    the customer has cancelled prior to the delivery date.
                - document_type: Refund Proof
                  document_description: Details of Refund provided to the customer if done via any other mode before the dispute
                    was initiated.
                reason_code: '13.1'
                reason_description: Merchandise / Services Not Received
                resolved_at: '9999-09-09T00:00:00'
                respond_by: '2025-09-08T00:00:00'
                updated_at: '2025-09-04T19:58:31'
          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'
  /payments/{cf_payment_id}/disputes:
    get:
      tags:
      - Disputes
      summary: Get Disputes by Payment ID
      operationId: PGFetchPaymentDisputes
      description: Use this API to get all Dispute details by specifying the Payment ID.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: cf_payment_id
        required: true
        schema:
          type: integer
          description: Cashfree payment ID to view the payment details of an order.
      responses:
        '200':
          description: Success response for fetching disputes for a payment.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DisputesEntity'
          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'
  /disputes/{dispute_id}:
    get:
      tags:
      - Disputes
      summary: Get Disputes by Dispute ID
      operationId: PGFetchDisputeByID
      description: Use this API to get Dispute details by specifying the Dispute ID.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: dispute_id
        required: true
        schema:
          type: integer
          description: Cashfree dispute ID to view the dispute details of an order.
      responses:
        '200':
          description: Success response for fetching a dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisputesEntity'
          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'
  /disputes/{dispute_id}/accept:
    put:
      tags:
      - Disputes
      summary: Accept Dispute by Dispute ID
      operationId: PGAcceptDisputeByID
      description: Use this API to get accept the Dispute by specifying the Dispute ID.
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: dispute_id
        required: true
        schema:
          type: integer
          description: Cashfree dispute ID to view the dispute details of an order.
      responses:
        '200':
          description: Success response for accepting a dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisputesEntityMerchantAccepted'
          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'
  /disputes/{dispute_id}/contest-arbitration:
    put:
      tags:
      - Disputes
      summary: Contest Arbitration by Dispute ID
      operationId: PGContestArbitrationByID
      description: "Use this API to contest an ARBITRATION dispute without uploading documents."
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: dispute_id
        required: true
        schema:
          type: integer
          description: Cashfree dispute ID of the ARBITRATION dispute to contest.
      requestBody:
        content:
          application/json:
            schema:
              description: Request body to contest arbitration for a dispute.
              type: object
              properties:
                note:
                  type: string
                  description: Optional note from the merchant about the contestation. Maximum 500 characters.
      responses:
        '200':
          description: Success response for contesting arbitration for a dispute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisputesEntity'
          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'
  /disputes/{dispute_id}/documents:
    post:
      tags:
      - Disputes
      summary: Submit Evidence to contest the Dispute by Dispute ID
      operationId: PGUploadDisputesDocuments
      description: "Use this API to submit evidence to contest a dispute by specifying the dispute ID. This API does not apply to ARBITRATION disputes. Use the [Contest Arbitration API](/docs/api-reference/payments/latest/disputes/contest-arbitration-by-dispute-id) instead."
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: dispute_id
        required: true
        schema:
          type: integer
          description: Cashfree dispute ID to get Evidences to submit to contest the Dispute.
      requestBody:
        content:
          multipart/form-data:
            schema:
              description: Request body to submit evidence to contest a dispute.
              type: object
              required:
              - file
              - doc_type
              properties:
                file:
                  type: string
                  description: File types supported are jpeg, jpg, png, pdf and maximum file size allowed is 20 MB.
                doc_type:
                  type: string
                  description: Mention the type of the document you are uploading. Possible values :- Delivery/Service Proof,
                    Shipping Proof, Statement of Service, Proof of Service Used, Cancellation of Service Proof, Refund Proof,
                    Business model explanation, Extra Charges Declaration, Terms & Conditions, Customer Withdrawal Letter,
                    Certificate of Authenticity, Reseller Agreement. You can use get evidences to contest dispute API to fetch
                    set of documents required to contest particular dispute.
                note:
                  type: string
      responses:
        '200':
          description: Success response for submitting evidence to contest a dispute.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DisputesEntity'
          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'
  /settlement/recon:
    post:
      tags:
      - Settlement Reconciliation
      summary: Settlement Reconciliation
      operationId: PGSettlementFetchRecon
      description: |
        - Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range.
        - This API will return events for the settlement IDs you want
      requestBody:
        $ref: '#/components/requestBodies/SettlementFetchReconRequest'
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      responses:
        '200':
          description: Success response for fetching settlement reconciliation details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementReconEntity'
          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'
  /settlements:
    post:
      tags:
      - Settlement Reconciliation
      summary: Get All Settlements
      operationId: PGFetchSettlements
      description: Use this API to get all settlement details by specifying the settlement ID, settlement UTR, settlement status or date range. Returns settlements of all statuses including SUCCESS, PENDING, PENDING_WITH_CASHFREE, PENDING_WITH_BANK and FAILED.
      requestBody:
        $ref: '#/components/requestBodies/FetchSettlementsRequest'
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      responses:
        '200':
          description: Success response for fetching settlements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllSettlementsResponse'
          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'
  /recon/vendor:
    post:
      summary: Vendor Reconciliation API
      description: |
        This API allows you to fetch vendor reconciliation details by using different filters. Use the appropriate filters based on your requirements. After you receive a VENDOR_SETTLEMENT_SUCCESS webhook confirmation, wait 15 minutes before you call this API endpoint.
         - **View Split Order Details Using Settlement ID**: Retrieve details of split orders within a settlement by Settlement ID.
         - **Vendor Recon for a Time Period**: Fetch reconciliation details for all vendors within a specific time interval.
         - **Vendor Recon Using Vendor ID & Time Interval**: Get reconciliation details for a specific vendor within a given time interval.
      tags:
      - Reconciliation
      operationId: PGESReconVendor
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
        description: application/json.
      requestBody:
        $ref: '#/components/requestBodies/VendorReconRequest'
      responses:
        '200':
          description: Success response for fetching vendor reconciliation details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorRecon200Response'
              examples:
                PG:
                  $ref: '#/components/examples/VendorReconPGResponseExample'
                Auto Collect:
                  $ref: '#/components/examples/VendorReconACResponseExample'
        '400':
          $ref: '#/components/responses/Response400VendorRecon'
  /terminal:
    post:
      summary: Create Terminal
      description: Use this API to create new terminals to use softPOS.
      tags:
      - softPOS
      operationId: SposCreateTerminal
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateTerminalRequest'
      responses:
        '200':
          description: Success response for creating a terminal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalEntity'
          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'
  /terminal/payments:
    post:
      summary: Get list of terminal transactions
      description: Use this API to fetch a paginated list of terminal payment transactions. You can filter results by date
        range, terminal details, payment status, and other criteria.
      operationId: SposFetchTerminalTransactions
      deprecated: false
      tags:
      - softPOS
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/GetAllTerminalTransactionRequest'
      responses:
        '200':
          description: Success response for fetching terminal transactions.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetAllTerminalPaymentEntity'
          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'
        '502':
          $ref: '#/components/responses/Response502'
  /terminal/qrcodes:
    get:
      summary: Fetch Terminal QR Codes
      description: You can fetch all the StaticQRs corresponding to given terminal id or phone number. Provide either the
        terminal_phone_no or terminal_id in the request.
      tags:
      - softPOS
      operationId: SposFetchTerminalQRCodes
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: query
        name: terminal_phone_no
        example: '9876543214'
        required: true
        description: Phone number assigned to the terminal. Required if you are not providing the cf_terminal_id in the request.
        schema:
          type: string
      - in: query
        name: cf_terminal_id
        example: 123344
        required: true
        description: Cashfree terminal id for which you want to get static QRs. Required if you are not providing the terminal_phone_number
          in the request.
        schema:
          type: integer
      responses:
        '200':
          description: Success response for fetching static QR codes for a terminal.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FetchTerminalQRCodesEntity'
          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'
  /terminal/transactions:
    post:
      summary: Create Terminal Transaction
      description: Use this API to create a new terminal transaction. To use this API you should first create an order using
        the Create Order API. Also, you need to enter the terminal details while creating the order and pass the same terminal
        information while creating a transaction using the below mentioned API.
      tags:
      - softPOS
      operationId: SposCreateTerminalTransaction
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateTerminalTransactionRequest'
      responses:
        '200':
          description: Success response for creating a terminal transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalTransactionEntity'
          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'
  /terminal/soundbox:
    post:
      summary: Onboard Soundbox Vpa
      description: Use this API to onboard a terminal Vpa to soundbox.
      tags:
      - softPOS
      operationId: SposOnboardSoundboxVpa
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardSoundboxVpaRequest'
      responses:
        '200':
          description: Success response for onboarding a soundbox VPA.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoundboxVpaEntity'
          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'
  /terminal/{cf_terminal_id}/soundbox:
    patch:
      summary: Update Soundbox Vpa
      description: Use this API to update a terminal Vpa to soundbox.
      tags:
      - softPOS
      operationId: SposUpdateSoundboxVpa
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: cf_terminal_id
        example: 123344
        required: true
        description: Provide the Cashfree terminal ID for which the details have to be updated.
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSoundboxVpaRequest'
      responses:
        '200':
          description: Success response for updating a soundbox VPA.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoundboxVpaEntity'
          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'
  /terminal/demap/soundbox:
    post:
      summary: Demap Soundbox Vpa
      description: Use this API to demap a device from soundbox.
      tags:
      - softPOS
      operationId: SposDemapSoundboxVpa
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DemapSoundboxVpaRequest'
      responses:
        '200':
          description: Success response for demapping a soundbox VPA.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SoundboxVpaEntity'
          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'
  /terminal/soundbox/qrcodes:
    get:
      summary: Fetch Terminal Soundbox vpa
      description: You can fetch all the active and mapped SoundboxVpa corresponding to given terminal id or deviceSerialNo.
        Provide either the device_serial_no or cf_terminal_id in the request.
      tags:
      - softPOS
      operationId: SposFetchTerminalSoundboxVpa
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: query
        name: device_serial_no
        example: '9876543214'
        required: true
        description: Device Serial No assinged. Required if you are not providing the cf_terminal_id in the request.
        schema:
          type: string
      - in: query
        name: cf_terminal_id
        example: 123344
        required: true
        description: Cashfree terminal id for which you want to get Soundbox Vpa. Required if you are not providing the device_serial_no
          in the request.
        schema:
          type: integer
      responses:
        '200':
          description: Success response for fetching soundbox VPAs for a terminal.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SoundboxVpaEntity'
          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'
        '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'
  /terminal/{cf_terminal_id}/payments:
    get:
      summary: Get Terminal Transaction
      description: Use this API to get  terminal transaction.
      tags:
      - softPOS
      operationId: SposFetchTerminalTransaction
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: query
        name: utr
        example: testUTR001
        required: true
        description: Utr of the transaction.
        schema:
          type: string
      - in: path
        name: cf_terminal_id
        example: 123344
        required: true
        description: Provide the Cashfree terminal ID for which the details have to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success response for fetching a terminal transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalPaymentEntity'
          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'
  /terminal/{cf_terminal_id}:
    patch:
      summary: Update Terminal
      description: Use this API to update the terminal details. Email, Phone Number, and Terminal Meta are updatable for "Storefront".
        Only account status change is possible in case of "Agent".
      requestBody:
        $ref: '#/components/requestBodies/UpdateTerminalRequest'
      tags:
      - softPOS
      operationId: SposUpdateTerminal
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: cf_terminal_id
        example: 123344
        required: true
        description: Provide the Cashfree terminal ID for which the details have to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success response for updating terminal details.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UpdateTerminalEntity'
          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'
  /terminal/{cf_terminal_id}/status:
    patch:
      summary: Update Terminal Status
      description: Use this API to update the terminal status.
      requestBody:
        $ref: '#/components/requestBodies/UpdateTerminalStatusRequest'
      tags:
      - softPOS
      operationId: SposUpdateTerminalStatus
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: cf_terminal_id
        example: 123344
        required: true
        description: Provide the Cashfree terminal ID for which the details have to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success response for updating terminal status.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UpdateTerminalEntity'
          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'
  /terminal/{terminal_phone_no}:
    get:
      summary: Get Terminal Status using Phone Number
      description: Use this API to view all details of a terminal.
      tags:
      - softPOS
      operationId: SposFetchTerminal
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: terminal_phone_no
        required: true
        description: The terminal for which you want to view the order details.
        example: '6309291183'
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching a terminal's status by phone number.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalEntity'
          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'
  /terminal/{cf_terminal_id}/docs:
    post:
      summary: Upload Terminal Docs
      description: Use this API to upload the terminal documents.
      requestBody:
        $ref: '#/components/requestBodies/UploadTerminalDocs'
      tags:
      - softPOS
      operationId: SposUploadTerminalDocs
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: cf_terminal_id
        example: 123344
        required: true
        description: Provide the Cashfree terminal ID for which the details have to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success response for uploading terminal documents.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UploadTerminalDocsEntity'
          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'
  /simulate:
    post:
      summary: Simulate Payment
      description: Use this API to simulate payment. To use this API you should first create an order using the Create Order
        API. Also, you need to create a payment with the same order.
      tags:
      - Simulation
      operationId: PGSimulatePayment
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/SimulateRequest'
      responses:
        '200':
          description: Success response for simulating a payment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationResponse'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /simulate/{simulation_id}:
    get:
      summary: Fetch Simulation
      description: Use this API to fetch simulated payment details.
      tags:
      - Simulation
      operationId: PGFetchSimulation
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: simulation_id
        example: sim_2900842gV18Lhh7owswLj5XF0uHHUn1CX
        required: true
        description: Provide the SimulationId for which the details have to be fetched.
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching a payment simulation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationResponse'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /simulate/settlement:
    post:
      summary: Simulate Settlement Payment
      description: Use this API to simulate a settlement in the sandbox environment. First, create a successful order, and
        then call this API with the order ID to simulate the settlement for that order.
      tags:
      - Simulation
      operationId: PGSimulateSettlement
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/SimulateSettlementRequest'
      responses:
        '200':
          description: Success response for simulating a settlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementSimulationResponse'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /simulate/settlement/{simulation_id}:
    get:
      summary: Fetch Settlement Simulation
      description: Use this API to fetch the details of a simulated settlement.
      tags:
      - Simulation
      operationId: PGFetchSettlementSimulation
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - in: path
        name: simulation_id
        example: sim_2900842gV18Lhh7owswLj5XF0uHHUn1CX
        required: true
        description: Provide the SimulationId for which the details have to be fetched.
        schema:
          type: string
      responses:
        '200':
          description: Success response for fetching a settlement simulation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementSimulationResponse'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /simulate/settlement/vendor:
    post:
      summary: Simulate Vendor Settlement
      description: Use this API to simulate an Easy Split vendor settlement in the sandbox environment. Create a successful
        order with a vendor split, then call this API to drive the vendor settlement to INITIATED, SUCCESS or FAILED and
        receive the corresponding VENDOR_SETTLEMENT_* webhook without waiting for a real settlement cycle.
      tags:
      - Simulation
      operationId: PGSimulateVendorSettlement
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      requestBody:
        $ref: '#/components/requestBodies/SimulateVendorSettlementRequest'
      responses:
        '200':
          description: Success response for simulating an Easy Split vendor settlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorSettlementSimulationResponse'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /simulate/easy-split/enable:
    post:
      summary: Enable Easy Split
      description: Use this API to enable Easy Split on your own merchant ID in the sandbox environment, without raising a
        request with Cashfree. Onboarding also creates sample vendors, which are provisioned asynchronously, so this API returns
        202 and you should poll Fetch Easy Split Status until the status is ACTIVE. This API is not idempotent. Each
        call provisions another pair of sample vendors, so call it only once for each merchant ID. This API is available only
        in the sandbox environment. Calling it on a production merchant ID returns a 400 error.
      tags:
      - Simulation
      operationId: PGEnableEasySplitSandbox
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      responses:
        '202':
          description: Success response for enabling Easy Split. Sandbox Easy Split onboarding has been accepted. The response body is empty.
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /simulate/easy-split/status:
    get:
      summary: Fetch Easy Split Status
      description: Use this API to retrieve the Easy Split configuration for your merchant ID in the sandbox environment.
        Poll this after calling Enable Easy Split until the status is ACTIVE.
      tags:
      - Simulation
      operationId: PGFetchEasySplitSandboxStatus
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      responses:
        '200':
          description: Success response for fetching the Easy Split status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EasySplitSandboxStatusResponse'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}:
    get:
      summary: Fetch Subscription
      description: Use this API to fetch subscription details.
      tags:
      - Subscription
      operationId: SubsFetchSubscription
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      responses:
        '200':
          description: Success response for fetching a subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionEntity'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions:
    post:
      summary: Create Subscription
      description: Use this API to create a new subscription.
      tags:
      - Subscription
      operationId: SubsCreateSubscription
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreateSubscriptionRequest'
      responses:
        '200':
          description: Success response for creating a subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionEntity'
          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'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}/manage:
    post:
      summary: Manage Subscription
      description: |-
        Use this API to manage subscriptions. You can cancel, pause, activate, or change the plan associated with a subscription.
        To update the recurring amount for a periodic subscription: 1. Create a new plan with the revised amount. 2. Use the Manage Subscription API to associate the subscription with the new plan. 3. Include the `CHANGE_PLAN` action and the new `plan_id` in the request body.
      tags:
      - Subscription
      operationId: SubsManageSubscription
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      requestBody:
        $ref: '#/components/requestBodies/ManageSubscriptionRequest'
      responses:
        '200':
          description: Success response for managing a subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionEntity'
          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'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /plans/{plan_id}:
    get:
      summary: Fetch Plan
      description: Use this API to fetch plan details.
      tags:
      - Subscription
      operationId: SubsFetchPlan
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/planIdParam'
      responses:
        '200':
          description: Success response for fetching a plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanEntity'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /plans:
    post:
      summary: Create a Plan
      description: |-
        A plan allows your customer to identify the features you offer along with your pricing. You can create plans as per the pricing you support for your services. For each plan, you can set a pre-decided frequency and amount with which they’ll be charged.
        Example: Netflix Plans : Premium, Basic, Standard, Mobile. Each plan differs and caters for a particular set of audiences.
      tags:
      - Subscription
      operationId: SubsCreatePlan
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/CreatePlanRequest'
      responses:
        '200':
          description: Success response for creating a plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanEntity'
          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'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}/payments:
    get:
      summary: Fetch Details of All Payments of a Subscription
      description: Use this API to fetch all payments of a subscription.
      tags:
      - Subscription
      operationId: SubsFetchSubscriptionPayments
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      responses:
        '200':
          description: Success response for fetching all payments for a subscription.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubscriptionPaymentEntity'
          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'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}/payments/{payment_id}:
    get:
      summary: Fetch Details of a Single Payment
      description: Use this API to fetch details of a single payment of a subscription.
      tags:
      - Subscription
      operationId: SubsFetchSubscriptionPayment
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      - $ref: '#/components/parameters/subscriptionPaymentIdParam'
      responses:
        '200':
          description: Success response for fetching a subscription payment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPaymentEntity'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}/payments/{payment_id}/manage:
    post:
      summary: Manage a Single Payment
      description: Use this API to manage a payment of a subscription. A payment can be cancelled or retried with this API.
      tags:
      - Subscription
      operationId: SubsManageSubscriptionPayment
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      - $ref: '#/components/parameters/subscriptionPaymentIdParam'
      requestBody:
        $ref: '#/components/requestBodies/ManageSubscriptionPaymentRequest'
      responses:
        '200':
          description: Success response for managing a subscription payment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPaymentEntity'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}/refunds/{refund_id}:
    get:
      summary: Fetch Details of a Refund
      description: Use this API to fetch details of a refund of a subscription payment.
      tags:
      - Subscription
      operationId: SubsFetchSubscriptionRefund
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      - $ref: '#/components/parameters/subscriptionRefundIdParam'
      responses:
        '200':
          description: Success response for fetching a subscription refund.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPaymentRefundEntity'
          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'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/{subscription_id}/refunds:
    post:
      summary: Create a Refund
      description: 'This API allows you to create refund on a successful payment. Refund amount can be partial or the full
        amount of the payment. '
      tags:
      - Subscription
      operationId: SubsCreateRefund
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionIdParam'
      requestBody:
        $ref: '#/components/requestBodies/CreateSubscriptionRefundRequest'
      responses:
        '200':
          description: Success response for creating a subscription refund.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPaymentRefundEntity'
          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'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/pay:
    post:
      summary: Raise a Charge or Create an Auth
      description: |-
        Use this API to create an auth or to raise a charge.
      tags:
      - Subscription
      operationId: SubsCreatePayment
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/xClientDeviceHeader'
      - $ref: '#/components/parameters/xClientOsHeader'
      - $ref: '#/components/parameters/xClientRenderingTypeHeader'
      - $ref: '#/components/parameters/xClientBrowserHeader'
      x-codeSamples:
      - lang: bash
        label: create_subscription_charge
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --data '{
            "subscription_id": "test-subscription-id",
            "payment_id": "test-payment-id",
            "payment_amount": 10,
            "payment_schedule_date": "2025-06-01T16:40:00",
            "payment_remarks": "2nd EMI payment",
            "payment_type": "CHARGE",
            "payment_method": {
              "upi": {
                "upi_id": "john@upi",
                "channel": "collect"
              }
            }
          }'
      - lang: bash
        label: create_subscription_auth_upi_link
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --data '{
            "subscription_id": "test-subscription-id",
            "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment",
            "payment_id": "test-payment-id",
            "payment_type": "AUTH",
            "payment_method": {
              "upi": {
                "channel": "link",
                "upi_id": "john.doe@okbank"
              }
            }
          }'
      - lang: bash
        label: create_subscription_auth_upi_collect
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --header 'x-client-device: mobile' \
            --header 'x-client-os: ios' \
            --header 'x-client-rendering-type: mweb' \
            --header 'x-client-browser: safari' \
            --data '{
            "subscription_id": "test-subscription-id",
            "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment",
            "payment_id": "test-payment-id",
            "payment_type": "AUTH",
            "payment_method": {
              "upi": {
                "channel": "collect",
                "upi_id": "john.doe@okbank"
              }
            }
          }'
      - lang: bash
        label: create_subscription_auth_upi_qrcode
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --data '{
            "subscription_id": "test-subscription-id",
            "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment",
            "payment_id": "test-payment-id",
            "payment_type": "AUTH",
            "payment_method": {
              "upi": {
                "channel": "qrcode"
              }
            }
          }'
      - lang: bash
        label: create_subscription_auth_card
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --data '{
            "subscription_id": "test-subscription-id",
            "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment",
            "payment_id": "test-payment-id",
            "payment_type": "AUTH",
            "payment_method": {
              "card": {
                "channel": "link",
                "card_number": "4111111111111111",
                "card_holder_name": "John Doe",
                "card_expiry_mm": "12",
                "card_expiry_yy": "25",
                "card_cvv": "123",
                "card_network": "VISA",
                "card_type": "CREDIT"
              }
            }
          }'
      - lang: bash
        label: create_subscription_auth_enach
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --data '{
            "subscription_id": "test-subscription-id",
            "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment",
            "payment_id": "test-payment-id",
            "payment_type": "AUTH",
            "payment_method": {
              "enach": {
                "channel": "link",
                "auth_mode": "net_banking",
                "account_holder_name": "John Doe",
                "account_number": "1518121112",
                "account_type": "SAVINGS",
                "account_bank_code": "ICIC"
              }
            }
          }'
      - lang: bash
        label: create_subscription_auth_pnach
        source: |-
          curl --request POST \
            --url https://sandbox.cashfree.com/pg/subscriptions/pay \
            --header 'Content-Type: application/json' \
            --header 'x-api-version: <x-api-version>' \
            --header 'x-client-id: <api-key>' \
            --header 'x-client-secret: <api-key>' \
            --data '{
            "subscription_id": "test-subscription-id",
            "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment",
            "payment_id": "test-payment-id",
            "payment_type": "AUTH",
            "payment_method": {
              "pnach": {
                "channel": "post",
                "account_holder_name": "John Doe",
                "account_number": "1518121112",
                "account_type": "SAVINGS",
                "account_bank_code": "ICIC",
                "account_ifsc": "ICIC0000123",
                "mandate_creation_date": "2025-06-01",
                "mandate_start_date": "2025-06-05"
              }
            }
          }'
      requestBody:
        $ref: '#/components/requestBodies/CreateSubscriptionPaymentRequest'
      responses:
        '200':
          description: Success response for raising a charge or creating an authorisation for a subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPaymentResponse'
              examples:
                Sandbox_UPI_QRCode:
                  value:
                    action: custom
                    cf_payment_id: '123456'
                    channel: qrcode
                    data:
                      url: https://dummy-url.com/upi/qrcode
                      payload:
                        paymentType: UPI
                        upiIntentData:
                          androidAuthAppLinks:
                            GPAY: https://dummy-url.com/upi/gpay
                            PHONEPE: https://dummy-url.com/upi/phonepe
                          iosAuthAppLinks:
                            GPAY: https://dummy-url.com/upi/gpay
                            PHONEPE: https://dummy-url.com/upi/phonepe
                      content_type: application/json
                      method: post
                    payment_amount: 1
                    payment_id: PAY-123456
                    payment_method: upi
                    payment_status: PENDING
                    payment_type: AUTH
                    subscription_id: SUBSCRIPTION-123
                Sandbox_UPI_Link:
                  value:
                    action: custom
                    cf_payment_id: '123457'
                    channel: link
                    data:
                      url: https://dummy-url.com/upi/link
                      payload:
                        paymentType: UPI
                        upiIntentData:
                          androidAuthAppLinks:
                            GPAY: https://dummy-url.com/upi/gpay
                            PHONEPE: https://dummy-url.com/upi/phonepe
                          iosAuthAppLinks:
                            GPAY: https://dummy-url.com/upi/gpay
                            PHONEPE: https://dummy-url.com/upi/phonepe
                      content_type: application/json
                      method: post
                    payment_amount: 1
                    payment_id: PAY-123457
                    payment_method: upi
                    payment_status: PENDING
                    payment_type: AUTH
                    subscription_id: SUBSCRIPTION-124
                Sandbox_UPI_Collect:
                  value:
                    action: custom
                    cf_payment_id: '123458'
                    channel: collect
                    data:
                      url: https://dummy-url.com/upi/collect
                      payload:
                        paymentType: UPI
                        upiIntentData:
                          androidAuthAppLinks:
                            GPAY: https://dummy-url.com/upi/gpay
                            PHONEPE: https://dummy-url.com/upi/phonepe
                          iosAuthAppLinks:
                            GPAY: https://dummy-url.com/upi/gpay
                            PHONEPE: https://dummy-url.com/upi/phonepe
                      content_type: application/json
                      method: post
                    payment_amount: 1
                    payment_id: PAY-123458
                    payment_method: upi
                    payment_status: PENDING
                    payment_type: AUTH
                    subscription_id: SUBSCRIPTION-125
                Sandbox_Card:
                  value:
                    action: custom
                    cf_payment_id: '123459'
                    channel: link
                    data:
                      url: https://dummy-url.com/card/checkout
                      payload:
                        amount: '1.00'
                        orderCurrency: INR
                        paymentMode: SBC_CREDIT_CARD
                        returnUrl: https://dummy-url.com/card/return
                        signature: dummy-signature
                        transactionId: TXN-123
                      content_type: application/json
                      method: post
                    payment_amount: 1
                    payment_id: PAY-123459
                    payment_method: card
                    payment_status: PENDING
                    payment_type: AUTH
                    subscription_id: SUBSCRIPTION-126
                Sandbox_ENach:
                  value:
                    action: custom
                    cf_payment_id: '123460'
                    channel: link
                    data:
                      url: https://dummy-url.com/enach/checkout
                      payload:
                        AuthMode: dummyAuthMode
                        BankID: dummyBankId
                        CheckSumVal: dummyCheckSum
                        MandateReqDoc: dummyMandateDocument
                        MerchantID: dummyMerchantId
                        signature: dummy-signature
                      content_type: application/json
                      method: post
                    payment_amount: 0
                    payment_id: PAY-123460
                    payment_method: enach
                    payment_status: PENDING
                    payment_type: AUTH
                    subscription_id: SUBSCRIPTION-127
                Sandbox_Pnach:
                  value:
                    action: post
                    cf_payment_id: '2463045'
                    channel: post
                    data:
                      url: https://dummy-url.com/pnach/checkout
                      payload: null
                      content_type: application/x-www-form-urlencoded
                      method: post
                    payment_amount: 0
                    payment_currency: INR
                    payment_id: test_pnach_payment_id_2
                    payment_method: pnach
                    payment_status: PENDING
                    payment_tags: null
                    payment_type: AUTH
                    subscription_id: Test_Pnach_4
          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'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/pay/controlled/notify-mandate:
    post:
      summary: Create Controlled Notification
      description: Use this API to initiate a controlled payment notification (PDN) for an on-demand subscription mandate.
      tags:
        - Subscription
      operationId: SubsCreateControlledNotification
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
      parameters:
        - $ref: "#/components/parameters/apiVersionHeader"
        - $ref: "#/components/parameters/xRequestIDHeader"
        - $ref: "#/components/parameters/xIdempotencyKeyHeader"
      requestBody:
        $ref: "#/components/requestBodies/CreateControlledNotificationRequest"
      responses:
        "200":
          description: Success response for creating a controlled payment notification.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateControlledNotificationResponse"
          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":
          description: Bad request error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                previous_notification_in_progress:
                  value:
                    code: Prev_PDN_In_Progress
                    type: invalid_request_error
                    message: Previous PDN is in progress
                notification_limit_reached:
                  value:
                    code: payment_notification_restriction_error
                    type: invalid_request_error
                    message: Max number of notifications for a payment reached
          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"
        "401":
          $ref: "#/components/responses/Response401"
        "404":
          $ref: "#/components/responses/Response404"
        "422":
          $ref: "#/components/responses/Response422"
        "429":
          $ref: "#/components/responses/Response429"
        "500":
          $ref: "#/components/responses/Response500"
  /subscriptions/payments/{payment_id}/controlled/notifications/{notification_id}:
    get:
      summary: Fetch Controlled Notification
      description: Use this API to fetch the details of a controlled payment notification for a subscription mandate.
      tags:
        - Subscription
      operationId: SubsFetchControlledNotification
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
      parameters:
        - $ref: "#/components/parameters/apiVersionHeader"
        - $ref: "#/components/parameters/xRequestIDHeader"
        - $ref: "#/components/parameters/xIdempotencyKeyHeader"
        - $ref: "#/components/parameters/subscriptionPaymentIdParam"
        - $ref: "#/components/parameters/controlledNotificationIdParam"
      responses:
        "200":
          description: Success response for fetching a controlled payment notification.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FetchControlledNotificationResponse"
          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"
        "400":
          $ref: "#/components/responses/Response400"
        "401":
          $ref: "#/components/responses/Response401"
        "404":
          $ref: "#/components/responses/Response404"
        "429":
          $ref: "#/components/responses/Response429"
        "500":
          $ref: "#/components/responses/Response500"
  /subscriptions/payments/{payment_id}/controlled/notifications:
    get:
      summary: Fetch All Controlled Notifications
      description: Use this API to fetch all controlled payment notifications for a subscription payment.
      tags:
        - Subscription
      operationId: SubsFetchControlledNotifications
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
      parameters:
        - $ref: "#/components/parameters/apiVersionHeader"
        - $ref: "#/components/parameters/xRequestIDHeader"
        - $ref: "#/components/parameters/xIdempotencyKeyHeader"
        - $ref: "#/components/parameters/subscriptionPaymentIdParam"
      responses:
        "200":
          description: Success response for fetching all controlled payment notifications.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FetchControlledNotificationsResponse"
          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"
        "400":
          $ref: "#/components/responses/Response400"
        "401":
          $ref: "#/components/responses/Response401"
        "404":
          $ref: "#/components/responses/Response404"
        "429":
          $ref: "#/components/responses/Response429"
        "500":
          $ref: "#/components/responses/Response500"
  /subscriptions/pay/controlled/execute-mandate:
    post:
      summary: Create Controlled Execution
      description: Use this API to create a controlled charge execution for an on-demand subscription mandate after a successful notification.
      tags:
        - Subscription
      operationId: SubsCreateControlledExecution
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
      parameters:
        - $ref: "#/components/parameters/apiVersionHeader"
        - $ref: "#/components/parameters/xRequestIDHeader"
        - $ref: "#/components/parameters/xIdempotencyKeyHeader"
      requestBody:
        $ref: "#/components/requestBodies/CreateControlledExecutionRequest"
      responses:
        "200":
          description: Success response for creating a controlled payment execution.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateControlledExecutionResponse"
          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":
          description: Bad request error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                previous_execution_in_progress:
                  value:
                    code: Prev_Execution_In_Progress
                    type: invalid_request_error
                    message: Previous Execution is in progress
                execution_limit_reached:
                  value:
                    code: payment_execution_restriction_error
                    type: invalid_request_error
                    message: Max number of executions for a payment reached
                notification_missing:
                  value:
                    code: payment_execution_restriction_error
                    type: invalid_request_error
                    message: No successful notification for payment_id
          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"
        "401":
          $ref: "#/components/responses/Response401"
        "404":
          $ref: "#/components/responses/Response404"
        "422":
          $ref: "#/components/responses/Response422"
        "429":
          $ref: "#/components/responses/Response429"
        "500":
          $ref: "#/components/responses/Response500"
  /subscriptions/payments/{payment_id}/controlled/executions/{execution_id}:
    get:
      summary: Fetch Controlled Execution
      description: Use this API to fetch the details of a controlled execution for a subscription mandate.
      tags:
        - Subscription
      operationId: SubsFetchControlledExecution
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
      parameters:
        - $ref: "#/components/parameters/apiVersionHeader"
        - $ref: "#/components/parameters/xRequestIDHeader"
        - $ref: "#/components/parameters/xIdempotencyKeyHeader"
        - $ref: "#/components/parameters/subscriptionPaymentIdParam"
        - $ref: "#/components/parameters/controlledExecutionIdParam"
      responses:
        "200":
          description: Success response for fetching a controlled payment execution.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FetchControlledExecutionResponse"
          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"
        "400":
          $ref: "#/components/responses/Response400"
        "401":
          $ref: "#/components/responses/Response401"
        "404":
          $ref: "#/components/responses/Response404"
        "429":
          $ref: "#/components/responses/Response429"
        "500":
          $ref: "#/components/responses/Response500"
  /subscriptions/payments/{payment_id}/controlled/executions:
    get:
      summary: Fetch All Controlled Executions
      description: Use this API to fetch all controlled payment executions for a subscription payment.
      tags:
        - Subscription
      operationId: SubsFetchControlledExecutions
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
      parameters:
        - $ref: "#/components/parameters/apiVersionHeader"
        - $ref: "#/components/parameters/xRequestIDHeader"
        - $ref: "#/components/parameters/xIdempotencyKeyHeader"
        - $ref: "#/components/parameters/subscriptionPaymentIdParam"
      responses:
        "200":
          description: Success response for fetching all controlled payment executions.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FetchControlledExecutionsResponse"
          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"
        "400":
          $ref: "#/components/responses/Response400"
        "401":
          $ref: "#/components/responses/Response401"
        "404":
          $ref: "#/components/responses/Response404"
        "429":
          $ref: "#/components/responses/Response429"
        "500":
          $ref: "#/components/responses/Response500"
  /subscriptions/pay/documents/{payment_id}:
    post:
      summary: Upload file for Physical Nach Authorisation
      description: Use this API to upload file for Physical Nach Authorization.
      tags:
      - Subscription
      operationId: SubscriptionDocumentUpload
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionPaymentIdParam'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadPnachImageRequest'
            examples:
              Physical Nach Image:
                value:
                  action: UPLOAD
                  file: '@''/Users/john/Downloads/pan.jpeg'''
                  payment_id: payment-1234
      responses:
        '200':
          $ref: '#/components/responses/UploadPnachImage200Response'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/eligibility/payment_methods:
    post:
      summary: Get All the Payment Method Details Available for Subscription Payments
      description: Use this API to check if a payment method is enabled for your account.
      tags:
      - Subscription
      operationId: SubscriptionEligibility
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/SubscriptionEligibilityRequest'
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionEligibility200Response'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /subscriptions/charge/{payment_id}/transaction-return-summary/generate:
    post:
      summary: Generate Transaction Return Summary
      description: Use this API to generate transaction return summary for failed transactions (insufficient balance).
      tags:
      - Subscription
      operationId: SubsFetchSubscription
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/subscriptionPaymentIdParam'
      responses:
        '200':
          description: Success response for generating a transaction return summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionReturnSummary200Response'
          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'
        '400':
          $ref: '#/components/responses/TransactionSummary400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
  /utilities/cardbin:
    post:
      summary: Get Card BIN Details
      description: Use this API to get [Card BIN](https://www.cashfree.com/docs/payments/features/utility-apis) (Bank Identification
        Number) details.
      tags:
      - Utilities
      operationId: PGGetCardBin
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/GetCardBinRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetCardBinResponse'
        '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'
  /utilities/pars:
    post:
      summary: Get PAR
      description: Use this API to get [Payment Account Reference (PAR)](https://www.cashfree.com/docs/payments/features/payment-account-reference)
        by providing plain card details.
      tags:
      - Utilities
      operationId: PGCreatePAR
      deprecated: false
      security:
      - XClientID: []
        XClientSecret: []
      - XClientID: []
        XPartnerAPIKey: []
      - XClientID: []
        XClientSignatureHeader: []
      - XPartnerMerchantID: []
        XPartnerAPIKey: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/PARRequest'
      responses:
        '200':
          description: Success response for fetching the PAR for a card.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PGCreatePAR200Response'
          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'
        '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'
  /incident:
    get:
      summary: Fetch All Downtimes
      description: Fetches active downtimes across various payment methods based on filters. Gives all active downtimes when
        no filters are applied.
      operationId: FetchActiveEcosystemDowntimes
      tags:
      - Downtime
      security:
      - XClientID: []
        XClientSecret: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      - $ref: '#/components/parameters/incidentIdQueryParam'
      - $ref: '#/components/parameters/incidentStatusQueryParam'
      - $ref: '#/components/parameters/incidentImpactQueryParam'
      - $ref: '#/components/parameters/incidentTypeQueryParam'
      - $ref: '#/components/parameters/incidentStartTimeQueryParam'
      - $ref: '#/components/parameters/incidentEndTimeQueryParam'
      - $ref: '#/components/parameters/incidentPaymentMethodQueryParam'
      responses:
        '200':
          description: Success response for fetching all downtimes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchActiveEcosystemDowntimes200Response'
              examples:
                incidents_entity_list_example:
                  $ref: '#/components/examples/incident_entity_list_example'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/x-api-version'
        '401':
          $ref: '#/components/responses/Response401'
        '500':
          $ref: '#/components/responses/Response500'
  /incident/{id}:
    get:
      summary: Fetch Downtime by ID
      description: Fetches details of a specific downtime using its unique ID.
      operationId: FetchDowntimeById
      tags:
      - Intellisense
      security:
      - XClientID: []
        XClientSecret: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the downtime.
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      responses:
        '200':
          description: Success response for fetching a downtime by ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentByIdResponse'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/x-api-version'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '500':
          $ref: '#/components/responses/Response500'
  /orders/sessions/authorize:
    post:
      summary: Order Pay Authorise Only
      description: Use this API when an order has already been created and you want Cashfree to process the payment for authorisation
        only. To use this API, the 'AUTHORIZE_ONLY' flag must be enabled for your account. Submit [Support Form](https://merchant.cashfree.com/auth/login)
        to enable this feature.
      operationId: PGPayOrderAuthorizeOnly
      deprecated: false
      tags:
      - Payments
      security: []
      parameters:
      - $ref: '#/components/parameters/apiVersionHeader'
      - $ref: '#/components/parameters/xRequestIDHeader'
      - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/PayOrderAuthorizeOnlyRequest'
      responses:
        '200':
          description: Success response for creating an authorisation-only transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentEntity'
              examples:
                payment_entity_example:
                  summary: Payment Entity Example
                  value:
                    auth_id: '302651'
                    authorization: null
                    bank_reference: '524410198110'
                    cf_payment_id: '4304193706'
                    entity: payment
                    error_details: null
                    international_payment:
                      international: false
                    is_captured: false
                    order_amount: 1.0
                    order_currency: INR
                    order_id: 3vv0ethp9r
                    payment_amount: 1.0
                    payment_completion_time: '2025-09-01T15:42:38+05:30'
                    payment_currency: INR
                    payment_gateway_details:
                      gateway_name: CASHFREE
                      gateway_order_id: null
                      gateway_payment_id: null
                      gateway_order_reference_id: null
                      gateway_status_code: null
                      gateway_settlement: cashfree
                      gateway_reference_name: null
                    payment_group: debit_card
                    payment_message: Transaction Success
                    payment_method:
                      card:
                        card_bank_name: KOTAK MAHINDRA BANK
                        card_country: IN
                        card_network: visa
                        card_network_reference_id: null
                        card_number: XXXXXXXXXXXX4738
                        card_sub_type: R
                        card_type: debit_card
                        channel: link
                        instrument_id: 0dca46b1-01f7-4a60-9e4a-ae5474603563
                        par: V0010014623022257739533641432
                    payment_offers: []
                    payment_status: SUCCESS
                    payment_surcharge:
                      payment_surcharge_service_charge: 0.0
                      payment_surcharge_service_tax: 0.0
                    payment_time: '2025-09-01T15:40:58+05:30'
          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'
        '502':
          $ref: '#/components/responses/Response502'
x-readme:
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true
  samples-languages:
  - shell
