---
updatedAt: 2026-05-06T08:16:04.000Z
---

# Get a refund request.

This endpoint is used to get a refund request.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Wpay Cards Connect",
    "description": "This swagger documents the APIs to integrate into Cards Connect. These APIs implement standard payment message types to allow payment providers to post financial transactions.",
    "contact": {
      "name": "Wpay",
      "url": "https://www.wpay.io"
    },
    "version": "v1"
  },
  "paths": {
    "/api/v1/transactions/{transactionId}/refunds/{refundId}": {
      "get": {
        "tags": [
          "Refund"
        ],
        "summary": "Get a refund request.",
        "description": "This endpoint is used to get a refund request.",
        "operationId": "GetRefundAsync",
        "parameters": [
          {
            "name": "transactionId",
            "in": "path",
            "description": "Id of the transaction that has the refund you are interested in.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "refundId",
            "in": "path",
            "description": "Id of the refund you want to fetch the details of.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The get refund request was processed.",
            "content": {
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CnpRefundResponse"
                },
                "example": {
                  "refund": {
                    "id": "98ba3c67-53de-49c6-9284-dadfe133974c",
                    "amount": 1499,
                    "outcome": "Accepted",
                    "responseCode": "00",
                    "responseDescription": "Approved or completed",
                    "createdAt": "2026-01-12T03:59:36Z",
                    "schemeExtendedResponseData": null
                  },
                  "transactionId": "de8a424d-2e09-42d0-b6e2-7ffa6dc1a099",
                  "reconciliationId": "b5e9ecff-5f82-4930-a99c-4cf99e0514e2",
                  "permittedActionHints": [
                    "Refund"
                  ],
                  "browserViewLink": "https://portal-link/todo"
                }
              }
            }
          },
          "401": {
            "description": "The user is not authorized to make this request.",
            "content": {
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CnpRefundResponse": {
        "required": [
          "browserViewLink",
          "permittedActionHints",
          "reconciliationId",
          "refund",
          "transactionId"
        ],
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "description": "The unique identifier of the transaction passed during the authorization request"
          },
          "reconciliationId": {
            "type": "string",
            "description": "Reconciliation id passed during the authorization request"
          },
          "permittedActionHints": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PermittedTransactionOperationHint"
            },
            "description": "Provides hints of permitted actions based on the state of the transaction"
          },
          "browserViewLink": {
            "type": "string",
            "description": "A direct link for viewing the transaction in the Cards Connect Portal for end-users.",
            "nullable": true
          },
          "refund": {
            "$ref": "#/components/schemas/RefundResponse"
          }
        },
        "additionalProperties": false
      },
      "PermittedTransactionOperationHint": {
        "enum": [
          "Capture",
          "Void",
          "Refund"
        ],
        "type": "string",
        "description": "Hints for transaction operation permitted for the given transaction state "
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      },
      "RefundResponse": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the refund operation, as passed during the refund request."
          },
          "amount": {
            "type": "integer",
            "description": "Amount of the refund operation in cents as it was provided in the request.",
            "format": "int32"
          },
          "outcome": {
            "$ref": "#/components/schemas/TransactionOutcome"
          },
          "responseCode": {
            "type": "string",
            "description": "Response code for the refund as per AS2805 specifications.",
            "nullable": true
          },
          "responseDescription": {
            "type": "string",
            "description": "Response description for the refund as per AS2805 specifications.",
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "description": "Date and time when this refund was created in our system.",
            "format": "date-time"
          },
          "schemeExtendedResponseData": {
            "$ref": "#/components/schemas/SchemeExtendedResponseData"
          }
        },
        "additionalProperties": false
      },
      "SchemeExtendedResponseData": {
        "type": "object",
        "properties": {
          "mastercardTransactionLinkId": {
            "type": "string",
            "description": "Mastercard Transaction Link Identifier (TLID) used by Mastercard to link different events in the lifecycle of a transaction.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "TransactionOutcome": {
        "enum": [
          "Accepted",
          "InProgress",
          "InProgressDelayed",
          "Succeeded",
          "Declined",
          "BusyFailing",
          "BusyFailingDelayed",
          "Failed",
          "Ruined"
        ],
        "type": "string"
      }
    }
  },
  "tags": [
    {
      "name": "Refund",
      "description": "Refunds are submitted on approved capture transactions. Refunds credit a cardholder’s account."
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```