Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

Load funds to a gift card

Add funds to a gift card at the point of sale.

You can add funds to an activated gift card by making a load request.

Before you begin

Before you make any gift card transactions, make sure that you have:

Make a load request

To load a balance to a gift card:

  1. Determine the card entry method:
    • If you want to scan the card, do that first and use the obtained card details in your request.
    • If you want to swipe the card or use manual keyed entry (MKE), send the request first. The payment terminal will show a prompt to swipe the card or enter the card details.
  2. Make a POST request to a Terminal API endpoint, specifying:

    • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. This includes:
      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Service
      MessageCategory -white_check_mark- StoredValue
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
    • StoredValueRequest.SaleData. This includes:

      Parameter Required Description
      SaleTransactionID.TransactionID -white_check_mark- Your reference to identify this load request. We recommend using a unique value.
      SaleTransactionID.TimeStamp -white_check_mark- Date and time of the request, in UTC format.
      SaleToAcquirerData Optional, for Stored Value Solutions (SVS) gift cards: ssc. This is the secondary security code of the gift card, and allows up to 8 digits. For example, ssc=1111.
    • StoredValueRequest.StoredValueData. This includes:

      Parameter Required Description
      StoredValueTransactionType -white_check_mark- Load
      StoredValueData.ItemAmount -white_check_mark- The value of the balance you are loading to the gift card.
      StoredValueData.Currency -white_check_mark- The currency you are loading to the gift card.
      StoredValueAccountID -white_check_mark- The gift card details:
      • StoredValueAccountType: GiftCard
      • StoredValueProvider: the gift card issuer: givex, svs, valuelink, or any Intersolve-supported card type.
      • IdentificationType: PAN
      • EntryMode, StoredValueID and ExpiryDate: these parameters depend on the card entry method you are using.
      Card entry Parameters
      • EntryMode: Scanned
      • StoredValueID: gift card number.
      • ExpiryDate: expiry date of the gift card.
      • EntryMode: MagStripe
      • StoredValueID: include this parameter but don't provide a value.
      • EntryMode: Keyed
      • StoredValueID: include this parameter but don't provide a value.

    The example below shows how to load 15.00 GBP to a scanned gift card.

    String serviceID = "YOUR_UNIQUE_ATTEMPT_ID";
    String saleID = "YOUR_CASH_REGISTER_ID";
    String transactionID = "YOUR_UNIQUE_TRANSACTION_ID";
    SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
    MessageHeader messageHeader = new MessageHeader();
    messageHeader.setMessageClass( MessageClassType.SERVICE );
    messageHeader.setMessageCategory( MessageCategoryType.STORED_VALUE );
    messageHeader.setMessageType( MessageType.REQUEST );
    StoredValueRequest storedValueRequest = new StoredValueRequest();
    SaleData saleData = new SaleData();
    TransactionIdentification saleTransactionID = new TransactionIdentification();
    saleTransactionID.setTimeStamp(DatatypeFactory.newInstance().newXMLGregorianCalendar(new GregorianCalendar()));
    StoredValueData storedValueData = new StoredValueData();
    storedValueData.setStoredValueTransactionType( StoredValueTransactionType.LOAD );
    StoredValueAccountID storedValueAccountID = new StoredValueAccountID();
    storedValueAccountID.setStoredValueAccountType( StoredValueAccountType.GIFT_CARD );
    storedValueAccountID.setIdentificationType( IdentificationType.PAN );
    storedValueAccountID.getEntryMode().add( EntryModeType.SCANNED );
    storedValueData.setItemAmount( BigDecimal.valueOf(10) );

The request to load a balance to the gift card is sent to the Adyen payments platform for processing.

Load response

Once processed, your integration receives a result indicating whether the balance was loaded to the gift card.This is provided in a synchronous API response, unless your integration uses asynchronous cloud communications.

If your integration uses asynchronous cloud communications, you receive the response as an event notification.

If funds were successfully loaded to the gift card:

  • You receive a response that contains a StoredValueResponse object. This includes:

    • POIData.POITransactionID.TransactionID: Transaction identifier for the funds being loaded to the gift card.

    • StoredValueResult:

      • StoredValueTransactionType: Load
      • ItemAmount and Currency: current value and currency associated with the card.

    • PaymentResponse.Response.Result: Success

    The example below indicates that 15.00 GBP was successfully loaded to the gift card.


Next steps

See also