Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Check the balance of a gift card

Learn how to view the value of a gift card or other stored-value card.

With a /checkBalance call to our Stored Value API, you can view the remaining balance on a gift card or other type of stored-value card.

Support

Web channel

Transaction Givex SVS ValueLink
Check balance -white_check_mark- -white_check_mark- -white_check_mark-

POS channel

Transaction Givex SVS ValueLink
Check balance -white_check_mark- -white_check_mark- -white_check_mark-

Check the balance

To see the value of a gift card or other stored-value card:

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

    • 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 see the balance of.
      • 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 checks the balance on a Givex gift card:

    {
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
        "store":"YOUR_STORE_ID",    
        "paymentMethod": {
            "type": "givex",
            "number": "603628672882001915092",
            "securityCode": "5754"
        },
        "reference": "YOUR_REFERENCE"
    }

    This request checks the balance on a tokenized ValueLink gift card:

    {
        "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 in minor units 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. 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.

Sample response:

{
    "currentBalance": {
        "currency": "EUR",
        "value": 5600
    },
    "pspReference": "881564657480267D",
    "resultCode": "Success"
}

Next steps

See also