---
title: "Get a refund by ID"
method: GET
path: "/v1/payment_pages/{pageId}/refund/{refundId}"
tags: ["Payment Pages"]
---

# Get a refund by ID

`GET /v1/payment_pages/{pageId}/refund/{refundId}`

## Path parameters

- `pageId` string, required
- `refundId` string, required

## Response `200`

Success

- object — The refund details
  - `status` 'SUCCEEDED', required
  - `data` GetRefundResponse, required
    - `id` string
    - `createdAt` number
    - `updatedAt` number
    - `pageId` string, required
    - `checkoutPaymentId` string, required
    - `data` object, required
      - `id` string, required
      - `action_id` string, required
      - `reference` string, required
      - `amount` number, required
      - `processed_on` string, required
      - `response_code` string, required
      - `response_summary` string, required
      - `balances` object, required
        - `total_authorized` number, required
        - `total_voided` number, required
        - `available_to_void` number, required
        - `total_captured` number, required
        - `available_to_capture` number, required
        - `total_refunded` number, required
        - `available_to_refund` number, required
      - `metadata` object, required
      - `currency` string, required
    - `pageAmount` number, required — Original payment amount, in presentment currency, minor units (e.g. 1050 for $10.50).
    - `refundAmount` number, required — Amount being refunded, in presentment currency, minor units (e.g. 1050 for $10.50).
    - `settlementAdjustmentAmount` number, required — Settlement amount to claw back from the merchant, in settlement currency, major units (e.g. 9.70 for $9.70).
    - `settlementCurrency` 'USD' | 'EUR' — Settlement currency code.
    - `exchangeRate` string — Exchange rate used for settlement: x settlement currency per 1 presentment currency, markup applied.
    - `marketExchangeRate` string — Market exchange rate before markup.
    - `fxMarkupBps` number — FX markup in basis points, 100 = 1%.
    - `currency` 'USD' | 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'JPY' | 'NOK' | 'NZD' | 'PLN' | 'SEK' | 'SGD' | 'TWD' | 'KRW' | 'SOL' | 'USDC' | 'USDT' | 'HONEY' | 'EURC', required — Presentment currency of the original payment.
    - `operator` string
    - `reason` string
    - `status` 'new' | 'processing' | 'succeeded' | 'failed', required
    - `merchantId` string
    - `livemode` boolean, required
    - `chargeblastEthocaAlertId` string — Chargeblast Ethoca alert ID, present when this refund was initiated in response to an Ethoca alert.

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) · [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) · [OpenAPI document](https://skmtc.dev/breeze/apis/breeze-api/revisions/8911892bdf29?raw)