The /load
endpoint of our Stored Value API lets you add funds to a gift card or other type of stored-value card. These funds are available to the shopper if the card has been activated. Virtual cards are activated automatically when you issue them. But for physical cards, it is necessary that you also activate them.
Not for refunds
Because the /load
transaction is not related to a payment, you cannot use it to make a refund. Refer to:
Transaction | Link | |
---|---|---|
Make a refund to a gift card | Online | In-person payments |
Transaction per provider and channel
Online
Transaction | Givex | SVS | Fiserv (formerly ValueLink) | Intersolve |
---|---|---|---|---|
Load amount |
In-person payments
Transaction | Givex | SVS | Fiserv (formerly ValueLink) | Intersolve |
---|---|---|---|---|
Load amount |
Load an amount
When you add funds to a gift card or other stored-value card, the way to specify the card details depends on whether you tokenized a payment that the shopper made with this card.
To add funds to a gift card or other stored-value card that has not been tokenized:
-
Make a POST request to the
/load
endpoint, specifying:-
amount
: Thecurrency
andvalue
of the funds you want to store on the card. The supported currencies differ per provider. -
loadType
: If not specified, defaults toload
. SpecifymerchandiseReturn
if the amount to add comes from goods that the shopper returned. -
merchantAccount
: Name of the merchant account that you want to process the transaction with. -
store
:Optional -
paymentMethod
object with:type
: Name or brand of the card. Accepted values: givex, svs, valuelink, any Intersolve-supported card type.number
: Card number that identifies the card.securityCode
: If the card has a PIN code or other type of security code, obtain it from the shopper and provide it here.expiryMonth
:OptionalexpiryYear
:Optional-
holderName
:Optional
-
reference
: Your reference to uniquely identify the transaction. To provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
This request refunds USD 20 to an SVS gift card because the shopper returned goods to the store:
{ "amount": { "currency": "USD", "value": 2000 }, "loadType": "merchandiseReturn", "merchantAccount": "ADYEN_MERCHANT_ACCOUNT", "store":"YOUR_STORE_ID", "paymentMethod": { "type": "svs", "number": "6006491286999921374", "securityCode": "1111" }, "reference": "YOUR_REFERENCE" } -
Response
You receive a response containing:
currentBalance
: Thecurrency
and totalvalue
of the funds stored on the card.pspReference
: Adyen's 16-character unique reference associated with the request.resultCode
: Indicates the state of the request. Success means the amount has been added. Refer to Result codes for the values that you can receive.
The response may include additional fields, depending on the additional data settings for your merchant account. In your Customer Area, you'll find these settings under Developers > Additional data.
This response shows that after adding USD 20, the SVS gift card now has a balance of USD 30:
{ "currentBalance": { "currency": "USD", "value": 30000 }, "pspReference": "851564654294247B", "resultCode": "Success" }