Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Load funds to a gift card

Learn how to add an amount to a gift card or other stored-value card.

With a /load call to our Stored Value API, you can 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.

Because the /load call is not related to a payment, you shouldn't use it to make a refund.

Support

Web channel

Transaction Givex SVS ValueLink
Load amount -white_check_mark- -white_check_mark- -white_check_mark-

POS channel

Transaction Givex SVS ValueLink
Load amount -white_check_mark- -white_check_mark- -white_check_mark-

Load an amount

To add funds to a gift card or other stored-value card:

  • Make a POST request to the https://pal-test.adyen.com/pal/servlet/StoredValue/v46/load endpoint, specifying:

    • amount: The currency and value of the funds you want to store on the card. The supported currencies might differ per provider.
    • loadType: If not specified, defaults to load. Specify merchandiseReturn if the amount to add comes from goods that the shopper returned.
    • merchantAccount: ID of the merchant account that you want to process the transaction with.
    • store: Optional For transactions flagged as in-store, the ID of the physical store that you want to process the transaction for. Maximum length: 16 characters.
    • paymentMethod.type: Name or brand of the card. Accepted values: givex, svs, valuelink.
    • Other payment method details. If you tokenized a payment that the shopper made with this card, you can use the token and shopper reference. Otherwise, use fields inside the paymentMethod object.

      Without token:
      To provide payment method details when you don't have a token, specify:

      • paymentMethod.number: Card number that identifies the card that you want to load funds to.
      • paymentMethod.securityCode: Conditional If the card has a PIN code or other type of security code, obtain it from the shopper and provide it here.
      • paymentMethod.expiryMonth: Optional Expiry month of the card.
      • paymentMethod.expiryYear: Optional Expiry year of the card.
      • paymentMethod.holderName: Optional Name of the shopper that the card belongs to.

      With token:
      To provide payment method details using a token you created earlier, specify:

      • recurringDetailReference: The token. This is the recurringDetailReference returned in the response when you tokenized a payment that was made with this card.
      • shopperReference: Your unique ID for this shopper. This is the shopperReference that you used when you created the token.
      • shopperInteraction: Specifies the sales channel through which the shopper provided their details. Accepted values: Ecommerce (default for online transactions), ContAuth (online, using previously stored details), Moto (via email or telephone) or POS (using an in-store terminal).

    • 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 20 USD to an SVS gift card because the shopper returned goods to the store:

    {
        "amount": {
            "currency": "USD",
            "value": 2000
        },
        "loadType": "merchandiseReturn"    
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
        "store":"YOUR_STORE_ID",
        "paymentMethod": {
            "type": "svs",
            "number": "6006491286999921374",
            "securityCode": "1111"
        },
        "reference": "YOUR_REFERENCE"
    }

    This request adds 25 EUR to a tokenized ValueLink gift card:

    {
        "amount": {
            "currency": "EUR",
            "value": 2500
        },
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
        "paymentMethod": {
            "type": "valuelink"
        },
        "recurringDetailReference": "7219687191761347",
        "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
        "shopperInteraction": "Ecommerce",    
        "reference": "YOUR_REFERENCE"
    }

Response

You receive a response containing:

  • currentBalance: The currency and total value 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 the Customer Area, you'll find these settings under Account > API URLs.

This response shows that after adding 20 USD, the SVS gift card now has a balance of 30 USD:

{
    "currentBalance": {
        "currency": "USD",
        "value": 30000
    },
    "pspReference": "851564654294247B",
    "resultCode": "Success"
}

Next steps

See also