Redeem a gift card

post

https://api.loopz.io/v1/public/gift-cards/{giftCardIdOrCode}/charge

Charges an amount to a gift card. If the gift card has a customer email linked, a notification email will be sent to the gift card holder's email address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

giftCardIdOrCode

string

required

Body Params

amount

int64

The amount in cents to redeem of the gift card balance. The amount is not required if the external_order_id field is provided. In this case the required amount to cover the due amount of the external order is charged to the gift card's balance. If the due amount of the external order is greater than the available balance of the gift card, the available balance of the gift card is applied to the order.

external_location_id

string

The external ID of location in the gift card program. This ID is can be provided instead of the location_id field. This location will be used for the charge transaction. If this field is left empty, the primary location of the gift card program will be used.

external_order_id

string

The ID of an external order to which the redemption amount will be applied. The order details will be retrieved from the location identified by either the provided location_id or external_location_id field and a gift card payment will be applied to the order for the charged amount.

idempotency_key

string

required

A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

location_id

string

The ID of location in the gift card program. This location will be used for the charge transaction. If this field is left empty the external_location_id will be used.

metadata

object

Responses

200Returns the outcome of the charge action.

401Not authorized to access external location.

404External order not found.