Load gift card balance

Top up the balance of a gift card.

Endpoint

POST
/loyalty-actions with "action": "load_balance"

Request

Response

json

member is the full Loyalty Member object after the top-up (shortened above).

Body parameters

NameTypeRequiredDescription
organization_idNumberYesID of your organization
actionStringYesload_balance
member_idNumberYesID of a gift card
amountNumberYesAmount to add, in the program currency. Must be greater than zero.
descriptionStringNoDescription of the movement (defaults to Gift card top-up)

This action has no idempotency key: send it once per top-up. To spend a gift card balance, create a redemption with amount.

Errors

MessageCause
Only gift cards can be topped upThe card belongs to a program that is not a gift_card
Amount must be greater than zeroamount is missing, zero or negative

Report an issue with this documentation

Please log in to report issues with our documentation.