Category links

API Links

Authorizations

An authorization is meant  to get approval to hold the funds on a card account. Generally, an authorization request is received via the card network when the cardholder uses the card at a merchant location (Store, ATM, Online) however there are situations in which you can initiate an authorization request manually by providing key elements to get an approval code. By doing so the authorized funds are put on hold and decrease the available balance in the card account.

GetClearing

Action: POST

Endpoint: /api/GetClearing

POST /api/GetClearing

Use this API to post Debit or credit adjustments to account. If due to any check transction is declined then force post option can be used to bypass the check.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

19

BranchCode

string

Optional

Branch code from where the card was issued. Valid Values:0-9 Example:1006

Allowable Values:

20

TransactionCode

string

Mandatory

This tag indicates the transction code that is displayed after a transaction is executed. Example: ABC14433222

Allowable Values:

20

TransactionAmount

decimal

Mandatory

Transaction Amount Valid Values: 0-9 Example:100.11

TransactionCurrencyCode

string

Mandatory

Transaction Currency Code Valid Values:0-9 Example:840 Please Refer Appendix Section: Primary Currency Code

Allowable Values:

3

Notes

string

Optional

Notes entered by the user Valid Values : A-Z,0-9 Example : Card found

Allowable Values:

2000

NotesReason

string

Optional

PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

5

TransactionReference

string

Conditional

Transaction ID of the transaction which needs to be reversed or adjustment is posted against that transaction Condition: It must contain TransactionID of the Original transaction when CMTTranType is either 38,35 or 43. For other CMTTranType it should be Null.

Allowable Values:

19

AllowForcePost

string

Optional

Reserved for future use

Allowable Values:

1

RetrievalReferenceNumber

string

Optional

Indicates unique reference number throughout the system. Example: 012541

Allowable Values:

12

WalletID

Int32

Optional

Wallet ID of wallet mapped on account Valid values:0-9 Example:1005 Condition: Mandatory when card product supports MCC wallets.

CardAcceptorNameLocation

string

Optional

Name and location details of merchant Valid Values: a-z A-Z Example: Dental merchant, Nashua

Allowable Values:

40

Sample Request Body
{
  "APIVersion": "1.5",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066846120012785",
  "ProxyNumber": "1316608",
  "BranchCode": "",
  "TransactionCode": "37",
  "TransactionAmount": 11.0,
  "TransactionCurrencyCode": "840",
  "Notes": "abcd",
  "NotesReason": "10",
  "TransactionReference": "",
  "AllowForcePost": "",
  "RetrievalReferenceNumber": "",
  "WalletID": 0,
  "CardAcceptorNameLocation": "Nashua"
}
Response Fields Detail
Fields Description

TransactionID

string

Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369

AvailableBalance

string

In case of the non wallet product, account available balance will be returned whereas in case of the multi wallet product, wallet available balance will be returned. Valid Values: 0-9 Example: 52.25

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "TransactionID": "2153606434",
    "AvailableBalance": "163.01"
  }
}

ManualAuth

Action: POST

Endpoint: /api/ManualAuth

POST /api/ManualAuth

Use this API to perform manual authorizations (MTI 0100,0200,0220,0120,0400) by providing account details, card details, and transaction details. The API returns the approval code and transaction ID if manual authorization is approved.

Request Fields Detail
Fields Description

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required.

Allowable Values:

16

CardSequenceNumber

Int32

Mandatory

Card Sequence Number Valid Values:0-9 Example: 03

Allowable Values:

3

MerchantType

string

Optional

Merchant Type. Example : 3021=Air Algerie Please refer Appendix Merchant Type.

Allowable Values:

25

MerchantCity

string

Optional

Merchant City Valid Values: a-z, A-Z Example:Atlanta

Allowable Values:

50

InvoiceNumber

string

Optional

Invoice Number for Transaction Valid Values: A-Z 0-9 Format:XXXXXXXXXX Example: AB987567757

Allowable Values:

50

CardAcceptorIDCode

string

Optional

Card Acceptor ID Code Valid Values:0-9 Example:123654789654123

Allowable Values:

15

CardAcceptorNameLocation

string

Optional

Name and location details of merchant Valid Values: a-z A-Z Example: Dental merchant, Nashua

Allowable Values:

40

TransactionAmount

decimal

Mandatory

Transaction Amount Valid Values: 0-9 Example:100.11

TransactionDescription

string

Optional

Description of transaction Valid Values:A-Z,a-z Example: Load

Allowable Values:

20

TransmissionDateTime

datetime

Optional

Date and Time of transaction. Format:MM/DD/YYYY HH:MM:SS Example:12/11/2020 11:00:00

ResponseCode

string

Optional

Result of API processing. Valid Values: 0-9 Example: 00

Allowable Values:

2

PreAuthorizationAging

string

Optional

If no matching completion/settlement record is received in this defined time then authorization hold will be released by the system. Valid Values:1 to 9 Format:XX Example:5"

Allowable Values:

3

PreAuthorizationAgingFrame

string

Optional

Time Frame for PreAuthorization Aging in Days/Hours/Minutes Valid Values: 1 : Minutes, 2 :Hours, 3 :Days Example: 1

Allowable Values:

1

AuthorizationType

string

Mandatory

Type of transaction Valid Values : 0100 : Authorization Request 0200 : Financial Request 0220 Completion 0420 Reversal Example : 0100

Allowable Values:

4

ApprovalCode

Int32

Optional

Approval Code of a transaction Valid Values: 0-9 Example:632563

CoreAuthTranIdRev

decimal

Optional

Transaction id of transaction to be reversed. Valid Values:0-9 Example:457896 Condition : Mandatory when AuthorizationType = 0420

WalletID

Int32

Conditional

Wallet ID of wallet mapped on account Valid values:0-9 Example:1005 Condition:Mandatory when card product structure is multi wallet.

Sample Request Body
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1316605",
  "CardNumber": "",
  "CardSequenceNumber": 1,
  "MerchantType": "",
  "MerchantCity": "",
  "InvoiceNumber": "",
  "CardAcceptorIDCode": "",
  "CardAcceptorNameLocation": "",
  "TransactionAmount": 20.0,
  "TransactionDescription": "MA",
  "TransmissionDateTime": "2020-12-01T00:00:00",
  "ResponseCode": "",
  "PreAuthorizationAging": "",
  "PreAuthorizationAgingFrame": "",
  "AuthorizationType": "0100",
  "ApprovalCode": 85746956,
  "CoreAuthTranIdRev": 43543267.0,
  "WalletID": 1012
}
Response Fields Detail
Fields Description

PostingReference

string

Posting description of transaction Example:Approved

Allowable Values:

100

InternalResponseCode

string

Internal Response code Valid Values: 0-9 Example: 00,55

Allowable Values:

10

ResponseCode

string

Result of API processing. Valid Values: 0-9 Example: 00

Allowable Values:

10

ApprovalCode

string

Approval Code of a transaction Valid Values: 0-9 Example:632563

Allowable Values:

10

RetrievalRefNumber

string

Unique Reference Number assigned to transaction Example : 012541

Allowable Values:

12

SystemTraceAuditNumber

Int32

Unique number captured in request used for identification of transaction. Valid values : 0-9 Example:1050741741741417

AuthStatus

string

This field indicates the authorization Status. Valid Values: Refer Appendix section Authorization Status Example: 1

Allowable Values:

5

EmbAcctId

string

Proxy Number of the cardholder Valid values:0-9 Example:1005

Allowable Values:

19

MessageIndicator

string

Manual Auth message indicator Valid Values : 1,3 1 - when AuthorizationType = 0100 or 0420 3 - when AuthorizationType = 0220

Allowable Values:

20

TranType

string

Transaction Code which indicates type of transaction Valid Values: 0-9 Format:1238

Allowable Values:

50

PurgeDate

datetime

Date after which transaction will not be displayed in coreissue authrization log panel. Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

TranCodeInternal

string

Internal Transaction code generated by system Valid Values: 0-9 Example: 5896

Allowable Values:

20

TransactionAmount

decimal

Transaction Amount Valid Values: 0-9 Example:100.11

CoreAuthTranId

Int32

Transaction identifier of CoreAuth module Valid values : 0-9 Example:1050741741741417

Allowable Values:

19

CalcOTB

decimal

Available Balance of account Valid Values:0-9 Example : 100.00

InvoiceNumber

string

Invoice Number for Transaction Valid Values: A-Z 0-9 Example: AB987567757

Allowable Values:

10

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "PostingReference": "Approved",
    "InternalResponseCode": "00",
    "ResponseCode": "00",
    "ApprovalCode": "892407",
    "RetrievalRefNumber": "",
    "SystemTraceAuditNumber": 306585,
    "AuthStatus": "0",
    "EmbAcctId": "1316605",
    "MessageIndicator": "1",
    "TranType": "93",
    "PurgeDate": "2020-02-10T00:00:00",
    "TranCodeInternal": "11169",
    "TransactionAmount": 20.0,
    "CoreAuthTranId": 42772091,
    "CalcOTB": 210.0,
    "InvoiceNumber": ""
  }
}