Search

Are you looking for test card numbers?

Would you like to contact support?

Feature icon

Batch Account Updater

Learn how you can update card information through the Batch Account Updater.

With Batch Account Updater, you can send batch files to request updates for your shoppers' cards. We request the updates from Visa and Mastercard, and receive the new shopper card information. On receiving the updates, we send the batch response file with the new card details to you.

To update shopper card details through the Batch Account Updater:

  1. Send a batch request file.
  2. Receive the response in the batch file.
  3. Update the card details through a payments request.

Send batch request files and receive the response

You need to have the SFTP server set up to send and receive the batch files.

The process of sending a batch request file and receiving updates in the result file work as follows:

  1. Generate a batch file in the request and upload it to your SFTP directory.
  2. After receiving the batch request file, we run validation checks and generate a batch acknowledgement file (ACK). You can find the results of the validation check in this ACK file.
  3. Once the request files are successfully validated, we request the updated card information from Visa and Mastercard and add the updated information to a batch result file.
  4. Fetch the batch result file to retrieve the updated card information.

The following is an Account Updater batch request file:

    FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,AccountUpdater,FileHeaderEchoData
    BH,1,BlockHeaderEchoData
    L,1,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference1,EchoData1
    SL,1,AccountUpdaterSingle,4111111111111111,06,2016,737,CardHolderName,,,
    L,2,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference2,EchoData2
    SL,1,AccountUpdaterSingle,5444444444444444,03,2017,,CardHolderName,,,
    L,3,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference3,EchoData3
    SL,1,AccountUpdaterRecurring,ShopperReference3,LATEST
    L,4,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference4,EchoData4
    SL,1,AccountUpdaterRecurring,ShopperReference4,LATEST
    L,5,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference5,EchoData5
    SL,1,AccountUpdaterSingle,4444111111111111,11,2015,737,CardHolderName,,,
    L,6,MerchantAccount,TestMerchant,AccountUpdater,MerchantReference6,EchoData6
    SL,1,AccountUpdaterSingle,5444111144444444,01,2018,,CardHolderName,,,
    BT,6
    FT,1

The following is a sample Account Updater batch response file:

    FH,1.0,TEST,Company,TestCompany,Default,1,ws@Company.TestCompany,AccountUpdater,FileHeaderEchoData
    BH,1,BlockHeaderEchoData
    L,1,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference1,Success,EchoData
    SL,1,AccountUpdaterResult,MerchantReference1,Submitted,NoChange,2013-11-13,,,,,
    L,2,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference2,Success,
    SL,1,AccountUpdaterResult,MerchantReference2,Submitted,CloseAccount,2013-11-13,,,,,
    L,3,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference3,Success,EchoData
    SL,1,AccountUpdaterResult,MerchantReference3,Submitted,PANChanged,2013-11-13,D123456789123456,07,2018,,
    L,4,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference4,Success,EchoData
    SL,1,AccountUpdaterResult,MerchantReference4,Submitted,CardExpiryChanged,2013-09-15,F098765432112345,03,2017,,
    L,5,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference5,Success,EchoData
    SL,1,AccountUpdaterResult,MerchantReference5,Submitted,Error,2013-09-15,,,,,
    L,6,MerchantAccount,TestMerchant,ScheduleAccountUpdater,MerchantReference6,Success,EchoData
    SL,1,AccountUpdaterResult,MerchantReference6,Not Submitted,Error,,,,,No registered account,
    BT,6
    FT,1

If you're tokenizing with Adyen, when using Account Updater to refresh card information, you will receive the updates to the card in the batch result file. The token will always stay the same. You need to handle the updates that you find in the batch result file.

If you're not tokenizing with Adyen, you can obtain the changes through the batch result file and then make the relevant changes accordingly.

Use APIs to request account updates

You can use our /scheduleAccountUpdater API to receive account updates for a single card. You can send either:

  • Credit card information: Fields in the card object are mandatory.
  • Adyen token and shopper reference: shopperReference and selectedRecurringDetailReference are mandatory.

The account update request is forwarded to Visa and Mastercard. The actual result is included in the /listRecurringDetails response or in the Account updater batch result file.

The following code sample shows an account update request made with card data:

{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "reference": "YOUR_REFERENCE",
  "card": {
    "expiryMonth": "10",
    "expiryYear": 2020,
    "holderName": "Adyen Test",
    "number": "4111111111111111"
  }
}

The response for the account update request is as follows:

{  
  "pspReference":"8313547924770610",
  "result":"Success"
}

The following code sample shows an account update request made with token data:

{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "reference": "YOUR_REFERENCE",
  "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  "selectedRecurringDetailReference": "8814232895168272"
}

Account Updater statuses

When we perform an account update, we send a status in the batch result file. It indicates what action you need to take next based on what changed in the card details.

Status Alternative values for the status Description
NoChange
  • EitherExpiryChangedOrNoChange
  • InvalidAmount
  • TxInvalid
  • RecordIdentifierInvalid
  • BinNotParticipating
  • CreditCardNumberInvalid
  • CreditCardNumberNotFound
  • IssuerNotSubscribed
  • NoMatchFound
  • UnknownResponseCodeProvided
  • GenericTokenUseError
  • InvalidCreditCard
  • InvalidExpirationDate
  • MerchantIsNotAuthorisedToUseTokens
  • TokenIsInvalid
  • TokenWasNotFound
The card has not changed.
CloseAccount
  • CloseAccount
  • CloseAccountThisAccountOnly
The account has been permanently closed by the issuing bank.
PANChanged
  • CardChanged
The account number has changed.
CardExpiryChanged The expiry date of the card has changed.
ContactCardAccountHolder (Visa only) The card has a new account number, expiry date, or both, but the shopper has requested that the issuer not share updated card details.
Error
  • MerchantIdInvalid
  • MerchantIdNotEnabled
Our Account Updater request process experienced an error.

Update old card details

There are three scenarios that can occur as a result of an account update.

No updates on the card

If there are no updates on the card, you don't need to take any further actions and all the card details remain unchanged.

Card details are updated

You can receive updates of the following information on your shoppers' cards:

  • Expiry date of the card
  • Card number
  • Both expiry date of the card and card number

You can update these details in the same way as you would update token details.

The following example shows how you can update a card number with a new alias and card expiry from a batch result file. Make sure that you include the new alias in the paymentMethod.number field.

{
  "amount": {
    "currency": "USD",
    "value": 1000
  },
  "reference": "YOUR_PAYMENT_REFERENCE",
  "paymentMethod": {
    "storedPaymentMethodId": "8415693365216824",
    "number": "A549761438794558",
    "expiryMonth": "10",
    "expiryYear": "2020"
  },
  "returnUrl": "https://your-company.com/...",
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  "shopperInteraction":"ContAuth"
}

Card details are disabled

You can get an update that certain cards have been disabled. This can occur if the card is reported as stolen, or if the shopper called the bank to inform them that they no longer authorise transactions from you. We don't disable the storedPaymentMethodId or recurringDetailReference. Instead we provide the update to you, and you need to disable the card details.

Check how to remove card details that have been disabled.

Get a report on card updates

The Account Updater results report shows a summary of Account Updater results from a particular period of time. Use this report to check the outcomes and statuses of account update requests, and get a summary of both Real Time Account Updater and Batch Account Updater results. You can also analyze the fees charged for the Account Updater.

See also