Refund a Transaction
Refund a Gift Card Transaction
POST https://api.pos.zmyle.de/service/v1.1/transactions/:transactionId/refund
Issue a refund for an existing debit transaction (redeem). Each refund is based on an underlying debit transaction. You can refund the full amount or just partial amounts, up to the total amount of the underlying debit transaction. Refunds are possible for up to 14 days after the underlying debit was confirmed.
The transactionId is the gift card transaction ID of that underlying debit. You can find the transactionId in the field giftcardTransactionId from the transaction intent object after you commit a transaction intent. You need to memorize that transaction ID in order to be able to issue refunds later on.
Path Parameters
| Name | Type | Description |
|---|---|---|
transactionId | string | The ID of the debit transaction that you want to refund. |
This endpoint supports idempotency.
Request Body
Body |
amount The amount that you want to refund. May not exceed the amount of the underlying debit transaction. |
metadata A set of key-value pairs that you can attach to this refund transaction. Refer to the description of metadata. |
Response
A (refund) gift card transaction object.
Response Error Codes
error code | reason |
api:io:missingRequiredParam | A required parameter is missing. |
api:io:malformedId | The transaction ID is misformed. |
api:biz:unauthorizedForResource | You are not authorized to access this resource. |
api:biz:noSuchTransaction | There is no such debit transaction that you can refund. |
api:biz:debitTransactionLocked | The debit transaction is locked; i.e. it has been more than 14 days since it was confirmed and the refund cannot be accepted. |
api:biz:insufficientFunds | You are trying to refund a bigger amount than what is left for refunding on the debit transaction. |
api:biz:noSuchRetailer | The API could not identify the acting retailer. |
api:biz:retailerStatus | The acting retailer is blocked. |
Last updated