> ## Documentation Index > Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt > Use this file to discover all available pages before exploring further. # Refunds - Update > Updates the properties of a Refund object. This API can be used to attach a reason for the refund or metadata fields ## OpenAPI ````yaml post /refunds/{refund_id} openapi: 3.0.3 info: title: Hyperswitch - API Documentation description: > ## Get started Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Hyperswitch Support url: https://hyperswitch.io email: support.global@juspay.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://sandbox.hyperswitch.io description: Sandbox Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events - name: Authentication description: Create and manage authentication - name: Subscriptions description: Subscription management and billing endpoints - name: Card Issuer description: Create and manage card issuers paths: /refunds/{refund_id}: post: tags: - Refunds summary: Refunds - Update description: >- Updates the properties of a Refund object. This API can be used to attach a reason for the refund or metadata fields operationId: Update a Refund parameters: - name: refund_id in: path description: The identifier for refund required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RefundUpdateRequest' examples: Update refund reason: value: reason: Paid by mistake required: true responses: '200': description: Refund updated content: application/json: schema: $ref: '#/components/schemas/RefundResponse' '400': description: Missing Mandatory fields content: application/json: schema: $ref: '#/components/schemas/GenericErrorResponseOpenApi' security: - api_key: [] components: schemas: RefundUpdateRequest: type: object properties: reason: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive example: Customer returned the product nullable: true maxLength: 255 metadata: type: object description: >- You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. nullable: true additionalProperties: false RefundResponse: type: object required: - refund_id - payment_id - amount - currency - status - connector properties: refund_id: type: string description: Unique Identifier for the refund payment_id: type: string description: The payment id against which refund is initiated amount: type: integer format: int64 description: >- The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc example: 6540 minimum: 100 currency: type: string description: The three-letter ISO currency code status: $ref: '#/components/schemas/RefundStatus' reason: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive nullable: true metadata: type: object description: >- You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object nullable: true error_message: type: string description: The error message nullable: true error_code: type: string description: The code for the error nullable: true unified_code: type: string description: >- Error code unified across the connectors is received here if there was an error while calling connector nullable: true unified_message: type: string description: >- Error message unified across the connectors is received here if there was an error while calling connector nullable: true created_at: type: string format: date-time description: The timestamp at which refund is created nullable: true updated_at: type: string format: date-time description: The timestamp at which refund is updated nullable: true connector: type: string description: The connector used for the refund and the corresponding payment example: stripe profile_id: type: string description: The id of business profile for this refund nullable: true merchant_connector_id: type: string description: >- The merchant_connector_id of the processor through which this payment went through nullable: true split_refunds: allOf: - $ref: '#/components/schemas/SplitRefund' nullable: true issuer_error_code: type: string description: Error code received from the issuer in case of failed refunds nullable: true issuer_error_message: type: string description: Error message received from the issuer in case of failed refunds nullable: true raw_connector_response: type: string description: Contains whole connector response nullable: true connector_refund_id: type: string description: A unique identifier for a payment provided by the connector nullable: true GenericErrorResponseOpenApi: type: object required: - error_type - message - code properties: error_type: type: string example: invalid_request message: type: string example: 'Missing required param: {param}' code: type: string example: IR_04 RefundStatus: type: string description: The status for refunds enum: - succeeded - failed - pending - review SplitRefund: oneOf: - type: object required: - stripe_split_refund properties: stripe_split_refund: $ref: '#/components/schemas/StripeSplitRefundRequest' - type: object required: - adyen_split_refund properties: adyen_split_refund: $ref: '#/components/schemas/AdyenSplitData' - type: object required: - xendit_split_refund properties: xendit_split_refund: $ref: '#/components/schemas/XenditSplitSubMerchantData' description: >- Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details. StripeSplitRefundRequest: type: object description: >- Charge specific fields for controlling the revert of funds from either platform or connected account for Stripe. Check sub-fields for more details. properties: revert_platform_fee: type: boolean description: >- Toggle for reverting the application fee that was collected for the payment. If set to false, the funds are pulled from the destination account. nullable: true revert_transfer: type: boolean description: >- Toggle for reverting the transfer that was made during the charge. If set to false, the funds are pulled from the main platform's account. nullable: true additionalProperties: false AdyenSplitData: type: object description: >- Fee information for Split Payments to be charged on the payment being collected for Adyen required: - split_items properties: store: type: string description: The store identifier nullable: true split_items: type: array items: $ref: '#/components/schemas/AdyenSplitItem' description: Data for the split items additionalProperties: false XenditSplitSubMerchantData: type: object description: >- Fee information to be charged on the payment being collected for sub-merchant via xendit required: - for_user_id properties: for_user_id: type: string description: The sub-account user-id that you want to make this transaction for. additionalProperties: false AdyenSplitItem: type: object description: Data for the split items required: - amount - split_type - reference properties: amount: type: integer format: int64 description: The amount of the split item example: 6540 split_type: $ref: '#/components/schemas/AdyenSplitType' account: type: string description: >- The unique identifier of the account to which the split amount is allocated. nullable: true reference: type: string description: Unique Identifier for the split item description: type: string description: >- Description for the part of the payment that will be allocated to the specified account. nullable: true additionalProperties: false AdyenSplitType: type: string enum: - BalanceAccount - AcquiringFees - PaymentFee - AdyenFees - AdyenCommission - AdyenMarkup - Interchange - SchemeFee - Commission - TopUp - Vat securitySchemes: api_key: type: apiKey in: header name: api-key description: >- Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application. ````