---
title: "List Refunds"
method: GET
path: "/refunds"
tags: ["Refunds"]
---

# List Refunds

`GET /refunds`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/refunds`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

List refunds with optional filtering.

## Query parameters

- `offset` integer
- `page` integer
- `limit` integer
- `customer.id` string
- `customer.externalId` string
- `updatedAt` RangeQueryUpdateSpecs: Only return entities that were updated during the given date range. (ISO 8601 format)
  - `updatedAt.gt` string, date-time: Minimum value to filter by (exclusive)
  - `updatedAt.gte` string, date-time: Minimum value to filter by (inclusive)
  - `updatedAt.lt` string, date-time: Maximum value to filter by (exclusive)
  - `updatedAt.lte` string, date-time: Maximum value to filter by (inclusive)
- `sortBy` 'updatedAt' | 'validatedAt'
- `sortOrder` 'DESC' | 'ASC'

## Response `200`

Paginated list of refunds.

- object
  - `offset` integer: 0-based index of the first item returned. Returned when using offset-based pagination or by default.
  - `page` integer: Page number (1-based). Returned when using page-based pagination.
  - `limit` integer, required: Maximum number of items returned.
  - `total` integer, required: Total items in the set.
  - `items` Refund[], required
    - `refNumber` string, required: Refund reference number.
    - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
    - `amount` integer, required: Refund amount (in cents).
    - `instrument` 'WIRE_TRANSFER' | 'DIRECT_DEBIT' | 'CARD' | 'CASH' | 'CHECK' | 'UNKNOWN': Instrument used for the payment.
    - `validatedAt` string, date-time, required: The date when the refund is validated (ISO 8601 format).
    - `externalId` string: Refund external identifier.
    - `id` string, uuid, required: The Refund ID.
    - `amountLinked` integer, required: Amount linked to the refund (in cents).
    - `modifiedAt` string, date-time, required: The date when the refund was last updated (ISO 8601 format).
    - `linkedTransactions` PaymentAllocation[]: (Deprecated - likely replaced by linkedPayments) List of linked payments with the allocated amount.
      - `linkedAmount` integer, required: Refund's share linked to the payment (in cents).
      - `payment` PaymentCommonAttribs, required: Common attributes for payments.
        - `refNumber` string, required: Payment reference number.
        - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
        - `amount` integer, required: Payment amount (in cents).
        - `instrument` 'WIRE_TRANSFER' | 'DIRECT_DEBIT' | 'CARD' | 'CASH' | 'CHECK' | 'UNKNOWN': Instrument used for the payment.
        - `validatedAt` string, date-time, required: The date when the payment is validated (ISO 8601 format).
        - `externalId` string: Payment external identifier.
        - `customFields` CustomFieldValueAttribs[]: List of payment's custom fields values.
          - `id` string, uuid, nullable: The Custom Field ID.
          - `externalId` string, nullable: Custom field external identifier.
          - `value` union: The value of the custom field. Can be a primitive (string, integer, boolean), a single object for SELECT types, an array of objects for MULTI_SELECT types.
            - integer: Integer value.
            - string: String value (could also be date-time or date).
            - boolean: Boolean value.
            - CustomFieldValueOption
              - …
            - CustomFieldValueOption[]: Value for MULTI_SELECT type.
              - …
    - `linkedPayments` PaymentAllocation[]: List of payments linked to this refund.
      - `linkedAmount` integer, required: Refund's share linked to the payment (in cents).
      - `payment` PaymentCommonAttribs, required: Common attributes for payments.
        - `refNumber` string, required: Payment reference number.
        - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
        - `amount` integer, required: Payment amount (in cents).
        - `instrument` 'WIRE_TRANSFER' | 'DIRECT_DEBIT' | 'CARD' | 'CASH' | 'CHECK' | 'UNKNOWN': Instrument used for the payment.
        - `validatedAt` string, date-time, required: The date when the payment is validated (ISO 8601 format).
        - `externalId` string: Payment external identifier.
        - `customFields` CustomFieldValueAttribs[]: List of payment's custom fields values.
          - `id` string, uuid, nullable: The Custom Field ID.
          - `externalId` string, nullable: Custom field external identifier.
          - `value` union: The value of the custom field. Can be a primitive (string, integer, boolean), a single object for SELECT types, an array of objects for MULTI_SELECT types.
            - integer: Integer value.
            - string: String value (could also be date-time or date).
            - boolean: Boolean value.
            - CustomFieldValueOption
              - …
            - CustomFieldValueOption[]: Value for MULTI_SELECT type.
              - …
    - `linkedCreditNotes` CreditNoteAllocation[]: List of credit notes linked to this refund.
      - `linkedAmount` integer, required: Refund's share linked to the credit note (in cents).
      - `creditNote` CreditNoteCommonAttribs, required: Common attributes for credit notes.
        - `customId` string, required: Credit note custom identifier (e.g., document number).
        - `externalId` string: Credit note external identifier.
        - `issuedAt` string, date-time: The date at which the credit note was issued (ISO 8601 format).
        - `dueDate` string, date-time: The date when the credit note is due (ISO 8601 format). Often same as issuedAt.
        - `name` string: The credit note name or description.
        - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
        - `grossAmount` integer, required: Amount including taxes (in cents).
        - `netAmount` integer, required: Amount net of taxes (in cents).
        - `updatedAt` string, date-time: The date at which the credit note was last updated (ISO 8601 format).
    - `customer` CustomerLite: Minimal customer information.
      - `id` string, uuid, required: The Customer ID.
      - `externalId` string: An external ID that uniquely references the customer.
      - `companyName` string, required: Customer name.
      - `accountingRef` string: (Deprecated) Customer accounting reference (used in accounting tool). Use a custom field instead.
    - `createdAt` string, date-time: The date at which the refund was created (ISO 8601 format).
    - `updatedAt` string, date-time: The date at which the refund was last updated (ISO 8601 format).

---

[API](https://skmtc.dev/upflow/apis/upflow-api.md) - [All operations](https://skmtc.dev/upflow/apis/upflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upflow/apis/upflow-api/revisions/898a98ca0587?raw)