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

Statements

Transaction Processing Codes

Response Codes

Card/Account Type Definitions

API Error Codes

FAQs


Message Response Lookup – Function 008

Function 008 retrieves the response to a previous message request submitted by an API user.

This function was created expressly to address situations where the response was not successfully returned to the user. A response may not be returned because the client timed out or because there was a network interruption.

This function should be used when you do not receive a response to a previous request, especially a request that impacts the card balance.

To properly implement this function all MSGID values should be submitted as a unique value. We recommend the use of a global unique ID (GUID) for all messages that will not be forwarded to a
remote API. Additionally, this feature must be enabled within the User API Configuration. The CardAPI will not return a valid response if the credentials do not match, and if an MSGID does not match a previously processed MSGID.

When properly configured, the system will return the response associated with the MSGID identified.

Inputs Description Required Data Type
FunctionID 008 Y
P1 Previously Sent MSGID Y (16,32) alphanumeric
Outputs Description
Refer to documentation of the API call associated with the response message
Example
https://api.m2fin.com:8443/AuthENGINAPI/AuthENGINAPI?CID=5&CUSR=mcourtoy&CPWD=t3$t1ng&FUNC
=008&MSGID=00001012300000023&P1=00005009237171925
Example
Response when original request was Get Card Status – Function 023 and MSGID = 00005009237171925: P1=0000&P2=&P3=1
P1=063&P2=Could not find a response for Message ID:00005009237171924
NOTE THAT IF YOU DO NOT INCREMENT MSGID YOU WILL GET THE LAST MSGID FOUND BY THE SYSTEM FOR THE USER SUBMITTING THIS REQUEST.
A USER CANNOT ACCESS THE RESPONSE OF ANOTHER USER.