Are you looking for test card numbers?

Would you like to contact support?

Default icon

Manage tokens

Learn how to manage tokens you stored with Adyen.

You can use the Checkout API to:

List stored payment details

To see all the payment details saved for a shopper, make a POST /paymentMethods request including:

Parameter Description
merchantAccount Your merchant account name.
shopperReference Your unique identifier for the shopper. 
{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "shopperReference": "YOUR_UNIQUE_SHOPPER_ID",
  "countryCode": "GB",
  "amount": {
    "currency": "GBP",
    "value": 1000
  }
}

The storedPaymentMethods array in the response includes:

Parameter Description
id The storedPaymentMethodId value that you need to make payments with the shopper's stored payment details.
recurringProcessingModel Defines the type of recurring payment that the stored payment details can be used for. 
{
    "storedPaymentMethods": [
        {
            "brand": "visa",
            "expiryMonth": "10",
            "expiryYear": "2020",
            "holderName": "SHOPPER_NAME",
            "id": "8415890871952836",
            "recurringProcessingModel":"Subscription",
            ...
        }
    ]
}
{
    "storedPaymentMethods": [
        {
            "brand": "visa",
            "expiryMonth": "10",
            "expiryYear": "2020",
            "holderName": "SHOPPER_NAME",
            "id": "8415890871952836",
            ...
        }
    ]
}

Update stored details

You can update the following fields without changing the storedPaymentMethodId of the stored payment details:

Field Description
expiryMonth The expiry month.
expiryYear The expiry year.
holderName The cardholder's name.

If the shopper has a new card number, make a /payments request to store new payment details and receive a new identifier.

To update the expiryMonth, expiryYear, or holderName, make a /payments request including:

Parameter Description
amount.value 0
storedPaymentMethodId The token with the stored payment details.
shopperReference Your unique identifier for the shopper.
merchantAccount Your merchant account name.
shopperInteraction Defines the type of shopper interaction that the stored payment details can be used for.

Also include at least one of the fields you want to update:

Parameter Description
expiryMonth The expiry month.
expiryYear The expiry year.
holderName The cardholder's name.

For example, to update the cardholder's name in the previous example, make a /payments request including the required fields and paymentMethod.holderName:

{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "shopperReference": "YOUR_UNIQUE_SHOPPER_ID",
  "amount": {
    "currency": "GBP",
    "value": 0
  },
  "paymentMethod": {
      "storedPaymentMethodId":"8415890871952836",
      "holderName": "NEW_SHOPPER_NAME"
  },
  "shopperInteraction": "ContAuth"
}

Updates from card networks

Card networks (for example, Visa and Mastercard) also send updates to your shopper's payment details. The way these updates are handled depends on the Account Updater service you use.

  • If you are using our Real Time Account Updater, you do not have to do anything to handle the updates from the card networks. The card details are automatically updated, and the token remains unchanged.
  • If you are using our Batch Account Updater, then you will receive the updated card details in a batch result file. You then need to make a zero-value transaction with the updated card details.

Disable stored payment details

You can either delete one token with the shopper's stored payment details or all the shopper's stored payment details.

To delete a single token, make a DELETE /storedPaymentMethod request including:

Parameter Description
merchantAccount Your merchant account name.
shopperReference Your unique identifier for the shopper.
recurringDetailReference The token you want to delete. 
{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "shopperReference": "YOUR_UNIQUE_SHOPPER_ID",
  "recurringDetailReference": "8313147988756818"
}

To delete the shopper's unique identifier and all the stored payment details, make a DELETE /storedPaymentMethod request including:

Parameter Description
merchantAccount Your merchant account name.
shopperReference Your unique identifier for the shopper. 
{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "shopperReference": "YOUR_UNIQUE_SHOPPER_ID"
}

After you make delete the payment details stored with Adyen, you must also delete any remaining shopper details from your servers.

See also