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



Application Programming Interfaces (APIs) are the mechanism through which two systems can communicate with each other. They make processes more independent and allow components to be weaved together to create an automated workflow and a better user experience.

Consumers and businesses are rapidly incorporating web and mobile apps into their daily routines. Innovators are discovering valuable new uses for previously isolated data sources. Digital Payments Group (DPG) APIs enable our innovative clients to put that data to use for their own financially embedded products.

This section of the website is intended to familiarize users with the Digital Payments Group (DPG) API suite for AuthENGIN (AE) CardAPI.

The AE CardAPI is a robust and scalable card issuing and management system designed to allow users to successfully launch and manage a variety of card products. It is designed to allow users to submit real-time HTTP GET requests to manage cardholder data over the Internet. Requests are submitted to the AE CardAPI using a standard HTTPS interface. Upon receipt of a response, the user can then translate or reformat the response as they see fit.

The AE CardAPI permits the following actions to be performed against the AE platform:

  • Create cardholder.
  • Associate cardholder with a card.
  • Deposit and withdraw funds to/from a card.
  • Change, set, and request PINs.
  • Obtain and change cardholder status.
  • Get cardholder statement including ATM and POS transaction history.
  • Obtain cardholder balances.