Redeem Gift Card

POST 
/gift_cards/:id/redeem

Redeem a gift card. The full amount becomes account credit for the signed-in customer at this studio, who becomes the card's recipient. A gift card can only be redeemed once; concurrent requests are serialized and all but the first get gift_card_already_redeemed.

Providers

• Must have one of the following permissions: super_admin, store, pos.

Customers

• Any customer can perform this action.

Unregistered Customers

• No access.

Request

Responses

200

400

Bad Request. code is one of:

• gift_card_already_redeemed: the card has already been redeemed, including by the same customer.
• gift_card_expired: the card's redeem_by has passed.
• gift_card_recipient_mismatch: the card was assigned to a different customer at this studio.
• customer_required: the request isn't from a customer. Only reachable in provider mode by staff with no customer profile at this studio.

401

Unauthorized. code is authentication_failed: the access token is invalid or expired. See Errors.

403

Forbidden. code is permission_denied: the request has no recognised credentials, or the signed-in user isn't a customer at this studio. See Errors.

404

Not Found. code is gift_card_not_found: no gift card matches the lookup at the studio in Teamup-Provider-ID, including a card issued by another studio.

429

Too Many Requests. code is throttled. See Errors.