> ## Documentation Index
> Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PG Reconciliation

> - Use this API to get the payment gateway reconciliation details with date range.
- It will have events for your payment account




## OpenAPI

````yaml /openapi/payments/v2025-01-01.yaml post /recon
openapi: 3.0.0
info:
  version: '2025-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.
servers:
  - url: https://sandbox.cashfree.com/pg
    description: Sandbox server.
  - url: https://api.cashfree.com/pg
    description: Production server.
security: []
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.
externalDocs:
  url: https://api.cashfree.com/pg
  description: This url will have the information of all the APIs.
paths:
  /recon:
    post:
      tags:
        - PG Reconciliation
      summary: PG Reconciliation
      description: >
        - Use this API to get the payment gateway reconciliation details with
        date range.

        - It will have events for your payment account
      operationId: PGFetchRecon
      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.
      requestBody:
        $ref: '#/components/requestBodies/FetchReconRequest'
      responses:
        '200':
          description: >-
            Success response for getting the payment gateway reconciliation
            details with date range.
          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'
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
components:
  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: '2025-01-01'
      example: '2025-01-01'
      x-ignore: true
    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
    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
  requestBodies:
    FetchReconRequest:
      description: >-
        Request parameters to get the payment gateway reconciliation details
        with date range.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FetchReconRequest'
  schemas:
    ReconEntity:
      title: ReconEntity
      description: Settlement detailed recon response.
      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
              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
              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
              event_currency: INR
              event_id: EVT987654321
              event_remarks: Payment captured successfully
              event_service_charge: 40
              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
              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
              forex_conversion_handling_tax: 0
              payment_amount: 4000
              payment_currency: INR
              payment_group: CREDIT_CARD_EMI
              payment_service_charge: 40
              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
              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
              split_service_tax: 0
              utr: HDFC20250912UTR12345
              vendor_commission: 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
              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
              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 Payments 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.
    FetchReconRequest:
      type: object
      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. 
             To receive the data for the first time, pass the cursor as null. 
             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
    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
    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.
    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.
    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.
    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.
    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.
  headers:
    x-api-version:
      schema:
        type: string
        format: YYYY-MM-DD
        enum:
          - '2025-01-01'
      description: >-
        This header has the version of the API. The current version is
        `2025-01-01`.
    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.
    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.
  responses:
    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'
  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).
    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.
    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.
    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.

````