Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Manage gift cards

Use our Stored Value API to manage gift cards and other stored-value cards.

To initiate a gift card payment, you make a payment request that's applicable to the channel, as described for online payments or point of sale.

Here we describe how you can manage gift cards using our JSON-only Stored Value API. You can use this API for both web and point-of-sale, but not all transactions are applicable for both channels. The API consists of the following calls:

  • 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 when you want to top it up or when the shopper returns merchandise.
  • Check balance: Query the remaining balance of the card.
  • Merge balance: Transfer all funds from a card to another one of the same type.
  • Void transaction: Undo one of the above transactions (except checking the balance) from the last 24 hours.

If a shopper paid with a gift card or other stored-value card and you tokenized this payment, you can use the token to identify the card in these transactions.

With a POS integration, you may prefer to do these transactions using our Terminal API.

Supported cards

The transactions to manage gift cards and other stored-value cards currently support:

  • Gift cards provided by Givex
  • Gift cards provided by SVS
  • Gift cards provided by ValueLink

Supported transactions

Not all transactions are applicable for all providers and channels. Here is an overview:

Web channel

Transaction Givex SVS ValueLink
Issue new -x- -white_check_mark- -white_check_mark-
Activate -x- -x- -x-
Activate and load amount -x- -x- -x-
Deactivate (without amount) -white_check_mark- -x- -x-
Load amount -white_check_mark- -white_check_mark- -white_check_mark-
Check balance -white_check_mark- -white_check_mark- -white_check_mark-
Merge balance -x- -x- -white_check_mark-
Void (undo) other transaction -white_check_mark- -white_check_mark- -white_check_mark-

POS channel

Transaction Givex SVS ValueLink
Issue new -x- -x- -x-
Activate -white_check_mark- -white_check_mark- -white_check_mark-
Activate and load amount -white_check_mark- -white_check_mark- -white_check_mark-
Deactivate (without amount) -white_check_mark- -x- -x-
Load amount -white_check_mark- -white_check_mark- -white_check_mark-
Check balance -white_check_mark- -white_check_mark- -white_check_mark-
Merge balance -x- -x- -white_check_mark-
Void (undo) other transaction -white_check_mark- -white_check_mark- -white_check_mark-

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 refusalReason field.
  • Error: There was an error when the operation was processed. The reason is given in the refusalReason field.
  • NotEnoughBalance: The amount on the payment method is lower than the amount given in the request.

Testing and going live

Before going live, use the following data to test operations 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
ValueLink gift card 7777182708544835 2329 12 2049

Enter any value when the simulator asks for a 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're ready to move to production, you'll have to switch from test to our live endpoints. See Live endpoints for more information.

Next steps

See also