Alternatives to Using Card Number in the CardAPI
Beginning with AE CardAPI version 4.15 API users may use several other customer identifiers in place of card number. A flag value must be placed in front of the identifier to indicate the location or type of information used.
ALTID FLAG | ALTERNATE ID VALUE USED |
---|---|
A | Account ID |
B | Partial Last Name + Account ID |
C | Partial Card Number |
N | Cardholder ID |
I | Cardholder ID – internal format |
S | Person ID (SSN) |
All API users may use alternate ids in place of card number. In some cases, users may be restricted to use only alternate ids. The alternate ids that may be used must be defined within the user configuration table as illustrated below.
NAME | VALUE |
ALTID | A,S |
This indicates that the user may submit account id or personal id in place of a card number.
Additionally, with ALTID set this user cannot submit a card number or any other identifier.
The API has been modified so that the alternate id will be returned in place of card number in those responses where card number is part of the normal response.
When a user attempts to use any ID other than one allowed the user will receive the following message.
P1=090&P2=Inadequate permissions to execute this alternate ID
It is important for users who use the alternate IDs to create ID numbers that are relatively unique. For example, when using DDA Account IDs the number should include elements like ABA number with account number. This is because many of the values that may be used are not currently validated to be unique within the system. In the event the system detects a number that is not unique the system will return
P1=5100&P1=AltID Anyaccountid not unique. Note that other data combination may be possible.