Reload a gift card

post

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

Reloads an amount onto the 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

required

The amount in cents which to load onto the gift card. The amount must be equal or greater than zero.

external_location_id

string

The external ID of a 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 initial balance topup transaction for the gift card. If this field is left empty, the primary location of the gift card program will be used.

funding_source

object

Funding source details

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 the location from where the gift card will be issued. If no location ID is specified, the primary location of the gift card program is used.

notify_recipient

boolean

Whether to send the gift email to the recipient's email or phone number if those fields were provided. Defaults to true.

Responses

200Returns the outcome of the reload action.

401Not authorized to access external location.

404External order not found.