Refund
POST /refund
This endpoint is used to refund a transaction either partially or fully.
If you're unsure whether the authorization has been captured and want to issue a full refund, consider using the 'Reverse' action.
You can perform partial refunds only on transactions. For partial refunds on authorizations, use 'Adjust Authorization'.
Test URL
The refund request will be made to the following URL:
https://checkout-api.staging.straumur.is/api/v1/modification/refund
This call will create an refund request for the specified amount on the intended transaction.
On live, use the same path on https://greidslugatt.straumur.is. Headers, request and response are identical. See Live environment.
Request Example
{
"reference": "9990QQAZ1221",
"payfacReference": "5215125152151259990QQAZ1",
"amount": 1000,
"currency": "ISK",
"refundReason": "FRAUD"
}
Request Body Fields
| Field | Type | Required | Description | Example | Min Length | Max Length |
|---|---|---|---|---|---|---|
| reference | String | Required | Merchant reference to uniquely identify a payment. | 9990QQAZ1221 | - | 200 |
| payfacReference | String | Required | Straumur reference to uniquely identify a payment. | 5215125152151259990QQAZ1 | - | 100 |
| amount | Integer | Required | The amount to be charged in minor units. | 127300 | - | - |
| currency | String | Required | The three-character ISO currency code. | ISK | 3 | 3 |
| refundReason | String | Optional | Merchant's reason for the refund. | CUSTOMER REQUEST | - | 100 |
You are not required to send a refund reason, however, if you do, we only support these values:
- OTHER
- RETURN
- DUPLICATE
- FRAUD
- CUSTOMER REQUEST
If you provide a value outside of this range, the system will return an error.
Example - Received Response
Status Received means that the system has acknowledged your request and will process it.
After completion, you will receive a final response through a webhook.
The payfacReference in this response identifies the refund itself, not the original authorization. The outcome arrives as a Refund event, carrying the same value as payfacReference and the authorization's reference as originalPayfacReference. See Reference fields.
{
"status": "Received",
"payfacReference": "ASDAKOS125152",
"responseDateTime": "2024-09-04T09:50:14.343503Z",
"responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
Error Response
Our error responses are standardised. Please see Errors.
You can also find a detailed overview of our HTTP Status Codes.