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

# List refunds

> Refunds, chargebacks and alerts in the window (by `requestedAt`). Available to creator and affiliate keys.



## OpenAPI

````yaml /openapi.json get /api/v1/refunds
openapi: 3.1.0
info:
  title: PagAmerican Data API
  version: 1.0.0
  description: >-
    Sales analytics API for external consumers (creators and affiliates), served
    from ClickHouse in near real time.


    **Authentication:** send your API key (`pag_...`) directly in the
    `Authorization: Bearer <your_key>` header. There is no token exchange — the
    opaque key is the Bearer token itself.


    **Dates:** `from`/`to` are `YYYY-MM-DD` at 00:00:00 UTC; `from` is
    inclusive, `to` is exclusive. Max window 90 days. `/purchases` and `/orders`
    filter by **checkout initialization** (`checkoutInitializedAt`);
    `/checkouts` by load time; `/abandoned-carts` by session start; `/refunds`
    by request time.


    **Tenant scope:** you only receive your own account's data — isolation is
    enforced automatically by the key.
servers:
  - url: https://external-api-service.pagamerican.app
    description: Production
  - url: https://external-api-service.pagamerican.net
    description: Staging
security:
  - apiKey: []
tags:
  - name: purchases
    description: Purchases (creator and affiliate)
  - name: orders
    description: Orders (creator only)
  - name: products
    description: Product catalog (creator only)
  - name: offers
    description: Offer catalog (creator only)
  - name: checkouts
    description: Checkout sessions (creator only)
  - name: abandoned-carts
    description: Abandoned carts (creator only)
  - name: refunds
    description: Refunds, chargebacks and alerts (creator and affiliate)
  - name: health
    description: Service status
paths:
  /api/v1/refunds:
    get:
      tags:
        - refunds
      summary: List refunds
      description: >-
        Refunds, chargebacks and alerts in the window (by `requestedAt`).
        Available to creator and affiliate keys.
      parameters:
        - name: from
          in: query
          required: true
          description: Inclusive start date (00:00 UTC), YYYY-MM-DD.
          schema:
            type: string
            format: date
            example: '2026-08-01'
        - name: to
          in: query
          required: true
          description: >-
            Exclusive end date (00:00 UTC), YYYY-MM-DD. Pass the day after your
            intended last day. Max window 90 days.
          schema:
            type: string
            format: date
            example: '2026-08-08'
        - name: type
          in: query
          required: false
          description: Filter by refund type.
          schema:
            type: string
            enum:
              - totally_refunded
              - partially_refunded
              - chargeback
              - alert_chargeback
        - name: limit
          in: query
          required: false
          description: Maximum number of records (1 to 5000).
          schema:
            type: integer
            minimum: 1
            maximum: 5000
            default: 1000
      responses:
        '200':
          description: List of refunds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRefundResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/WindowTooLarge'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - apiKey: []
components:
  schemas:
    ListRefundResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Refund'
        meta:
          $ref: '#/components/schemas/DateMeta'
    Refund:
      type: object
      properties:
        refundRequestId:
          type: string
        orderId:
          type: integer
        checkoutId:
          type: string
        creatorId:
          type: string
        affiliateId:
          type: string
        cardBrand:
          type: string
        refundSource:
          type: string
        refundType:
          type: string
          description: >-
            totally_refunded | partially_refunded | chargeback |
            alert_chargeback
          example: chargeback
        refundReason:
          type: string
        isFraud:
          type: boolean
        amountRequested:
          type: number
        amountRefundedTotal:
          type: number
        transactionsCount:
          type: integer
        completedCount:
          type: integer
        failedCount:
          type: integer
        cancelReason:
          type: string
        requestedAt:
          type: string
          description: Column used for the from/to filter
        lastTransactionAt:
          type: string
        canceledAt:
          type: string
    DateMeta:
      type: object
      properties:
        count:
          type: integer
          example: 10
        limit:
          type: integer
          example: 1000
        from:
          type: string
          example: '2026-08-24'
        to:
          type: string
          example: '2026-08-25'
        truncated:
          type: boolean
          description: true = hit the limit, there may be more
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: from must be before to
            correlation_id:
              type: string
              example: a1b2c3d4-...
  responses:
    BadRequest:
      description: Invalid parameters (malformed dates, from > to)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, invalid, or revoked key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient scope or persona not allowed for this resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    WindowTooLarge:
      description: Date window larger than 90 days
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Rate limit exceeded (see Retry-After header)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Your opaque API key (`pag_...`) sent directly as the Bearer token. There
        is no token/JWT exchange.

````