API Reference

Charge Gift Card

put
https://apidev.ionia.io/GiftCard/

This endpoint is to allow the updating of balance and some related statuses of a gift
card within the Ionia ecosystem.

To mark a card as Redeemed:
You need to put the exact remaining balance of the specified gift card to this API, at
which point it will deduct that value from the balance of the card and mark the card as
‘Redeemed’.

To mark a card as Active:
Send a negative amount between 0.01 and the original face value of the gift card.This
will add the passed balance back to the card and mark it as active again. (note that this
does not affect the actual value of the card of course, but it’s for tracking and this
specific “set as active” logic).

Path Params
string
required

Accepts string value for Gift Card Id and it is a mandatory input. This id is received in the response of PurchaseGiftCard or View PurchasedGiftCards endpoint.

Body Params
double

Accepts double value for Amount of the giftcard used. Typically this is the full amount of the gift card purchased, but can be a different amount if a partial amount was used.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated about 3 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
Updated about 3 years ago