---
title: "GetRefundStatus"
method: POST
path: "/v2/GetRefundStatus"
tags: ["Refund"]
---

# GetRefundStatus

`POST /v2/GetRefundStatus`

## Request

- Base URL: `https://apitest.myfatoorah.com`
- URL: `https://apitest.myfatoorah.com/v2/GetRefundStatus`
- Auth: HTTP bearer

Gets the status of a refund to check if it is refunded, rejected, or still pending.

## Request body

- object
  - `KeyType` 'InvoiceId' | 'RefundReference' | 'RefundId', required: Supported keys are 'InvoiceId', 'RefundReference', and 'RefundId'. Specifies the type of identifier to use for checking the refund status.
  - `Key` string, required: Value of the key type mentioned. Provide the corresponding identifier value based on the KeyType selected.

## Response `200`

Refund status retrieved successfully

- object
  - `IsSuccess` boolean: Indicates if the request was successful.
  - `Message` string: Response message associated with the request.
  - `ValidationErrors` object[]: List of validation errors, if any.
    - `Name` string: Name of the field with validation error.
    - `Error` string: Description of the validation error.
  - `Data` object, nullable
    - `RefundStatusResult` object[]: An array of refund status result data.
      - `RefundId` number: The unique identifier for the refund transaction.
      - `RefundStatus` 'Refunded' | 'Canceled' | 'Pending': The status of the refund. It takes one of the following values: 'Refunded', 'Canceled', or 'Pending'.
      - `InvoiceId` number: Represents the invoice ID that was used in the inquiry call.
      - `Amount` number: The amount to be refunded.
      - `RefundReference` string: The refund reference generated by MyFatoorah.
      - `RefundAmount` number: The actual amount refunded to the customer.
      - `ExternalIdentifier` string: The ExternalIdentifier that you passed in the MakeRefund request.
      - `RRN` string: Refund Reference Number that the customer can check with their bank.
      - `BaseCurrency` string: Your account base currency

---

[API](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2.md) - [All operations](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/revisions/4c0c2a3af558?raw)