Redeem Gift Card

Redeems a specified amount from a gift card. Deducts the amount from the gift card balance and returns the transaction result. This is typically used when a customer wants to use their gift card for a purchase, allowing the merchant to process the redemption and update the remaining balance on the card.

Headers

x-applicationSource
Type: string
required

A custom HTTP header that accepts a free-form string value. It is used to identify the application making the API request. For example, if Punchh invokes the API, the value could be "punchh".
X-LocationId
Type: string
required

The unique location identifier for the store or business location processing the transaction.
Content-Type
Type: string
required

The media type of the request body. Must be set to application/json.
Authorization
Type: string
required

Bearer token for API authorization. Send in the format: Bearer ACCESS_TOKEN_GOES_HERE.

Body·

application/json

Request details to redeem the gift card amount

cardNumber
Type: string
max length:
30Pattern: ^\d+$
required

Gift Card number for which amount will be redeemed
referenceNumber
Type: string
min length:
1
max length:
40Pattern: ^[0-9]+$
required

A unique reference number for the transaction.
transactionAmountDetails
Type: object ·
required
transactionDateTimeLocal
Type: string Format: date-time
required

The transaction date and time in local format.
transactionDateTimeUTC
Type: string Format: date-time
required

The transaction date and time in UTC format.
channel
Type: string · enum
values
- None
- POS
- Kiosk
giftCardPassCode
Type: string | null

The passcode associated with the Gift Card.
invoiceNumber
Type: string | null
max length:
14

The invoice number associated with the transaction.
paymentSource
Type: string · enum
values
- ScanToPay
- Online
- None

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/giftcard/v1/redeem

curl https://SERVER_NAME_GOES_HERE.partech.com/giftcard/v1/redeem \
  --request POST \
  --header 'x-applicationSource: ' \
  --header 'X-LocationId: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --data '{
  "cardNumber": "GIFT_CARD_NUMBER_GOES_HERE",
  "giftCardPassCode": "GIFT_CARD_PASSCODE_GOES_HERE",
  "referenceNumber": "258",
  "invoiceNumber": 2148,
  "transactionDateTimeUTC": "2026-03-06T11:28:29.72623Z",
  "transactionDateTimeLocal": "2026-03-06T11:28:29.726",
  "transactionAmountDetails": {
    "taxAmount": 0,
    "discount": 0,
    "productTotalAmount": 0,
    "totalAmount": 10000,
    "tip": null
  },
  "paymentSource": "Online",
  "channel": null
}'

Show Schema

{
  "parPayTransactionId": "TRANSACTION_ID_GOES_HERE",
  "statusMessage": "APPROVAL",
  "balanceAmount": "759.14",
  "transactionAmount": "1000.00",
  "transactionDateTimeUTC": "2026-03-06T11:28:29.7261913Z",
  "status": "Success"
}

Gift Card reedeemed successfully