> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/prism/api-reference/refund-service/get.md).

# Get

## Overview

The `Get` RPC retrieves the current status of a refund from the payment processor. Use this to check refund progress, provide customer updates, and synchronize refund states with your internal systems.

**Business Use Case:** When a customer asks about their refund status or when your system needs to verify the current state of a refund for reconciliation purposes. Refunds can take time to process (minutes to days depending on the processor), so checking status helps you provide accurate information to customers.

## Purpose

**Why use Get for refunds?**

| Scenario              | Developer Implementation                                                             |
| --------------------- | ------------------------------------------------------------------------------------ |
| **Customer inquiry**  | Customer asks "Where is my refund?" - call `Get` to retrieve current status          |
| **Reconciliation**    | Daily financial sync - call `Get` for all pending refunds to update internal records |
| **Status polling**    | After initiating refund, periodically call `Get` until status is SUCCEEDED or FAILED |
| **Support dashboard** | Build support tools showing real-time refund status from processors                  |
| **Audit trail**       | Verify refund completed before closing support tickets                               |

**Key outcomes:**

* Current refund status (PENDING, SUCCEEDED, FAILED)
* Refund amount and currency confirmation
* Timestamps for refund lifecycle tracking
* Error details if refund failed

## Request Fields

| Field                      | Type               | Required | Description                                              |
| -------------------------- | ------------------ | -------- | -------------------------------------------------------- |
| `merchant_refund_id`       | string             | Yes      | Your unique identifier for this refund                   |
| `connector_transaction_id` | string             | Yes      | The connector's transaction ID from the original payment |
| `refund_id`                | string             | Yes      | The connector's refund ID (e.g., Stripe re\_xxx)         |
| `refund_reason`            | string             | No       | Reason for the refund (for context)                      |
| `browser_info`             | BrowserInformation | No       | Browser information if relevant                          |
| `refund_metadata`          | SecretString       | No       | Metadata specific to the refund sync                     |
| `state`                    | ConnectorState     | No       | State data for access token storage                      |
| `test_mode`                | bool               | No       | Process as test transaction                              |
| `payment_method_type`      | PaymentMethodType  | No       | Payment method type for context                          |
| `connector_feature_data`   | SecretString       | No       | Connector-specific metadata                              |

## Response Fields

| Field                 | Type                 | Description                                     |
| --------------------- | -------------------- | ----------------------------------------------- |
| `merchant_refund_id`  | string               | Your refund reference (echoed back)             |
| `connector_refund_id` | string               | Connector's ID for the refund                   |
| `status`              | RefundStatus         | Current status: PENDING, SUCCEEDED, FAILED      |
| `error`               | ErrorInfo            | Error details if refund failed                  |
| `status_code`         | uint32               | HTTP status code from the connector             |
| `response_headers`    | map\<string, string> | Optional HTTP response headers                  |
| `refund_amount`       | Money                | Amount being refunded                           |
| `payment_amount`      | int64                | Original payment amount                         |
| `refund_reason`       | string               | Reason for the refund                           |
| `created_at`          | int64                | Unix timestamp when the refund was created      |
| `updated_at`          | int64                | Unix timestamp when the refund was last updated |
| `processed_at`        | int64                | Unix timestamp when the refund was processed    |

## Example

### Request (grpcurl)

```bash
grpcurl -H "x-connector: stripe" \
  -H "x-connector-config: {\"config\":{\"Stripe\":{\"api_key\":\"$STRIPE_API_KEY\"}}}" \
  -d '{
    "merchant_refund_id": "refund_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "refund_id": "re_3Oxxx...",
    "test_mode": true
  }' \
  localhost:8080 \
  types.RefundService/Get
```

### Response

```json
{
  "merchant_refund_id": "refund_001",
  "connector_refund_id": "re_3Oxxx...",
  "status": "SUCCEEDED",
  "status_code": 200,
  "refund_amount": {
    "minor_amount": 1000,
    "currency": "USD"
  },
  "payment_amount": 1000,
  "refund_reason": "Customer returned item",
  "created_at": 1709577600,
  "updated_at": 1709577600,
  "processed_at": 1709577600
}
```

## Status Values

| Status      | Description                                        | Typical Duration               |
| ----------- | -------------------------------------------------- | ------------------------------ |
| `PENDING`   | Refund is being processed by the payment processor | Minutes to 5-10 business days  |
| `SUCCEEDED` | Refund has completed successfully                  | Funds returned to customer     |
| `FAILED`    | Refund could not be processed                      | Check error details for reason |

## Next Steps

* [Refund](/integrations/prism/api-reference/refund.md) - Initiate a new refund via Payment Service
* [Get Payment](/integrations/prism/api-reference/get.md) - Check the original payment status
* [Event Service](/integrations/prism/api-reference/event-service.md) - Handle refund webhook notifications


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hyperswitch.io/integrations/prism/api-reference/refund-service/get.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.