AccountUpdater

POST 
/AccountUpdater

This endpoint accepts a list of card data that will be checked for updated card expiration. You can pass either tokens or PANs in the data field of the request. There is a maximum of 100 cardData objects that can be included per request.

Test Card Numbers

Important Test PAN Numbers

TokenEx test PANs can be leveraged to verify that the call to the Account Updater endpoints and subsequent response codes are successful. Some of the test cards are NOT Luhn compliant and will not pass validation for tokenization. When tokenizing these test cards, please select a token scheme that does not require Luhn validation i.e. sixANTOKENfour. The requests to trigger the specific response codes are outlined in the REQUEST section.

PAN	Description
4327390068355738	Account Number Updated
4680056031099387	Account Expiration Date Updated
4207670264522669	Valid Account, No Update
4403933787254356	Account is Closed
4000220720915104	Contact Cardholder
4929423647273009	No Match
4549612182636736	Non-Participating Account

Response Code and Message Mappings

Response code	Description
801	Account Number Updated
802	Account Expiration Date Updated
800	Valid Account, No Update
803	Account is Closed
804	Contact Cardholder
805	Cardholder Opt Out
806	No Match
807	Non-participating Account
808	Error Occurred Updating Account
809	Rejected

Error cases

Error	Description
8014	Cannot update accounts. CardData items cannot exceed 100
8015	Sequence numbers must be unique for each card
8016	Connection error occurred within the chain of communication required to obtain account update. Please retry request
8017	Sequence numbers must be numeric
2100	Input data not Luhn compatible
3000	Token does not exist

Request

Header Parameters

tx-tokenize boolean

Specifies that the incoming data is a PAN and should be tokenized

tx-token-scheme stringrequired

Specifies the token scheme to be used when tokenizing

tx-account-updater-merchantid string

Specfies the merchantID to be used

tx-return-plaintext-pan boolean

Specifies that plaintext PANs should be returned if there is an Account Number Update. AllowPlainTextPan permission must be enabled to utilize this functionality.

tx-acquirer-segment-id string

Specifies which Visa region to send the request to when needed. The US and EU endpoints default to the appropriate value. The sandbox value is 2. The US Prod value is 973. The EU Prod value is 982.

application/json

Body

cardData

object[]

required

The card data to be processed

Array [

data stringrequired

The PAN to be tokenized or the token to be detokenized

Default value: 4111111111111111

expiration stringrequired

The expiration for the card in MMYY format

Default value: 1123

sequenceNumber stringrequired

The sequence number used for keeping track of which cards succeeded and which failed. Each sequenceNumber must be unique per request.

Default value: 01

]

subMerchantName string

The Sub-merchant name to be used in the request.

acquirerOrMerchantProprietaryInfo string

If provided, it contains merchant proprietary information such as a customer ID that is carried in the merchant’s back-end system

Responses

200

200

application/json

Schema

Schema

oneOf

Expiration Updated

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

updatedExpiration string

Example: 1124

message string

Example: Account Expiration Date Updated

responseCode integer

Default value: 0

Example: 802

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

No Update

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

message string

Example: Valid Account, No Update

responseCode integer

Default value: 0

Example: 800

]

referenceNumber string

Example: 23100513550514076457

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Account Number Updated

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

updatedExpiration string

Example: 1124

updatedToken string

Example: 42424aaaa2424242

responseCode integer

Default value: 0

Example: 801

message string

Example: Account Number Updated

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Account is Closed

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 803

message string

Example: Account is Closed

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Contact Cardholder

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 804

message string

Example: Contact Cardholder

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Cardholder Opt Out

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 805

message string

Example: Cardholder Opt Out

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

No Match

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 806

message string

Example: No Match

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Non-particpating Account

cardData

object[]

Array [

success boolean

Default value: true

Example: true

sequenceNumber string

Example: 01

token string

Example: token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 807

message string

Example: Non-particpating Account

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Error Occurred Updating Account

cardData

object[]

Array [

success boolean

Default value: true

Example: false

sequenceNumber string

Example: 01

token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 808

message string

Example: Error Occurred Updating Account

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Rejected

cardData

object[]

Array [

success boolean

Default value: true

Example: false

sequenceNumber string

Example: 01

token

expiration string

Example: 1123

responseCode integer

Default value: 0

Example: 809

message string

Example: Account Number contains non-numeric characters or is blank

]

referenceNumber string

Example: 2201291553541132129

success boolean

Default value: true

Example: true

error string

Example:

message string

Example:

Example (from schema)

{}

Expiration Updated

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "updatedExpiration": "1124",
      "message": "Account Expiration Date Updated",
      "responseCode": 802
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

No Update

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "message": "Valid Account, No Update",
      "responseCode": 80
    }
  ],
  "referenceNumber": "23100513550514076457",
  "success": true,
  "error": "",
  "message": ""
}

Account Number Updated

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "updatedExpiration": "1124",
      "updatedToken": "42424aaaa2424242",
      "responseCode": 801,
      "message": "Account Number Updated"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Account is Closed

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "responseCode": 803,
      "message": "Account is Closed"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Contact Cardholder

{
  "cardData": [
    {
      "success": "true,",
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "responseCode": 804,
      "message": "Contact Cardholder"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Cardholder Opt Out

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "responseCode": 805,
      "message": "Cardholder Opt Out"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

No Match

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "responseCode": 806,
      "message": "No Match"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Non-particpating Account

{
  "cardData": [
    {
      "success": true,
      "sequenceNumber": "01",
      "token": "token",
      "expiration": "1123",
      "responseCode": 807,
      "message": "Non-particpating Account"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Error Occurred Updating Account

{
  "cardData": [
    {
      "success": false,
      "sequenceNumber": "01",
      "token": null,
      "expiration": "1123",
      "responseCode": 808,
      "message": "Error Occurred Updating Account"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Rejected

{
  "cardData": [
    {
      "success": false,
      "sequenceNumber": "01",
      "token": null,
      "expiration": "1123",
      "responseCode": 809,
      "message": "Account Number contains non-numeric characters or is blank"
    }
  ],
  "referenceNumber": "2201291553541132129",
  "success": true,
  "error": "",
  "message": ""
}

Loading...