Category links

API Links

Authorizations

An authorization obtains approval to hold funds on a card account. Generally, an authorization request is received via card network when the cardholder uses the card at the merchant location (e.g., store, ATM, online). However, there are situations in which you can manually initiate an authorization request by providing key elements in order to receive an approval code. By doing so, the authorized funds are put on hold and decrease open to buy balance on the card account.

Clear Outstanding

Action: POST

Endpoint: /api/CoreCredit/Authorizations/ClearOutstanding

POST /api/CoreCredit/Authorizations/ClearOutstanding

CoreCARD stores pre-authorization transaction details in the system until they are settled. A user can utilize the ClearOutstanding API to release the amount that is placed on hold due to the pending pre-authorization transactions. By providing a mandatory transaction ID, along with an account identifier like account number, card number, or admin number, a user can release an outstanding authorization hold amount to be available in OTB balance.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:Atleast CardNumber / Account Number / AdminNumber should be entered.

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: Atleast CardNumber / Account Number / AdminNumber should be entered.

Allowable Values:

19

CardNumber

string

Conditional

Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

16

TransactionID

int64

Mandatory

Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXX Example:236547895

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": null,
  "AccountNumber": "8110000000000034",
  "CardNumber": null,
  "TransactionID": 123372036854907813,
  "InstitutionID": 3241
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Clear Outstanding Auth Processed Successfully.",
    "Status": true,
    "ErrorCode": "ERR01030",
    "ResponseData": {}
  }
}

Get AVS Authorization Details

Action: POST

Endpoint: /api/CoreCredit/Authorizations/GetAVSAuthDetail

POST /api/CoreCredit/Authorizations/GetAVSAuthDetail

Use this API to retrieve the AVS (address verification service) detail received for a transaction by using the transaction ID. This API can fetch the cardholder's registered address information, the calculated AVS data received from the scheme, and other information, including AVS results.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

TransactionID

int64

Mandatory

Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789

Sample request body
{
  "Source": "WEB",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "TransactionID": 182797938
}
Response fields detail
Fields Description

CardholderAddress

List Address details of a customer.

CalculatedAVSData

string

Address information calculated basis Product setup for an AVS Transaction. Valid Values:0-9, a-z Example:1012

Allowable Values:

20

ReceivedAVSData

string

Address information received via AVS Transaction. Valid Values:0-9, a-z Example:HNo. 10 1st street block 2

Allowable Values:

40

ReceivedZIPCode

string

Zip Code received in AVS transaction. Valid Values:0-9 Example:40093

Allowable Values:

9

AVSResult

string

AVS transaction decision basis product setup and analysis of received and calculated AVS data. Example:N[Neither address nor postal code matches]

Allowable Values:

100

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "CardholderAddress": {
        "AddressLine1": "12 High Street Road",
        "AddressLine2": "Near Downtown Lane",
        "PostalCode": "42135",
        "Country": "United States",
        "State": "Georgia",
        "County": null,
        "City": "Norcross",
        "POBoxNumber": null
      },
      "CalculatedAVSData": "655",
      "ReceivedAVSData": "12450",
      "ReceivedZIPCode": "97224",
      "AVSResult": "N-Neither address nor postal code matches"
    }
  }
}

Manual Authorization

Action: POST

Endpoint: /api/CoreCredit/Authorizations/ManualAuth

POST /api/CoreCredit/Authorizations/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

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

AccountNumber

string

Conditional

Account number of account holder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

CardNumber

string

Conditional

Card number of account holder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

CardExpirationDate

string

Optional

Expiration date of card. Valid Values: 0-9 Format:YYMM Example:2012

Allowable Values:

4

ProcessingCode

string

Optional

This Tag refer the Processing code Valid Values:0-9 Format:XXXX Example:1234

TransactionAmount

decimal

Mandatory

Amount of Transaction Valid Values:0-9 Format:XXX.XX Example:200.00

MerchantName

string

Optional

Name of the Merchant Valid Values:A-Z, 0-9 Format:XXXXXX Example:ABC LLC

Allowable Values:

40

CardAcceptorNameLocation

string

Optional

Merchant name and location Valid Values:A-Z, 0-9

Allowable Values:

40

CardAcceptorIDCode

string

Optional

Merchant Number. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236

Allowable Values:

16

CardAcceptorTerminalID

string

Optional

Merchant's Terminal Number. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236

Allowable Values:

8

TransmissionDateTime

datetime

Optional

Time of transaction. Valid Values:0-9 Format:MM/DD/YYYY HH:MM:SS Example:12/11/2019 11:00:00

CoreAuthTranIdRev

int64

Optional

Transaction id received in response of manual Auth API which is used to locate the transaction to be reversed.

PreAuthorizationAging

string

Optional

Number to signify when the preauth will be aged off Numeric value.

Allowable Values:

10

PreAuthorizationAgingFrame

string

Optional

Signifies the time to age off the Preauthorization i.e. Mins,Hours,days etc.

Allowable Values:

40

ResponseCode

string

Optional

Response code to be stamped on Transaction, if in input then used for response of declined or approved transaction.

Allowable Values:

8

ApprovalCode

string

Optional

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

Allowable Values:

6

ClientName

string

Mandatory

Specifies the client name for which the API is used.

Allowable Values:

40

InvoiceNumber

string

Optional

User entered identification number captured in request and echoed in response.

Allowable Values:

40

TransactionDescription

string

Mandatory

Any informatory text user can enter in this field.

Allowable Values:

16

CreditPlanNumber

string

Mandatory

Signifies the CPM on which the Transaction needs to be posted ,in response the CPM where transaction was posted.

Allowable Values:

15

TransactionType

string

Mandatory

Type of transaction should be text describing the type of transaction which can be provided by Client Valid Values: 0100: Purchase Auth or Pre-Auth is a Pre-Authorization that places a hold on your customer's credit card for a specified dollar amount based on a projected sale amount. This guarantees you access to their credit limit for the specified amount instead of actually debiting funds from the cardholder it just put a temporary hold on the funds that lasts for a particulate time period depending on the configuration. 0220 Completion: Completion Matches the Pre-Authorization and releases then fund put on hold and posts the actual transaction for which the purchase is done.The Completion is matched to Pre-Auth on the basis of CardNumber, Approval code, Merchant details, Date time of transaction etc.If a Completion request is initiated without a valid Approval code(no valid Pre-Auth present) then it will post an independent purchase of the specified amount forcefully on the Card. 0420 Reversal: This process is used to negate a transaction which is done on a cardholder's account. This can be used to negate any transaction based on matching data like Card Number , date time, Transaction id generated for the original transaction.

Allowable Values:

8

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": null,
  "AccountNumber": "9000000800001217",
  "CardNumber": "",
  "CardExpirationDate": null,
  "ProcessingCode": null,
  "TransactionAmount": 100.0,
  "MerchantName": "",
  "CardAcceptorNameLocation": null,
  "CardAcceptorIDCode": null,
  "CardAcceptorTerminalID": "test",
  "TransmissionDateTime": null,
  "CoreAuthTranIdRev": null,
  "PreAuthorizationAging": null,
  "PreAuthorizationAgingFrame": null,
  "ResponseCode": null,
  "ApprovalCode": null,
  "ClientName": "MA",
  "InvoiceNumber": "12345",
  "TransactionDescription": "test data",
  "CreditPlanNumber": "5911",
  "TransactionType": "0100"
}
Response fields detail
Fields Description

ResponseCode

string

Response code generated by Corecard application in transaction processing.

Allowable Values:

8

ApprovalCode

string

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

Allowable Values:

6

PostingReference

string

Posting reference (Like -Transaction Posted Successfully)

Allowable Values:

50

InternalResponseCode

string

Response code generated by Corecard application for internal identification in transaction processing.

Allowable Values:

50

RetrievalReferenceNumber

string

Unique identification number captured in request used for identification of transaction.

Allowable Values:

12

SystemTraceAuditNumber

int64

Unique identification number captured in request used for identification of transaction.

AuthStatus

string

Autorization Status Valid Values:Decline , Partial Approve, Approve Example:Decline , Partial Approve, Approve

Allowable Values:

5

CalculatedOTB

decimal

Calculated Open to Buy Amount Valid Values:500.00 Format:XXX.XX Example:500.00

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

TranType

string

Type of transaction like purchase,Cash withdrawel etc.

Allowable Values:

5

PurgeDate

datetime

Date after which transaction will not be displayed in return of serch requests.

TranCodeInternal

string

Transaction code generated by Corecard application.

Allowable Values:

20

TransactionAmount

decimal

Transaction Amount. Valid Values:0-9 Format:XXX.XX Example:200.00

InvoiceNumber

string

User entered identification number captured in request and echoed in response.

Allowable Values:

28

CreditPlanMaster

string

Plan name associated with the card account. Valid Values:A-Z, 0-9 Format:XXXXXX Example:6 Months No Interest if Paid in Full

Allowable Values:

20

TransactionID

string

Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789

DateTimeLocalTransaction

datetime

Date time of the system when transaction was initiated.

Sample response body

{
  "application/json": {
    "Message": "Transaction has been authorized successfully.",
    "Status": true,
    "ErrorCode": "ERR0000",
    "ResponseData": {
      "ResponseCode": null,
      "ApprovalCode": "840537",
      "PostingReference": null,
      "InternalResponseCode": null,
      "RetrievalReferenceNumber": null,
      "SystemTraceAuditNumber": 0,
      "AuthStatus": null,
      "CalculatedOTB": 0.0,
      "AdminNumber": 0,
      "TranType": null,
      "PurgeDate": null,
      "TranCodeInternal": null,
      "TransactionAmount": 100.0,
      "InvoiceNumber": null,
      "CreditPlanMaster": null,
      "TransactionID": "1927112",
      "DateTimeLocalTransaction": "12/31/2099 00:00:00"
    }
  }
}

AuthUpdate

Action: POST

Endpoint: /api/CoreCredit/Authorizations/AuthUpdate

POST /api/CoreCredit/Authorizations/AuthUpdate

This API is used to update the Auth Decision for an Outstanding Authorization Transaction.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountNumber

string

Mandatory

Account number of Card holder/Account Holder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 7314145404

Allowable Values:

19

TransactionID

decimal

Mandatory

Transaction Number for the transaction being posted. Valid Values: 0-9 Example: 23654789

DecisionFlag

integer

Mandatory

Decision Flag for Approving or Declining the Transaction Valid Values: 0 - Approve, 1- Reject Example: 0

AuthorizedSource

integer

Mandatory

Indicator for Authorization source Valid Values: 0 - Email, 1 - SMS, 2 - CSR or 3 - Cancelled by Provider Example: 0

SMSDeliverystatus

integer

Optional

Indicator for SMS Delivery Status Valid Values: 0 - Delivered 1 - Undelivered Example:0 Format: X

SMSDeliveryTimeStamp

datetime

Conditional

Indicator for SMS Delivery date and time Valid Values: 0-9 Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00 Condition: Mandatory if Delivery Status is Delivered

ResponseDate

datetime

Mandatory

Must indicate the date time of Authorization Response Valid Values: 0-2 Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

ProcedureCompletedorScheduled

integer

Mandatory

Determines that the Procedure for which the Purchase Transaction posted is completed/scheduled or not Valid Values: 0- Yes and 1-No Example:0 Format: X

RejectReason

integer

Optional

Reason for Rejection Valid Values: 0 - Did Not Authorize 1 - Services Not Yet Scheduled 2 - Services Scheduled Beyond 30 Days 3 - Wrong Amount 4 - Wrong Plan 5 - Cancelled by Provider 6 - Not Provided 7 - SMS Undelivered Example:1 Format: X

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "8000000000000029",
  "TransactionID": 1.2337203685498774E+17,
  "DecisionFlag": 0,
  "AuthorizedSource": 2,
  "SMSDeliverystatus": null,
  "SMSDeliveryTimeStamp": null,
  "ResponseDate": "12/12/2018 00:00:00",
  "ProcedureCompletedorScheduled": 0,
  "RejectReason": null
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Request processed successfully",
    "Status": true,
    "ErrorCode": "ERR01155",
    "ResponseData": null
  }
}