Category links

API Links

Purchases

The card scheme defines the message format in which all transactions routed via the card network are received. The system is directly integrated to validate, process, and post such transactions in the CoreCard system. Such transactions are received and processed via network messages and processing clearing files, and cardholder balances and network settlement balances are impacted accordingly.
However, in a closed-loop environment, you can use the CoreCard API on your merchant network to initiate purchase transactions with specific processing information. These transactions are validated, processed, and posted in the system and cardholder balances are impacted.

Post Purchase Transaction

Action: POST

Endpoint: /api/CoreCredit/Transactions/PostPurchaseTransaction

POST /api/CoreCredit/Transactions/PostPurchaseTransaction

This API is used to post a purchase 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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

Conditional

Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AdminNumber

int64

Conditional

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

MerchantID

integer

Mandatory

Unique number of merchant account. Valid Values: 0-9 Example:6051

EffectiveDateTime

datetime

Mandatory

Effective Date of Transaction Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

StoreID

integer

Mandatory

Specific code assigned to a Store. Valid Values:XXX Format:0-9 Example:1234

RegisterID

string

Optional

Unique ID assigned to a Register. Valid Values: a-z 0-9 Format:xxxxx Example:123456

Allowable Values:

50

InvoiceNumber

string

Optional

Invoice Number for Transaction Valid Values:0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

50

TransactionAmount

decimal

Mandatory

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

TransactionDescription

string

Optional

User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. For example Purchase/Payment. Valid Values:A-Z,0-9 Example:Purchase/Payment.

Allowable Values:

100

TransmissionDateTime

datetime

Mandatory

Time when transaction was originated Valid Values:12-30-2015T13:05:10 Format:MM/DD/YYYY HH:mm:ss Example:12/30/2015 13:05:10

TransactionCode

string

Mandatory

Transaction Code for the posting of Single Transaction. Valid Values: A-Z 0-9 Format: xxxxxxx Example:427248 = Principal Adjustment

Allowable Values:

20

SignatureJSON

string

Optional

Signature captured in JSON format. A URL will be provided wihch can be used to generate the signature in JSON. Valid Values:a-z 0-9 Format: xxxx Example: abc123 Condition: A setup is required in CoreIssue System to enable/disable this feature.

Allowable Values:

10000

SignaturePNG

string

Optional

Send Binary data in this tag. A URL will be provided wihch can be used to generate the signature. Valid Values:a-z 0-9 Format: xxxx Example: abc123 Condition: A setup is required in CoreIssue System to enable/disable this feature.

Allowable Values:

10000

CreditPlanMaster

string

Mandatory

Plan name associated with the card account. Valid Values: 0-9 Example:5244

Allowable Values:

50

MerchantNumber

string

Mandatory

Number which is assigned to a Merchant. Valid Values: 0-9 Example:6051

Allowable Values:

9

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,
  "AccountNumber": "8000000000000011",
  "AdminNumber": null,
  "MerchantNumber": "11637",
  "EffectiveDateTime": null,
  "StoreID": 11638,
  "RegisterID": null,
  "InvoiceNumber": null,
  "TransactionAmount": 53.21,
  "TransactionDescription": null,
  "TransmissionDateTime": null,
  "TransactionCode": "3020",
  "SignatureJSON": null,
  "SignaturePNG": null,
  "CreditPlanMaster": "6069"
}
Response fields detail
Fields Description

TransactionID

string

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

Allowable Values:

20

TransactionDescription

string

User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. For example Purchase/Payment. Valid Values:A-Z,0-9 Example:Purchase/Payment.

Allowable Values:

100

DeclineReason

string

Specific reason for the decline of transaction posting. Valid Values:A-Z,0-9 Example:abc123

Allowable Values:

100

ResponseCode

string

This number will ensure that API hit our internal servers. This will always be unique. It can also be null when API is returned from our external servers Example - If we pass blank User ID and Password in input then this will be null. This ID can be used for tracking purpose of any request hit the Core Card internal servers.

Allowable Values:

20

PostingReference

string

Posting reference (Like -Transaction Posted Successfully) Valid Values: A-Z 0-9 Format: XXXXXXXXXXXXX Example: Transaction Posted Successfully

Allowable Values:

20

Sample response body

{
  "application/json": {
    "Message": "Transaction posted successfully",
    "Status": true,
    "ErrorCode": "ERR01058",
    "ResponseData": {
      "TransactionID": "34292",
      "TransactionDescription": "45454 = INITIAL CHARGE OFF REVERSAL",
      "DeclineReason": null,
      "ResponseCode": "108410544",
      "PostingReference": null
    }
  }
}