Refund PATCH API Documentation

Purpose

This endpoint updates the details of an existing refund, such as amount, reference, or note, while keeping the refund record active and linked to the original credit note.

Use Case

This endpoint is used when adjustments are required for an already created refund. For example, if the refund amount needs to be corrected, or additional notes or references must be added for better tracking, the refund can be updated without creating a new record.

Path Parameters

Parameter	Type	Description
refund_id	String	Unique identifier of the refund to be updated.

Query Parameters

This endpoint does not have any query parameters.

Request Body

The request body contains the refund details that need to be updated. Only the provided fields (amount, reference, note) will be modified, while other details remain unchanged.

                JSON
              

                      {
  "refund": {
    "amount": "NUMBER",
    "reference": "REFERENCE_ID",
    "note": "STRING_VALUE"
  }
}
                    

Attribute	Type	Description
amount	String	Updated refund amount.
reference	String	Updated reference identifier for the refund.
note	String	Additional note or description for the refund.

Response

The response returns the updated refund details including its status, ID, amount, reference, note, payment method, processor, associated credit note ID, custom attributes, versioning, audit fields (created/updated info), and unique UUID.

Response Body

                JSON
              

                      {
  "refund": {
    "status": "STATUS",
    "id": "REFUND_ID",
    "amount": "NUMBER",
    "reference": "REFERENCE_ID",
    "note": "STRING_VALUE",
    "payment_method": "PAYMENT_METHOD",
    "payment_processor": "PAYMENT_PROCESSOR",
    "gateway_response": "STRING_VALUE",
    "credit_note_id": "CREDIT_NOTE_ID",
    "custom_attributes": [
      {
        "name": "ATTRIBUTE_NAME",
        "value": "ATTRIBUTE_VALUE"
      }
    ],
    "version": "VERSION_NUMBER",
    "created_by": "CREATOR_NAME",
    "created_on": "TIMESTAMP",
    "last_updated_by": "UPDATED_BY",
    "last_updated_on": "TIMESTAMP",
    "uuid": "UUID"
  }
}
                    

Attribute	Type	Description
status	String	Current status of the refund (example: ACTIVE).
id	String	Unique identifier of the refund.
amount	String	Updated refund amount.
reference	String	Updated refund reference.
note	String	Updated note for the refund.
payment_method	String	Payment method used for refund.
payment_processor	String	Payment processor handling the refund.
gateway_response	String	Response received from payment gateway, if any.
credit_note_id	String	ID of the credit note linked to the refund.
custom_attributes	Array	List of custom attributes for additional metadata.
version	String	Version number of the refund record.
created_by	String	User who originally created the refund.
created_on	String	Timestamp when the refund was created.
last_updated_by	String	User who last updated the refund.
last_updated_on	String	Timestamp when the refund was last updated.
uuid	String	Universally unique identifier of the refund.