Activate a Giftcard
Activate a Gift Card
POST
https://api.pos.zmyle.de/service/v1.1/gift_cards/:giftcardId/activate
Activate a gift card. Activating a giftcard equals selling a gift card.
Path Parameters
Name | Type | Description |
---|---|---|
giftcardId | string | A giftcard's unique ID. |
Request Body
Name | Type | Description |
---|---|---|
accessToken | string | The access token of the giftcard that you want to activate. |
metadata | object | A set of key-value pairs that you can attach to this giftcard transaction (activation). |
Example Request
Response Error Codes
error code | reason |
api:io:missingRequiredParam | A required parameter is missing. |
api:io:malformedId | The giftcard ID is not right. |
api:io:malformedToken | The access token is not right. |
api:biz:noSuchGiftcard | The API could not find the giftcard. This either means that such a giftcard simply does not exist, or that you are not authorized to access this giftcard at all (not your giftcard or not your network). |
api:biz:notAuthorizedToActivateGiftcard | You don't have permission to activate this giftcard. |
api:biz:notPreprintedGiftcard | This giftcard can not be activated. |
api:biz:giftcardAlreadyActive | This giftcard was already activated. |
api:biz:retailerStatus | Your account is not in good standing. |
Last updated