Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Activate or deactivate a gift card

Learn how to activate or deactivate a gift card or other stored-value card.

With a /changeStatus call to our Stored Value API, you can activate or deactivate a gift card or other stored value card and optionally load funds to it while activating.

Activate

Changing the status to active makes the funds stored on the card available to the shopper.
You can activate with or without specifying an amount that you want to load to the card. If you don't add an amount now, you can do so later with a /load request. Some providers load funds to the card when it is issued. When you activate such a preloaded card, you either do not specify an amount, or exactly specify the preloaded amount.

Deactivate

Changing the status to inactive is something you'd do when you suspect fraud, for example when the gift card is lost or stolen. This is an end state, a deactivated card can't be used again. Any value remaining on the card is no longer available to the shopper.

Support

Not all transactions are applicable for all providers and channels.

There's no need to activate virtual cards: they are activated automatically when you issue them.

Web channel

Transaction Givex SVS ValueLink
Activate -x- -x- -x-
Activate and load amount -x- -x- -x-
Deactivate (without amount) -white_check_mark- -x- -x-

POS channel

Transaction Givex SVS ValueLink
Activate -white_check_mark- -white_check_mark- -white_check_mark-
Activate and load amount -white_check_mark- -white_check_mark- -white_check_mark-
Deactivate (without amount) -white_check_mark- -x- -x-

Request a status change

To activate or deactivate a gift card or other stored-value card:

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

    • status (string): The new status that the card should get. Accepted values: active or inactive.
    • amount: Optional When activating, this contains the currency and value of the funds you want to load to the card. The supported currencies might differ per provider.
      When activating a preloaded card, do not specify an amount or exactly specify the preloaded amount.
      When deactivating, do not specify an amount.
    • 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 are deactivating the card, it is possible that the shopper made a payment with it and that you tokenized this payment. If so, you can use the token to provide payment method details. 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 activate or deactivate.
      • 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 activates an SVS gift card and loads 10 USD to the card:

    {
        "status": "active",
        "amount": {
            "currency": "USD",
            "value": 1000
        },
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
        "store":"YOUR_STORE_ID",
        "paymentMethod": {
            "type": "svs",
            "number": "6006491286999921374",
            "securityCode": "1111"
        },
        "reference": "YOUR_REFERENCE"
    }

    This request deactivates a tokenized Givex gift card:

    {
        "status": "inactive",
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
        "store":"YOUR_STORE_ID",
        "paymentMethod": {
            "type": "givex",
        },
        "recurringDetailReference": "7219627091701347",
        "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_P3fW3k9D2tvXFu6l",
        "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 status change has been carried out. Refer to Result codes for other 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": "USD",
        "value": 1000
    },
    "pspReference": "851564652149588K",
    "resultCode": "Success"
}

Next steps

See also