Refunds
Void
Cancels a transaction before it has been finalized or settled. No money is moved. Typically used within the same day or session.
Use when: The transaction was made in error and needs to be stopped before processing.
Reversal
Undoes a transaction before settlement but after authorization. The funds are returned to the cardholder as if the transaction never happened.
Use when: The transaction was authorized, but something failed before settlement (e.g. a system error or a customer changes their mind immediately).
Refund
Returns money after a transaction has been settled. The funds are sent back to the cardholder’s account.
Use when: A customer returns a product or service after the transaction has gone through.
Prevention on transaction
Transaction are processed by the SDK to the payment processor and to the bank.
If either of those channel failed the transaction would be voided and no payment would occur.
The client can then again try the transaction again.
POST https://kernelserver.{env}.haloplus.io/transactions/{transactionId}/refund
This endpoint allows you to initiate a refund for a previously processed transaction.
Path Parameters
| Name | Type | Description |
|---|---|---|
| env * | String | The backend environment [dev, qa, prod] |
| transactionId * | String | This is a placeholder for the unique identifier of the transaction you want to refund. You must replace it with the actual transaction ID |
Headers
| Name | Type | Description |
|---|---|---|
| x-api-key * | String | The API Key retrieved from the Portal |
Request Body
| Name | Type | Description |
|---|---|---|
| amount * | Number | Monetary value of the transaction |
| refundReference * | String | Reference of the refund |
- Request body
- 200: OK Status response of the transaction
{
"amount": 5,
"refundReference": "test-refund"
}
{
type: "Approved",
authorizationCode: "asdflk",
tags: [{ "tag": "9F1E", "33333333"}],
haloReference: "5cb6a780-f3bc-45b6-b1ef-bf7fe5e41fbf",
errorMessage: "Ok",
errorCode: 0,
isoResponseCode: 0,
association: "Visa",
expiryDate: "07/24",
paymentProviderReference: "5cb6a780-f3bc-45b6-b1ef-bf7fe5e41fbf"
}