--- updatedAt: 2026-08-31T21:28:34.000Z agentTools: projectIndex: https://docs.myfatoorah.com/llms.txt --- # Get Refund Details Retrieves the details of a previously created refund using the refundId. ### Refund Status Updates We recommend relying on the [Refund Status Changed webhook](https://docs.myfatoorah.com/docs/webhook-v2-refund-data-model) event to receive refund status updates instead of repeatedly calling the Get Refund Details endpoint. The Get Refund Details endpoint should only be used as a fallback when needed. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Myfatoorah Api V3" }, "servers": [ { "url": "https://apitest.myfatoorah.com" } ], "paths": { "/v3/refunds/{refundId}": { "get": { "responses": { "200": { "description": "Refund Retrieved Successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "IsSuccess": { "type": "boolean", "description": "Indicates whether the refund details were retrieved successfully." }, "Message": { "type": "string", "description": "Response message associated with the request." }, "ValidationErrors": { "type": "array", "items": { "properties": { "Name": { "type": "string", "description": "Name of the field with validation error." }, "Error": { "type": "string", "description": "Description of the validation error." } }, "type": "object" } }, "Data": { "type": "object", "properties": { "Refund": { "type": "object", "description": "Contains the refund details.", "properties": { "Id": { "type": "string", "description": "Unique identifier of the refund" }, "Reference": { "type": "string", "description": "The refund reference generated by MyFatoorah for following up with the finance team." }, "Status": { "type": "string", "description": "Current status of the refund. It takes one of the following values: 'Refunded', 'Canceled', or 'Pending'.", "enum": [ "Refunded", "Canceled", "Pending" ] }, "InvoiceId": { "type": "string", "description": "The InvoiceId of the refunded amount." }, "ExternalIdentifier": { "type": "string", "description": "External identifier provided when creating the refund." }, "CreationDate": { "type": "string", "description": "Date and time when the refund was created." }, "RefundDate": { "type": "string", "description": "Date and time when the refund was completed. It may be empty while the refund is pending." }, "RRN": { "type": "string", "description": "Refund Reference Number that the customer can check with their bank." }, "Comment": { "type": "string" }, "VendorComment": { "type": "string", "description": "Comment provided in the refund request." } } }, "Amount": { "type": "object", "properties": { "BaseCurrency": { "type": "string", "description": "Base currency of the account" }, "ValueInBaseCurrency": { "type": "string", "description": "Total refund amount in the base currency." }, "Distribution": { "type": "object", "properties": { "Vendor": { "type": "number", "description": "Amount deducted from the vendor for the refund." }, "Suppliers": { "type": "array", "description": "Amount deducted from the suppliers for the refund.", "items": { "properties": { "Code": { "type": "string", "description": "Supplier code." }, "Amount": { "type": "number", "description": "Amount refunded by the supplier." } }, "type": "object" } } } } }, "description": "Contains the refund amount and its distribution." }, "ReferencedInvoice": { "type": "object", "description": "Contains details of the original invoice.", "properties": { "Id": { "type": "string", "description": "Id of the original invoice." }, "Reference": { "type": "string", "description": "Reference number of the original invoice." }, "ExternalIdentifier": { "type": "string", "description": "External identifier of the original invoice." }, "PaymentMethod": { "type": "string", "description": "Payment method used for the original payment." }, "BaseCurrency": { "type": "string", "description": "The base currency of your account (e.g., KWD)." }, "ValueInBaseCurrency": { "type": "string", "description": "The total value of the original invoice in base currency." }, "RemainingValueInBaseCurrency": { "type": "string", "description": "The remaining amount in base currency after the refund." } } } } } } }, "examples": { "": { "summary": "", "value": { "IsSuccess": true, "Message": "Refund Retrieved Successfully", "ValidationErrors": null, "Data": { "Refund": { "Id": "309963", "Reference": "2026002050", "Status": "Refunded", "InvoiceId": "7099437", "ExternalIdentifier": "test-external", "CreationDate": "2026-08-24T01:12:12.1570000", "RefundDate": "2026-08-24T01:12:13.9730000", "RRN": "623522005104", "Comment": "", "VendorComment": "Comment" }, "Amount": { "BaseCurrency": "KWD", "ValueInBaseCurrency": 60, "Distribution": { "Vendor": 2, "Suppliers": [ { "Code": 2, "Amount": 58 } ] } }, "ReferencedInvoice": { "Id": "7099436", "Reference": "2026007764", "ExternalIdentifier": "customer-ref", "PaymentMethod": "GooglePay", "BaseCurrency": "KWD", "ValueInBaseCurrency": "100.000", "RemainingValueInBaseCurrency": "25.000" } } } } } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Bad Request": { "summary": "Bad Request", "value": { "IsSuccess": false, "Message": "", "ValidationErrors": [ { "Name": "refundId", "Error": "No refund exist matching this RefundId!" } ], "Data": null } } } } }, "description": "Bad Request" } }, "parameters": [ { "in": "path", "name": "refundId", "schema": { "type": "string" }, "required": true } ], "summary": "Get Refund Details", "operationId": "get_v3-refunds-refundid" } } }, "components": { "securitySchemes": { "bearerToken": { "type": "http", "scheme": "bearer", "x-default": "SK_KWT_vVZlnnAqu8jRByOWaRPNId4ShzEDNt256dvnjebuyzo52dXjAfRx2ixW5umjWSUx" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "security": [ { "bearerToken": [] } ] } ```