Here we describe how you can manage both online and point-of-sale gift cards and other stored-value cards with our JSON-only Stored Value API. This API lets you do the following transactions:
- Issue: issue a new gift card or other stored value card.
- Change status: activate or deactivate a card.
- Load: add funds to the balance of the card.
- Check balance: query the remaining balance of the card.
- Merge balance: transfer all funds from a card to another one from the same provider.
- Void transaction: undo a Stored Value API transaction from the last 24 hours.
With a point-of-sale integration, you may prefer to do the above transactions (except issuing) using our Terminal API because you already use that to make in-person gift card payments.
Not for payments
The Stored Value API doesn't let you make, cancel, or refund payments. For these transactions, refer to the following table:
| Transaction | Integration type | |
|---|---|---|
| Make a gift card payment | Online | In-person payments |
| Cancel a gift card payment | Online | In-person payments |
| Make a refund to a gift card | Online | In-person payments |
Supported cards
The Stored Value API currently supports:
- Gift cards provided by Givex
- Gift cards provided by Intersolve (see our overview page for a selection of the gift cards that can go over this connection)
- Gift cards provided by SVS
- Gift cards provided by Fiserv (formerly ValueLink)
Transactions per provider and channel
Whether a Stored Value API transaction is allowed, depends on the provider and the channel. Here is an overview:
Online
| Transaction | Givex | SVS | Fiserv (formerly ValueLink) | Intersolve |
|---|---|---|---|---|
| Issue new See note |  |  | | |
| Activate | | | | |
| Activate and load amount | | | | |
| Deactivate (without amount) | | | | |
| Load amount | | | | |
| Check balance | | | | |
| Merge balance | | | | |
| Void (undo) other transaction | | | | |
In-person payments
| Transaction | Givex | SVS | Fiserv (formerly ValueLink) | Intersolve |
|---|---|---|---|---|
| Issue new | | | | |
| Activate | | | | |
| Activate and load amount | | | | |
| Deactivate (without amount) | | | | |
| Load amount | | | | |
| Check balance | | | | |
| Merge balance | | | | |
| Void (undo) other transaction | | | | |
Endpoints
| Test | https://pal-test.adyen.com/pal/servlet/StoredValue/v46/method |
| Live | https://pal-live.adyen.com/pal/servlet/StoredValue/v46/method |
The /method can be:
Result codes
These are the result codes you can receive from the Stored Value API.
- Success: The operation has been completed successfully.
- Refused: The operation was refused. The reason is given in the
refusalReasonfield. - Error: There was an error when the operation was processed. The reason is given in the
refusalReasonfield. - NotEnoughBalance: The amount on the gift card or other stored-value card is lower than the amount given in the request.
Testing and going live
-
Before going live, use the following data to test Stored Value API transactions using the Adyen simulator:
Type Number Security code Expiry month and year Optional Givex gift card 603628672882001915092 5754 12 2020 SVS gift card 6006491286999921374 1111 12 2020 Fiserv (formerly ValueLink) gift card 7777182708544835 2329 12 2049 Enter any value when the simulator asks for a Fiserv (formerly ValueLink) promo code.
-
Apart from testing with our simulator, you should do end-to-end testing. Ask the provider of the gift card or other stored-value card for the test data you can use.
-
When you are ready to move to live, switch from test to live endpoints.