---
title: "Get refund"
method: GET
path: "/v1/refunds/{refund_id}"
tags: ["Refunds"]
---

# Get refund

`GET /v1/refunds/{refund_id}`

Get refund details by the refund ID.

## Path parameters

- `refund_id` string, required

## Parameters

- `#/paths/~1v1~1payins/get/parameters/0` — unresolved $ref

## Response `200`

OK

- object
  - `status` Status — unresolved $ref
  - `data` object — The refund details.
    - `refund_id` string — The unique refund identifier. Prefix is "rfd" in production and "sbx_rfd" in sandbox.
    - `payin_id` string — The unique payin identifier that was voided or refunded. Prefix is "pyi" in production and "sbx_pyi" in sandbox.
    - `merchant_id` MerchantId — unresolved $ref
    - `billing_type` BillingType — unresolved $ref
    - `amount` integer — The amount refunded, in minor units. For example, 1000 is 10.00 USD.
    - `currency_code` CurrencyCode — unresolved $ref
    - `merchant_fees` object — The refund fee billed to the merchant.
      - `total_amount` object — The total amount of fees billed to the merchant.
        - `amount` Amount — unresolved $ref
        - `currency_code` CurrencyCode — unresolved $ref
    - `reason` string — The reason a refund was issued.
    - `status` 'CREATED' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'CANCELED' | 'IN_REVIEW' — The status of the refund.
    - `refusal_code` RefusalCode — unresolved $ref
    - `refusal_desc` RefusalDesc — unresolved $ref
    - `detailed_refusal_code` DetailedRefusalCode — unresolved $ref
    - `detailed_refusal_desc` DetailedRefusalDesc — unresolved $ref
    - `non_voidable_reason_code` 'VOIDED' | 'PAST_SETTLEMENT', nullable — Why the refund is nonvoidable.
    - `auth_code` string — The authorization code if the refund was approved.
    - `metadata` Schema — unresolved $ref
    - `amount_splits` object[] — Represents how the refund amount was allocated between the originating merchant, the platform, and one or more other merchants.<br/><br/> A `PLATFORM` split defines the amount debited from the platform.<br/><br/> A `MERCHANT` split defines the amount debited from the specified merchant.<br/><br/> Any remaining amount not specified by the amount splits was debited from the originating merchant.
      - `amount` integer, required — The amount allocated, in minor units. For example, 1000 is 10.00 USD.
      - `currency_code` CurrencyCode, required — unresolved $ref
      - `type` 'PLATFORM' | 'MERCHANT', required — The type of receiver for this split.<br/><br/> `PLATFORM` allocates the split amount to the platform. `MERCHANT` allocates the split amount to the merchant specified by merchant_id.
      - `merchant_id` string — Required when type is `MERCHANT`.<br/><br/> The unique identifier of the merchant debited from.<br/><br/> Not valid when type is `PLATFORM`.
    - `payin_billing_fees_reversal_config` object — Controls whether the billing fees from the original payin are returned to the originating merchant. This configuration overrides the `billing_fees_reversal_config` defined on the payin config or the merchant's default configuration.
      - `on_full_refund` boolean — Determines whether the billing fees for the original payin are returned to the originating merchant when a refund for the full amount is processed.<br/><br/> When `true`, the billing fee is credited back to the merchant and included in the refund's computed billing fee.
    - `expected_deposit_date` ExpectedDepositDate — unresolved $ref
    - `ach_return` Data — unresolved $ref
    - `has_ach_return` HasAchReturn — unresolved $ref
    - `source` 'API_DIRECT' | 'COMPONENT' | 'EXTERNAL' — The source of the refund. Indicates the integration that created the refund.
    - `source_desc` string — The description of the source of the refund. This will be a human-readable value that may be presented to the end user.
    - `created_at` string, date-time — Date and time void or refund was created at in UTC RFC 3339 format.
    - `updated_at` string, date-time — Date and time refund was last updated at in UTC RFC 3339 format.
  - `errors` Errors — unresolved $ref

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — unresolved $ref
- `404` — unresolved $ref
- `5XX` — unresolved $ref

---

[API](https://skmtc.dev/rainforestpay/apis/authentication.md) · [All operations](https://skmtc.dev/rainforestpay/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rainforestpay/authentication/revisions/529a0dab0f90/schema)