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


Update Cardholder – Function 036

Function 036 allows you to update your cardholder record. This call is generally used when your cardholder details are changed due to cardholder relocating to a new address or when wrong information was entered for the cardholder to begin with.

Inputs Description Required Data Type
FunctionID 036 Y
P1 First Name Y (1,20) varchar
P2 Middle Initial * Y (1,1) varchar
P3 Last Name Y (1,20) varchar
P4 Address1 Y (1,30) varchar
P5 Address2 * Y (1,30) varchar
P6 City Y (1,25) varchar
P7 State Y (1,30) varchar
P8 Zip Code Y (5,15) varchar
P9 Country Code (ISO 3166) Y (2) varchar
P10 Client Card Holder ID N (1,32) varchar
P12 Phone Y (7,15) varchar
phone2 Phone 2 *Phone2 (Mobile Phone) is required for programs which are enrolled for MasterCard 3DS through DPG. N* (7 -32) varchar
P13 PAN OR ALT ID Y (16,19) Numeric
P14 Security Field 1 can include mother’s maiden name or license number * N (1,22) varchar
P15 Security Field 2 can include mother’s maiden name or license number * N (1,22) varchar
P16 Email N (1,40) varchar
P17 User defined field1. It handles special requirements for the client * N (1,16) varchar
P18 User defined field2. It handles special requirements for the client * N (1,16) varchar
P19 Social Security Number N (1,9) varchar
P20 Distributor Code * N (1,8) varchar
P21 Load Amount N Numeric
P22 Company Name * N (1,38) varchar
P23 Card Style N (1,2) varchar
P24 Expiration Date N (1,4) varchar YYMM
P25 Delivery Type N (1,2) varchar
P26 OFAC Override N “Y” to override
P27 VerifySSN Override N “Y” to override
P28 VerifyDOB Override N “Y” to override
Remote_Host IP address of the remote host N IP address. Used for
velocity checks.
P29 Other ID Type
Used when passing personal IDs other
than SSN. Will override P19 value.
Identify ID type using:
SSN (Social Sec Number)
ITIN (Individual Tax ID)
ATIN (Adoption Tax ID)
N varchar(80)
If a valid value is not
provided associated
data will be skipped.
P30 ID Number N (1,80) varchar
P31 ID Issuer N (1,80) varchar Identify
the country or
state that issued the ID
P32 DDA Account Number – This value is a
bank account number. This field may be
used to override the system generated
account number. Also utilized for ACH **
N (1,19) varchar
P33 DDA Routing Number ** N (1,12) varchar
P34 DDA Validate ** N
P35 Bank Account Type N Allowable Values:
Language Acceptable inputs:
N varchar
3DS Security question:
SQ – Security Question
SA – Security Answer
*Please see 3DS note on formatting below
N varchar
Outputs Description
P1 Error Code Y
P2 Error Text Y

Note: OFAC check function (‘056’) may be optionally executed for this function. If you are configured for Automated OFAC Checking, then any create card request will automatically check OFAC. If an OFAC Match is found, the Create Card Holder request will not be processed.

* Middle Initial, Address2, Security Field 1, Security Field 2, User Defined Field 1, User Defined Field 2, Distributor Code, or Company Name you can blank out the field using either two double quotes without a space between them, “”, or the word BLANK.

If you try to blank out First Name, Last Name, Address 1, City, State, Zip Code, Country Code, Phone, Email or SSN you will now get the following error.

P1=008&P2=A required field can only be updated it can’t be blanked out

Note that for now you can try to blank Personal ID. It will not return an error if you try, but if you do try the update will be simply ignored.

If you attempt to blank out other fields using the work BLANK or “” the value will replace whatever is there.

** ACH processing: When both values are present and the cardnumber starts with 2, micro-validation initiates.

3DS Question Formatting:
URL Safe Base64 Encoded Question:
What was the color of your first car?
3DS Answer Formatting:
All uppercased, SHA256 hashed, URL Safe Base64 Answer: