Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Refundgiftcardtransaction

post/v2/giftcards/programs/{programId}/cards/{cardId}/transactions/{transactionId}/refund

Path parameters

transactionIdstring required
Example:5eb7cf5a86d9755df3a6c593
programIdstring required
Example:5eb7cf5a86d9755df3a6c593
cardIdstring required
Example:5eb7cf5a86d9755df3a6c593

Headers

idempotency-keystring nullable
X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Request body

reasonstring nullable
posTransactionIdstring nullable

Response

Successful Response

transactionIdstring required
giftCardIdstring required
refundedAmountstring required
remainingBalancestring required
successboolean required
messagestring required

Example response

{
  "transactionId": "5eb7cf5a86d9755df3a6c593",
  "giftCardId": "5eb7cf5a86d9755df3a6c593"
}