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

# List refunds

> Every refund on this payment.



## OpenAPI

````yaml /api-reference/openapi.json get /payment/intents/{paymentIntentId}/refunds
openapi: 3.1.0
info:
  title: Orqex Orchestrate API
  version: 1.0.0
  description: >-
    The Orqex Orchestrate API for collecting payments and sending payouts.


    Authenticate with a secret key as a bearer token; the key also selects the
    environment. Amounts are in major units everywhere: `50` means 50.00. Writes
    accept an `X-Idempotency-Key` header. Lists are cursor-paginated.


    Which countries, currencies and payment methods are available depends on
    your project configuration: read them from the discovery endpoints at
    payment time, or look them up in your dashboard.
  contact:
    name: Orqex Orchestrate
    url: https://orqex.com
servers:
  - url: https://api.orqex.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Checkout
    description: Hosted checkout sessions.
  - name: Payment intents
    description: Payments, discovery and reconciliation.
  - name: Payment attempts
    description: Collecting a payment and confirming it.
  - name: Refunds
    description: Returning money to a payer.
  - name: Payouts
    description: Sending money out.
  - name: Utilities
    description: Exchange rates and method status.
paths:
  /payment/intents/{paymentIntentId}/refunds:
    get:
      tags:
        - Refunds
      summary: List refunds
      description: Every refund on this payment.
      operationId: listRefunds
      parameters:
        - name: paymentIntentId
          in: path
          required: true
          description: The payment intent id.
          schema:
            type: string
        - name: per_page
          in: query
          required: false
          description: Number of records per page.
          schema:
            type: integer
          example: 25
        - name: cursor
          in: query
          required: false
          description: Opaque cursor taken from `pagination.next_cursor`.
          schema:
            type: string
      responses:
        '200':
          description: A page of refunds.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Refund'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          description: Missing, invalid, inactive or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The request address is not on the API key's allowlist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (100 requests per minute per key).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Refund:
      type: object
      properties:
        id:
          type: string
          example: ref_8Lm3Vp
        amount:
          $ref: '#/components/schemas/Amount'
        type:
          type:
            - string
            - 'null'
          enum:
            - full
            - partial
            - null
        execution_method:
          type: string
          enum:
            - gateway
            - payout
          description: How the money is being returned.
        status:
          type:
            - string
            - 'null'
          enum:
            - pending
            - processing
            - completed
            - failed
            - null
        reason:
          type:
            - object
            - 'null'
          properties:
            value:
              type: string
            label:
              type: string
        note:
          type:
            - string
            - 'null'
        failure_code:
          type:
            - string
            - 'null'
        failure_message:
          type:
            - string
            - 'null'
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
        payout:
          type:
            - object
            - 'null'
          description: Present when the refund is executed as a payout.
          properties:
            id:
              type: string
            gateway_code:
              type:
                - string
                - 'null'
            method:
              type:
                - string
                - 'null'
            recipient:
              $ref: '#/components/schemas/PayoutInstrument'
            gateway_transaction_id:
              type:
                - string
                - 'null'
            fee_amount:
              type:
                - integer
                - 'null'
            status:
              type: string
            initiated_at:
              type:
                - string
                - 'null'
              format: date-time
            completed_at:
              type:
                - string
                - 'null'
              format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        failed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
    Pagination:
      type: object
      properties:
        count:
          type: integer
          example: 25
        path:
          type: string
        per_page:
          type: integer
          example: 25
        next_cursor:
          type:
            - string
            - 'null'
        next_page_url:
          type:
            - string
            - 'null'
        prev_cursor:
          type:
            - string
            - 'null'
        prev_page_url:
          type:
            - string
            - 'null'
        has_more_pages:
          type: boolean
        has_pages:
          type: boolean
    Error:
      type: object
      properties:
        message:
          type: string
    Amount:
      type: object
      properties:
        value:
          type:
            - number
            - 'null'
          example: 50
        formatted:
          type:
            - string
            - 'null'
          example: $50.00
        short:
          type:
            - string
            - 'null'
          example: $50
        currency:
          type:
            - string
            - 'null'
          example: USD
    PayoutInstrument:
      type:
        - object
        - 'null'
      description: The destination as stored. Keys depend on `type`.
      properties:
        id:
          type: string
          example: pin_5Yt2Wc
        type:
          type: string
          enum:
            - phone
            - bank_account
            - crypto_address
        phone_number:
          type:
            - string
            - 'null'
        account_name:
          type:
            - string
            - 'null'
        account_number:
          type:
            - string
            - 'null'
        bank_code:
          type:
            - string
            - 'null'
        swift_bic:
          type:
            - string
            - 'null'
        country:
          oneOf:
            - $ref: '#/components/schemas/Country'
            - type: 'null'
          description: Returned as an object, although it is sent as a plain code.
        address:
          type:
            - string
            - 'null'
        network:
          type:
            - string
            - 'null'
        memo_tag:
          type:
            - string
            - 'null'
    Country:
      type: object
      properties:
        code:
          type: string
          example: US
        name:
          type: string
          example: United States
        flag:
          type:
            - string
            - 'null'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your secret key, e.g. `sk_live_...` or `sk_sandbox_...`.

````