---
updatedAt: 2025-11-11T00:09:33.000Z
agentTools:
  projectIndex: https://docs.interswitchgroup.com/v1.1/llms.txt
---

# Get Refund

This endpoint allows you to retrieve the refund details for a specific merchant code and date range.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "invoice",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://qa.interswitchng.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/paymentgateway/api/v1/refunds": {
      "get": {
        "summary": "Get Refund",
        "description": "This endpoint allows you to retrieve the refund details for a specific merchant code and date range.",
        "operationId": "get-refund",
        "parameters": [
          {
            "name": "merchantCode",
            "in": "query",
            "description": "The merchant code that can be obtained from your Quickteller Business Dashboard. Example: MX187",
            "required": true,
            "schema": {
              "type": "string",
              "default": "MX187"
            }
          },
          {
            "name": "pageNum",
            "in": "query",
            "description": "The page number for pagination. Example: 1",
            "schema": {
              "type": "string",
              "default": "1"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "The number of records per page. Example: 100",
            "schema": {
              "type": "string",
              "default": "100"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "description": "The start date of the refund period in MM/DD/YYYY format.",
            "schema": {
              "type": "string",
              "default": "11/01/2018"
            }
          },
          {
            "name": "endDate",
            "in": "query",
            "description": "The end date of the refund period in MM/DD/YYYY format.",
            "schema": {
              "type": "string",
              "default": "12/03/2018"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiaXN3LWNvbGxlY3Rpb25zIiwiaXN3LXBheW1lbnRnYXRld2F5IiwicGFzc3BvcnQiLCJwcm9qZWN0LXgtbWVyY2hhbnQiLCJ2YXVsdCJdLCJtZXJjaGFudF9jb2RlIjoiTVg2MDcyIiwicmVxdWVzdG9yX2lkIjoiMTIzODA4NTk1MDMiLCJzY29wZSI6WyJwcm9maWxlIl0sImp0aSI6IjVkOTczM2Y5LWMzNDEtNGFjZC04ZjE3LWViYzUyYWE0NjM2MiIsInBheWFibGVfaWQiOiIzMzU5NyIsImNsaWVudF9pZCI6IklLSUFCMjNBNEUyNzU2NjA1QzFBQkMzM0NFM0MyODdFMjcyNjdGNjYwRDYxIn0.ElgBX2KoF9LuUUpeBGzzp8CDAllTHWfgM6pJRgTtPYGJpoZufKlJrmE4QTvZV6MIVaNtK21majTgR4qXJr7CEkPK_4zCIHyN2b8a445vqhLYcbffQvK4EeUn_RzsWTmub2bruG5s4bRS1il5itPR0QQ-trEsbELU7TAHvC4p786RiAQd-K_I0bwtLzIXQN65jlw3eJxxK-BGfca-OMTUo9HGvraebfLB-7h4-vNbPred58gfLBSwK31jaLP19cMRc5Jea28jrlmGNUhHGzjnP7ZanqgC9uuvoepQsa39_DNBonR6xirxKw4aNlNLcKOTn026wyOTHIHUGlDQ3s3AOQ"
            }
          },
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"count\":  8,\n  \"content\":  [\n    {\n      \"id\":  12,\n      \"refundReference\":  \"kjsd3138shdsauhdsgdie9322saud0q\",\n      \"parentPaymentId\":  3077027,\n      \"parentTransactionReference\":  \"172ea8e8-7070\",\n      \"refundType\":  \"PARTIAL\",\n      \"refundAmount\":  1000,\n      \"createdDate\":  1484147875893,\n      \"merchantCustomerId\":  \"RefundCustomer\",\n      \"refundStatus\":  \"FAILED\",\n      \"processedDate\":  1487766904267,\n      \"createdBy\":  \"mecode@sharklasers.com\",\n      \"reasonForRefund\":  \"Nada\"\n    },\n\n    {\n      \"id\":  11,\n      \"refundReference\":  \"kjsd313sjdsyegdie9322saud0q\",\n      \"parentPaymentId\":  3077027,\n      \"parentTransactionReference\":  \"172ea8e8-7070\",\n      \"refundType\":  \"PARTIAL\",\n      \"refundAmount\":  1000,\n      \"createdDate\":  1484145519777,\n      \"merchantCustomerId\":  \"RefundCustomer\",\n      \"refundStatus\":  \"FAILED\",\n      \"processedDate\":  1487766904267,\n      \"createdBy\":  \"mecode@sharklasers.com\",\n      \"reasonForRefund\":  \"Nada\"\n    },\n\n    {\n      \"id\":  10,\n      \"refundReference\":  \"kjsd313sdfafugidewK0e9322saud0q\",\n      \"parentPaymentId\":  3077027,\n      \"parentTransactionReference\":  \"172ea8e8-7070\",\n      \"refundType\":  \"PARTIAL\",\n      \"refundAmount\":  1000,\n      \"createdDate\":  1484121082547,\n      \"merchantCustomerId\":  \"RefundCustomer\",\n      \"refundStatus\":  \"FAILED\",\n      \"processedDate\":  1487766903863,\n      \"createdBy\":  \"mecode@sharklasers.com\",\n      \"reasonForRefund\":  \"Nada\"\n    },\n    {\n      \"id\":  9,\n      \"refundReference\":  \"kjsd31324KJDSK0e9322saud0q\",\n      \"parentPaymentId\":  3077027,\n      \"parentTransactionReference\":  \"172ea8e8-7070\",\n      \"refundType\":  \"PARTIAL\",\n      \"refundAmount\":  1000,\n      \"createdDate\":  1484006400000,\n      \"merchantCustomerId\":  \"RefundCustomer\",\n      \"refundStatus\":  \"FAILED\",\n      \"processedDate\":  1487766903863,\n      \"createdBy\":  \"mecode@sharklasers.com\",\n      \"reasonForRefund\":  \"Nada\"\n    },\n    {\n      \"id\":  7,\n      \"refundReference\":  \"kjsd313243u0e9322saud0q\",\n      \"parentPaymentId\":  3077027,\n      \"parentTransactionReference\":  \"172ea8e8-7070\",\n      \"refundType\":  \"PARTIAL\",\n      \"refundAmount\":  1000,\n      \"createdDate\":  1484006400000,\n      \"merchantCustomerId\":  \"RefundCustomer\",\n      \"refundStatus\":  \"FAILED\",\n      \"processedDate\":  1487766903860,\n      \"refundTransactionReference\":  \"ksadjlnmdsakw3892\",\n      \"refundTransactionResponseCode\":  \"Z1\",\n      \"createdBy\":  \"mecode@sharklasers.com\",\n      \"reasonForRefund\":  \"Nada\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "integer",
                      "example": 8,
                      "default": 0
                    },
                    "content": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 12,
                            "default": 0
                          },
                          "refundReference": {
                            "type": "string",
                            "example": "kjsd3138shdsauhdsgdie9322saud0q"
                          },
                          "parentPaymentId": {
                            "type": "integer",
                            "example": 3077027,
                            "default": 0
                          },
                          "parentTransactionReference": {
                            "type": "string",
                            "example": "172ea8e8-7070"
                          },
                          "refundType": {
                            "type": "string",
                            "example": "PARTIAL"
                          },
                          "refundAmount": {
                            "type": "integer",
                            "example": 1000,
                            "default": 0
                          },
                          "createdDate": {
                            "type": "integer",
                            "example": 1484147875893,
                            "default": 0
                          },
                          "merchantCustomerId": {
                            "type": "string",
                            "example": "RefundCustomer"
                          },
                          "refundStatus": {
                            "type": "string",
                            "example": "FAILED"
                          },
                          "processedDate": {
                            "type": "integer",
                            "example": 1487766904267,
                            "default": 0
                          },
                          "createdBy": {
                            "type": "string",
                            "example": "mecode@sharklasers.com"
                          },
                          "reasonForRefund": {
                            "type": "string",
                            "example": "Nada"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```