Refund a Debit Transaction

Refund a Debit Transaction

POST /service/v1.1/transactions/:transactionId/refund

Issue a refund for an existing debit transaction (redeem). You can issue refunds up to the total amount of the original debit transaction. Refunds are possible for up to 14 days after the underlying debit was confirmed. The transactionId is the giftcard transaction ID of the original debit transaction. You can find the transactionId in the field giftcardTransactionId in a confirmed transaction intent. You need to store 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 int The amount that you want to refund. May not exceed the amount of the underlying debit transaction.
metadata object optional 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.