Create a Refund
Use this call to create a new refund for a payment made on a Checkout transaction.
Prerequisite
Get an access_token and use it as 'Bearer' token in your request. Find more details here.
Request
POST https://api.pay.cm.com/api/v1/paymentmethods/checkout/v1/transactions/{transactionId}/refunds
{
"amount": 1200,
"reason": "Refund required by customer."
}
Optional parameters
| Parameter | Type | Description | Constraints |
|---|---|---|---|
| amount | Int(1...99999999) | Denomination in the smallest currency subunit (e.g. eurocents). If empty, the refund amount will be the remaining available amount of the transaction (e.g. total payment amount minus already refunded amounts minus the amounts of the pending refund requests). | Must be lower than or equal to the original transaction amount. |
| reason | String(255) | The description for the refund. |
Response
If refund has been successfully created then the response is the Get Transaction response with an updated refunds.refundedAmount and refunds.refundedPendingAmount.
Response codes
| HTTP status | Description |
|---|---|
| 201 | Refund successfully created. |
| 4XX | Client error response (See message for details). This response is given when the User input was incorrect or something illegal was attempted (eg. using a service without having that service configured for the user, or not being authorized). |
| 5XX | Server error response (See message for details). |