Activate or deactivate a gift card

The /changeStatus endpoint of our Stored Value API lets you 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.
There's no need to activate virtual cards: they are activated automatically when you issue them.
You can activate plastic cards with or without specifying an amount that you want to load to the card. If you do not 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 cannot be used again. Any value remaining on the card is no longer available to the shopper.

Transactions per provider and channel

Online

Transaction	Givex	SVS	Fiserv (formerly ValueLink)	Intersolve
Activate
Activate and load amount
Deactivate (without amount)

In-person payments

Transaction	Givex	SVS	Fiserv (formerly ValueLink)	Intersolve
Activate
Activate and load amount
Deactivate (without amount)

Activate a card

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

• Make a POST request to the /changeStatus endpoint endpoint, specifying:

  • status: active

  • amount:

    Optional
    The currency and value of the funds you want to load to the card. The supported currencies differ per provider.
    When activating a preloaded card, do not specify an amount or exactly specify the preloaded amount.

  • merchantAccount: Name of the merchant account that you want to process the transaction with.

  • store:

    Optional
    Only applicable to in-person payments. 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, svs, valuelink, any Intersolve-supported card type.
    • number: Card number that identifies the card that you want to activate.
    • 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 activates an SVS gift card and loads USD 10 to the card:

  {
      "status": "active",
      "amount": {
          "currency": "USD",
          "value": 1000
      },
      "merchantAccount": "ADYEN_MERCHANT_ACCOUNT",
      "store":"YOUR_STORE_ID",
      "paymentMethod": {
          "type": "svs",
          "number": "6006491286999921374",
          "securityCode": "1111"
      },
      "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 your Customer Area, you'll find these settings under Developers > Additional data.

Sample response:

{
    "currentBalance": {
        "currency": "USD",
        "value": 1000
    },
    "pspReference": "851564652149588K",
    "resultCode": "Success"
}

Deactivate a card

When you deactivate 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.

Next steps

See also