post
https://api-sandbox.qorcommerce.io/v3/payment/refund
Provide a full or partial refund on a Sale or Capture
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
A refund can be issued against a Sale or Authorization transaction that has already settled (batched). This function returns funds to the card holder for equal or less value than the original Sale/Capture transaction.
Note:If the original sale or authorization is not settled (batched) and you want to cancel the transaction completely use the Void endpoint.
Parameters
The following parameters are available to process refunds.
| parameter | description | required |
|---|---|---|
| mid | the Merchant ID (MID) assigned by USER.COMPANY_NAME or your merchant service provider (MSP) | Yes |
| reference_id | A reference id that will be echo'd back in the message response. | No |
| amount | the total amount to refund | Yes - only if partial amount requested |
| transaction_id | the unique transaction_id from the original sale or authorization | Yes |
| metadata | a set of key-value pairs that you can attach to a payment. This can be useful for storing additional information about the payment in a structured format. | No |
Response Codes
- Payment Response Codes
Link to details on related response codes.