Gift Card API reference
The Zettle Gift Card API is used to programmatically fetch details for a gift card. It's usually used together with the Purchase API to provide additional purchasing information. To be able to track the status of gift cards, each gift card has a code, and a unique gift card Uuid. The UUID is used in the purchase history information, and can be retrieved through the Purchase API.
For more information on how to get authorisation for the scope, see OAuth API.
Returns details for a gift card with a known UUID.
Example: This request returns the details for the gift card with the
5c84a1a6-96d0-11eb-b3d5-7961f4378b1d. The returned response shows that the gift card is valid for two years from 2021. It is worth 5000 in the defined currency unit, and no redemptions have been made.
Click to hide request parameters.
|organizationUuid||string||path||required||Unique identifier for your organisation. You can use following options to fill in this value: |
|Uuid||string||path||required||Unique identifier for a gift card. It can be found in the purchase history fetched through the Purchase API. See for example Fetch expired and redeemed gift cards.|
Click to hide HTTP status codes.
|200 OK||Returned when the operation is successful.|
|404 Giftcard not found||Returned when a a gift card is not found.|
Click to hide response attributes.
|uuid||string||Unique identifier for the gift card.|
|Created||string||The date when the gift card was created.|
|ValidTo||string||The date after which the gift card will be expired and can no longer be used. A gift card can be valid for one, two, or three years.|
|initialAmount||integer||The amount of money that the gift card is loaded with.|
|remainingAmount||integer||The current balance of the gift card.|