Check the balance of a gift card

The /checkBalance endpoint of our Stored Value API lets you view the remaining balance on a gift card or other type of stored-value card.

Transaction per provider and channel

Check the balance

When you view the balance remaining on 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 see the value of a gift card or other stored-value card that has not been tokenized:

• Make a POST request to the /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 object with:

    • type: Name or brand of the card. Accepted values: givex (only for in-person payments), 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: Optional Expiry month of the card.
    • expiryYear: Optional Expiry year of the card.

    • holderName: Optional Name of the shopper that the card belongs to.

  • 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 an SVS gift card:

  {
      "merchantAccount": "ADYEN_MERCHANT_ACCOUNT",
      "store":"YOUR_STORE_ID",
      "paymentMethod": {
          "type": "svs",
          "number": "603628672882001915092",
          "securityCode": "5754"
      },
      "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 your Customer Area, you'll find these settings under Developers > Additional data.

Sample response:

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

Next steps

See also