Introduction to APIs

API General Message Layout and Requirements

API Message Format

About the Response to the User

About Response Time

Back Office Web Access

Currency Amounts and Conversion Instructions

PIN Encryption

Alternatives to Using Card Number in the CardAPI

API User Credentials

CardHolder API’s

Change Card Status – Function 004

Change Card PIN – Function 005

Deposit to Card Number – Function 007

Message Response Lookup – Function 008

View Statement Details by Card Number – Function 010

Validate PIN – Function 012

Set Card PIN – Function 022

Get Card Status – Function 023

Get Card Account Balance – Function 024

Cardholder Fees – Function 030

Adjustment – Function 031

Card Linking – Function 032

Card Inquiry – Function 033

Cash Out – Function 034

Card to Card Transfer – Function 035

Update Cardholder – Function 036

PIN Reset – Function 037

PIN Request – Function PINRequest

View Statement Details by Account Number – Function 039

Unlock Bad PIN Tries – Function 040

Set Condition Check for Existing Cardholder – Function SetCondCheck

Manage MCC Blocks – Function MCCBlock

Set Cardholder Level Limit – Function CardLimit

Get Configurable Card Limits – Function GetCardLimits

OFAC Check – Function 056

View Statement Details by Card Number (V2) – Function 070

3DS Enrolment Control – Function THREEDS

3DS Whitelist Management – Function Manage3DSWhitelist

Card Risk Level API Calls

Update Card Risk Level – Function = UpdateRiskLevel

Get Card Risk Level – Function = GetRiskLevel

Instant Card Issue – Function = InstantCardIssue

Specialized Financial Transactions

Validate Cardholder Verification Data – Function ValidateCVV2

Get Dynamic CVV (CVV3) – Function GetCVV3

General Web APIs

Change Password – ChangePswd

Message Heart Beat – Function 025

Wallet API Functions

Create Wallet for Existing Cardholder – Function CreateCardholderWallet

Create Wallet Multi-Currency Card Purse – Function CreateCardPurse

Retrieve Card Purse Identification from Wallet – Function GetCardPurses

Multi-currency Card Purse to Purse Transfer – Function PurseFundsTransfer

Processing Codes


Transaction Processing Codes

Response Codes

Card/Account Type Definitions

API Error Codes


PIN Request – Function PINRequest

A PINRequest results in card related data being sent to a card vendor in a file. The Card vendor in turn forwards PIN information to the cardholder.

There are 2 ways to issue a pin request through the AE CardAPI:

1. Place “PR” in parameter P25 in function 036.

2. Use the API function “PINRequest.”

Currently the function 036 makes no effort to handle any errors from a pin request service call. It will simply continue to process the cardholder update returning a positive response if the update was successful. It is best to use API function PINRequest over 036 to request a PIN.

Inputs Description Required Data Type
FunctionID PINRequest Y
P1 Primary Account Number Y (16,19) numeric
Outputs Description
P1 Error Code Y
P2 Error Text Y
Example: PINRequest
dassignedtome&FUNC=PINRequest&MSGID=00001489067437827&P1=PAN or AlT ID
Example: PINRequest Response
P1=0000&P2=PIN Request Successful
P1=620&P2=PIN RequestClient Error = (ERROR DETAILS GO HERE)
Example: P1=6201&P2=PIN RequestClient Error = Authorization Failed
The Authorization Failed (highlighted above for emphasis) error is returned when the user is not configured with a role that supports the use of pin requests.
P1=090&P2=Inadequate permissions to execute this function.
The above error is referencing that the API user does not have the PINRequest function assigned. Another significant error that may come from the service is:
P1=6201&P2=PIN RequestClient Error = Cannot process Pin Request – CardHolder address has recently changed
The service checks if there has been a recent address change. If there has the service will not send the pin. This was a business requirement implemented to protect the pin. It also reinforces the need to use the API function PINRequest over function 036 since any minor change may result in the appearance of change.