---
updatedAt: 2026-04-20T20:21:21.000Z
agentTools:
  projectIndex: https://docs.paymentlabs.io/llms.txt
---

# Get Refund

Returns information on a single refund, for payment.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payin API Specification",
    "version": "0.0.1",
    "description": "Describes the operations a Merchant can do to manage payins"
  },
  "paths": {
    "/refunds/{refundId}": {
      "get": {
        "operationId": "Get Refund",
        "tags": [
          "Refund"
        ],
        "description": "Returns information on a single refund, for payment.",
        "summary": "Get Refund",
        "parameters": [
          {
            "name": "refundId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "refundId"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefundDto"
                }
              }
            }
          },
          "401": {
            "description": "<p>Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.</p>",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "enum": [
                        "Unauthorized"
                      ],
                      "title": "message"
                    }
                  },
                  "required": [
                    "message"
                  ]
                }
              }
            }
          },
          "403": {
            "description": "<p>\n  Forbidden response, when the user is authenticated but does not have the necessary permissions.\n</p>",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "title": "code"
                    },
                    "message": {
                      "type": "string",
                      "title": "message"
                    }
                  },
                  "required": [
                    "code",
                    "message"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerToken": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api-sandbox.paymentlabs.io",
      "description": "Sandbox Server"
    },
    {
      "url": "https://api.paymentlabs.io",
      "description": "Production Server"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerToken": {
        "scheme": "bearer",
        "type": "http",
        "bearerFormat": "JWT",
        "description": "Bearer Token using JWT"
      }
    },
    "schemas": {
      "Money": {
        "description": "Represents an amount of a given currency",
        "title": "Money",
        "type": "object",
        "properties": {
          "value": {
            "description": "The amount in float point value",
            "type": "number",
            "title": "value"
          },
          "currency": {
            "description": "The currency in ISO format",
            "type": "string",
            "title": "currency"
          },
          "formattedValue": {
            "description": "The formatted value with currency",
            "type": "string",
            "title": "formattedValue"
          },
          "digits": {
            "description": "Decimal digits for the currency",
            "type": "number",
            "title": "digits"
          },
          "wholeValue": {
            "description": "<p> The value, without any float points <br/>\n<small> Usually how many cents, depending if the currency has cent </small>\n</p>",
            "type": "number",
            "title": "wholeValue"
          }
        },
        "required": [
          "currency",
          "digits",
          "formattedValue",
          "value",
          "wholeValue"
        ]
      },
      "AuditInfo": {
        "description": "Information about changes",
        "title": "AuditInfo",
        "type": "object",
        "properties": {
          "createdBy": {
            "description": "User who created this record",
            "type": "string",
            "title": "createdBy"
          },
          "updatedBy": {
            "description": "User who updated this record",
            "type": "string",
            "title": "updatedBy"
          },
          "updatedAt": {
            "description": "Last update date",
            "format": "date-time",
            "type": "string",
            "title": "updatedAt"
          },
          "createdAt": {
            "description": "Date of creation",
            "format": "date-time",
            "type": "string",
            "title": "createdAt"
          }
        }
      },
      "RefundDto": {
        "description": "RefundDto represents the details of a refund transaction.",
        "title": "RefundDto",
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier for the refund",
            "type": "string",
            "title": "id"
          },
          "reason": {
            "description": "The reason for the refund",
            "type": "string",
            "title": "reason"
          },
          "amount": {
            "$ref": "#/components/schemas/Money",
            "description": "The amount to refund in the currency of the transaction",
            "title": "amount"
          },
          "status": {
            "$ref": "#/components/schemas/RefundStatus",
            "title": "status"
          },
          "type": {
            "$ref": "#/components/schemas/RefundType",
            "title": "type"
          },
          "originalTransactionId": {
            "description": "The original transaction ID",
            "type": "string",
            "title": "originalTransactionId"
          },
          "merchantId": {
            "description": "The merchant ID",
            "type": "string",
            "title": "merchantId"
          },
          "checkoutId": {
            "description": "The checkout ID",
            "type": "string",
            "title": "checkoutId"
          },
          "checkoutAlias": {
            "description": "The checkout alias",
            "type": "string",
            "title": "checkoutAlias"
          },
          "subscriptionId": {
            "description": "The subscription ID",
            "type": "string",
            "title": "subscriptionId"
          },
          "subscriptionPaymentId": {
            "description": "The subscription payment ID",
            "type": "string",
            "title": "subscriptionPaymentId"
          },
          "subscriptionPaymentTransactionId": {
            "description": "The subscription payment transaction ID",
            "type": "string",
            "title": "subscriptionPaymentTransactionId"
          },
          "subscriptionPlanName": {
            "description": "The subscription plan name",
            "type": "string",
            "title": "subscriptionPlanName"
          },
          "buyerId": {
            "description": "The buyer ID",
            "type": "string",
            "title": "buyerId"
          },
          "buyerEmail": {
            "description": "The buyer email",
            "type": "string",
            "title": "buyerEmail"
          },
          "auditInfo": {
            "$ref": "#/components/schemas/AuditInfo",
            "title": "auditInfo"
          },
          "errorReason": {
            "$ref": "#/components/schemas/RefundErrorReason",
            "title": "errorReason"
          }
        },
        "required": [
          "amount",
          "auditInfo",
          "buyerEmail",
          "buyerId",
          "id",
          "merchantId",
          "reason",
          "status",
          "type"
        ]
      },
      "RefundStatus": {
        "description": "The status of the refund\n\n<ul>\n<li>PENDING: The refund is pending</li>\n<li>PROCESSING: The refund is being processed</li>\n<li>COMPLETED: The refund is completed</li>\n<li>FAILED: The refund failed</li>\n</ul>",
        "title": "RefundStatus",
        "enum": [
          "COMPLETED",
          "FAILED",
          "PENDING",
          "PROCESSING"
        ],
        "type": "string"
      },
      "RefundType": {
        "description": "The type of the refund\n\n<ul>\n<li>CHECKOUT: The refund is for a checkout</li>\n</ul>",
        "title": "RefundType",
        "enum": [
          "CHECKOUT",
          "SUBSCRIPTION"
        ],
        "type": "string"
      },
      "RefundErrorReason": {
        "description": "The reason for the refund error\n<ul>\n<li>REFUND_NOT_FOUND - The refund was not found</li>\n<li>INVALID_TRANSACTION_STATUS - The transaction is not in a status that allows refunds</li>\n<li>INVALID_REFUND_TRANSACTION_STATUS - The refund transaction is not in a status that allows refunds</li>\n<li>CANNOT_REFUND_MORE_THAN_ORIGINAL_AMOUNT - The refund amount is greater than the original transaction amount</li>\n<li>CANNOT_PARTIALLY_REFUND - This transaction does not support partial refunds</li>\n<li>REFUND_NOT_SUPPORTED - The refund is not supported for the transaction</li>\n<li>REFUND_REJECTED - The refund was rejected by the vendor</li>\n<li>UNKNOWN_ERROR - An unknown error occurred</li>\n</ul>",
        "title": "RefundErrorReason",
        "enum": [
          "CANNOT_PARTIALLY_REFUND",
          "CANNOT_REFUND_MORE_THAN_ORIGINAL_AMOUNT",
          "INVALID_REFUND_TRANSACTION_STATUS",
          "INVALID_TRANSACTION_STATUS",
          "REFUND_NOT_FOUND",
          "REFUND_NOT_SUPPORTED",
          "REFUND_REJECTED",
          "UNKNOWN_ERROR"
        ],
        "type": "string"
      }
    }
  }
}
```