Refunds - Retrieve
Retrieves a Refund. This may be used to get the status of a previously initiated refund
Authorizations
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.
Path Parameters
The identifier for refund
Response
Unique Identifier for the refund
The payment id against which refund is initiated
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
x > 100The three-letter ISO currency code
The status for refunds
succeeded, failed, pending, review The connector used for the refund and the corresponding payment
An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive
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
The error message
The code for the error
The timestamp at which refund is created
The timestamp at which refund is updated
The id of business profile for this refund
The merchant_connector_id of the processor through which this payment went through
Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.