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
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | ID of your organization |
action | String | Yes | load_balance |
member_id | Number | Yes | ID of a gift card |
amount | Number | Yes | Amount to add, in the program currency. Must be greater than zero. |
description | String | No | Description 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
| Message | Cause |
|---|---|
Only gift cards can be topped up | The card belongs to a program that is not a gift_card |
Amount must be greater than zero | amount is missing, zero or negative |
Report an issue with this documentation
Please log in to report issues with our documentation.