Transactions
A transaction is an activity that impacts the financial state of a card account. The cardholder or card issuer can initiate a transaction to pay an amount of money to each other as per agreed terms.
As a card issuer or processor, you can utilize the CoreCard system to issue cards, and to process various transaction types received within the closed-loop environment or from an open network. These transactions could fulfill different purposes, such as purchases, payments, adjustments, and transfers.
Usually, the CoreCard system receives a transaction when a cardholder utilizes his card at a merchant terminal or online to make a purchase. These kinds of transactions are initiated by the merchant and routed to the CoreCard system for validation and processing.
If a purchase is initiated from an open network, then the transaction is initially routed via the card network to obtain authorization. Subsequently it is submitted with a clearing to debit the funds from the cardholder's account. If it is received from network merchants (i.e., a closed loop environment), then you can route it via APIs, which will be validated and posted accordingly in the system.
In some situations, the merchant may process purchase reversals or refunds for an initially authorized or cleared transaction. These transactions are treated similarly to purchase transactions when received from an open network or a merchant network.
Apart from purchase transactions, a payment or balance transfer transaction can be initiated and posted whenever a cardholder makes a payment against the due calculated or to pay any third party. This may occur via a transfer of the funds or balances to another payee, respectively. Based on the situation, you can post adjustment transactions to a card account when the transaction was not posted correctly or was posted with the incorrect amount, or in a similar situation.
Get Cardholder Transaction History
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetCHTransactionHistory
Use this API is to bring monetary transactions posted on the account. Multiple filters can be used to fetch records based on date range, transaction ID, minimum transaction amount, maximum transaction amount, and transaction type with values as all transactions, settled transactions, outstanding transactions, expired transactions, unbilled transactions etc.
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 Condition:At least one of AccountNumber/AccountID is required. Allowable Values: 19 |
|
AdminNumber int64 Optional |
Admin Number. Valid Values:0-9 Example:7485122 |
|
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values:0-9 Example:7485122 Condition:At least one of AccountNumber/AccountID is required. |
|
FromDate datetime Optional |
Starting date of Transaction search. Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
ToDate datetime Optional |
End date of Transaction search. Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
TransactionType string Optional |
Type of Transaction. Valid Values:0 = All,1 = ATM,3 = Fees,4 = Purchase,7 = Transfers,8 = Disputed,9 = Payments,10 = Payment Example:Fees/Purchase/ATM. Allowable Values: 2 |
|
TransactionID int64 Optional |
Transaction ID of a Transaction. Example:8574152. |
|
TransactionHistoryType integer Mandatory |
Type of Transaction's History. Valid Values:1,2,3,4,5 Example:0=All,1 = Settled, 2 = OutStanding , 3 = Expired, 4 = Warehoused , 5 = Unbilled |
|
Merchant string Optional |
Name of the Merchant. Valid Values:a-z,0-9 Example:Wallmart Allowable Values: 50 |
|
MinTransactionAmount decimal Optional |
Minimum Transaction Amount on the Account. Valid Values:0-9 Example:200.00 |
|
MaxTransactionAmount decimal Optional |
Maximum Transaction Amount on the Account. Valid Values:0-9 Example:200.00 |
|
BatchSize integer Optional |
Number of Transaction which can be view in one Batch. BatchSize can have value 1-100,On the basis of PageIndex and BatchSize paging will be done. BatchSize can not exceed 100. Default Batch Size should be 100. Valid Values:0-100 Example:10,50. |
|
PageIndex integer Optional |
Number of page. PageIndex can not exceed 999. Valid Values:0-999 Example:1. |
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": "9000000900000010",
"AdminNumber": null,
"AccountID": 87307,
"FromDate": null,
"ToDate": null,
"TransactionType": null,
"TransactionID": null,
"TransactionHistoryType": 1,
"Merchant": null,
"MinTransactionAmount": null,
"MaxTransactionAmount": null,
"BatchSize": 50,
"PageIndex": 0
}
Response fields detail
| Fields | Description |
|---|---|
|
TotalRecordCount integer |
Total No of records. |
|
TransactionHistoryList array |
Transaction History List. |
Sample response body
{
"application/json": {
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"TotalRecordCount": 1,
"TransactionHistoryList": [
{
"ReturnReasonCode": "",
"CardAcceptorNameAndLocation": "",
"MerchantNameAndLocation": "Demo A",
"TimeZone": "",
"TransactionID": "117675465",
"TransactionDateTime": "03/31/2016 00:00:00",
"TransactionPostTime": "03/31/2016 00:00:00",
"TransactionAmountCurrencyCode": "840",
"TransactionAmount": -5.0,
"AccountNumber": "9000000900000010",
"PostingFlag": "",
"PostingReference": "Transaction posted successfully",
"TransactionSource": "Clearing",
"TransactionDescription": "454304 = DISPUTE RELEASE - (NO INTEREST/CHG FEE)",
"CurrentBalance": -679.79,
"ExternalResponseCode": "",
"TransactionType": "Settled",
"ReverseFlag": true,
"CardNumberLast4Digit": "6392",
"ProductBIN": "525751",
"AdminNumber": 98385,
"ServiceResponsecode": "",
"ServicepostingReference": "",
"InternalTranCode": "454304",
"InternalTranCodeDesc": "DISPUTE RELEASE - (NO INTEREST/CHG FEE)",
"DisputeStatus": "",
"CardType": "Primary Card",
"AuthCategory": "",
"MerchantType": "",
"PlanMaster": 21701,
"InvoiceNumber": "",
"ADCInternalResponseCode": "",
"ApprovalCode": "",
"SentResponseCode": "",
"TansmissionDateTime": "03/31/2016 00:00:00",
"IsCredit": true,
"TokenWalletID": "",
"TokenTransaction": "",
"TokenRequesterID": "",
"RewardPoints": 0.0,
"PaymentReferenceID": "",
"BankNameAccount": "",
"DisputeOTBReleaseFlag": 0,
"VROLCaseNumber": null,
"CardPresenceIndicator": 1,
"PreAuthTimestamp": null,
"LocalTransactionCurrencyCode": "840",
"CardholderBillingCurrencyCode": "840",
"SettlementCurrencyCode": "840",
"CardholderBillingAmount": 100.0,
"TransactionSourceAmount": 100.0
}
]
}
}
}
Payment Schedule Request
Action: POST
Endpoint: /api/CoreCredit/Transactions/PaymentScheduleRequest
Use this API to either add or update or delete a payment schedule. While adding payment schedule, frequency, payment type and date are mandatory.
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 |
Account number of cardholder. Valid Values:0-9 Example:8000000000000037 Condition:At least one of AdminNumber/AccountNumber is required. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Example:4851455 Condition:At least one of AdminNumber/AccountNumber is required. |
|
Frequency integer Conditional |
Frequency set with which payment will be made Possible values 0 = Monthly Specific Day 1 = Payment Due Date 2 = One Time 3 = Weekly 4 = Instant Pay 5 = Daily 6 = Bi-Weekly 7 = Semi-Monthly Condition:Mandatory When Request type = 0 |
|
PaymentDate datetime Conditional |
Date when payment is scheduled. Format: MM/DD/YYYY Example: 01/01/2020 Condition: If request type = 0 and frequency = 2 then this is mandatory. |
|
PaymentType integer Conditional |
Type of Payment as below enumerations: 0 = Minimum Payment Due 1 = Statement Balance 2 = Current Balance 3 = Fixed Amount 4 = Adjusted Statement Balance Condition: Mandatory When Request type = 0 |
|
MethodName integer Conditional |
Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account. This is required If User wants to send transaction in ACH. Condition: Mandatory When Request type = 0 and PaymentMode is 0(ACH). |
|
SpecificDay string Conditional |
Specific day when scheduled payment should occur. If frequency = 0 Or frequency = 3 Or frequency = 6 then this is mandatory. Possible values: If (frequency = 0) 1-31 EOM If (frequency = 3 Or frequency = 6) MON, TUE, WED, THU, FRI, SAT, SUN Condition : If frequency = 0 Or frequency = 3 Or frequency = 6 then this is mandatory if PaymentDate is not provided. Allowable Values: 10 |
|
EnterMemo string Conditional |
Memo text entered by Customer service representative. Possible values: a-z,0-9 Example:abc Condition: Memo text required when deleting a schedule, if request type = 1 Allowable Values: 150 |
|
ScheduleID integer Conditional |
Unique identifier for Schedule Payment. Condition:Mandatory When Request type = 1. |
|
RequestType integer Mandatory |
Denotes type of action being attempted. Possible values: 0 = Add/Create Schedule 1 = Delete Schedule 2 = Update Example: 0 |
|
Priority integer Conditional |
Denotes memo priority while deleting scheduled payment. Possible values: 0 = No, 1 = Yes Example:1 Condition: If request type = 1 then priority can be set. |
|
FixedAmount decimal Conditional |
This is fixed value of payment to be used to schedule a payment. Condition: If payment type = 3 then this is mandatory |
|
PaymentMode integer Optional |
If not provided then Default value - 0 (ACH) Possible values: 0 = ACH 1 = Debit Card With Token 2 = Debit Card With Card Number 3 = APC Payment |
|
Token string Optional |
Debit Card Token (Cardholder Authentication Verification Value(CAVV)) Allowable Values: 100 |
|
CreateMethodForNextPayment string Optional |
If User wants to generate Method of Debit Card Token or Debit Card Number information for further Payments Possible values: 0 = No, 1 = Yes Example: 0 Allowable Values: 2 |
|
XDaysBeforePaymentDueDate integer Optional |
XdaysBeforePaymentDueDate will be enable, if Frequency is Payment Due Date. Possible Values: 0 - 28. If not provided then default values is 0 which means payment date will be Payment due Date. |
|
ApplicantType integer Optional |
Selects the type of Applicant. Valid Values: 1,2,3 Example: 1 = Applicant, 2 = Co-Applicant, 3 = Cosigner |
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": "700000000785214",
"AdminNumber": 100989,
"Frequency": null,
"PaymentDate": "11/02/2020 00:00:00",
"PaymentType": 3,
"MethodName": null,
"SpecificDay": null,
"EnterMemo": null,
"ScheduleID": null,
"RequestType": 0,
"Priority": null,
"FixedAmount": 10.0,
"PaymentMode": null,
"Token": null,
"CreateMethodForNextPayment": null,
"XDaysBeforePaymentDueDate": null,
"ApplicantType": null
}
Response fields detail
| Fields | Description |
|---|---|
|
ScheduleID integer |
Unique identifier for Schedule Payment. |
|
TransactionStatus string |
Shows status of transaction. Allowable Values: 20 |
|
TransactionAmount decimal |
Amount of Transaction. |
|
ExternalErrorMessage string |
Error message, if any. Allowable Values: 50 |
|
DateOfPayment datetime |
Date when payment transaction will happen. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
Sample response body
{
"application/json": {
"Message": "Payment Schedule Added.",
"Status": true,
"ErrorCode": "ERR01032",
"ResponseData": {
"ScheduleID": 1654477,
"TransactionStatus": null,
"TransactionAmount": null,
"ExternalErrorMessage": null,
"DateOfPayment": "03/15/2020 00:00:00"
}
}
}
Get Promotion By Amount
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetPromotionBYAmount
Use this API to retrieve the available or applicable promotional credit plans, with details such as credit plan name and type, based on the transaction amount and by using the merchant ID, account number, and transaction amount.
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 |
|
MerchantID integer Conditional |
Unique number of merchant account. Valid Values:0-9 Format:XXXXX Example:12345 |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 16 |
|
TransactionAmount decimal Mandatory |
Amount of Transaction Valid Values:0-9 Format:XXX.XX Example:200.00 |
|
MerchantNumber integer Conditional |
Merchant Number which is assgined to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 11642 |
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,
"MerchantID": 25636,
"MerchantNumber": null,
"AccountNumber": "9000000900001737",
"TransactionAmount": 3400.0
}
Response fields detail
| Fields | Description |
|---|---|
|
ListCPM array |
List of Credit Plan Masters. |
Sample response body
{
"application/json": {
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ListCPM": [
{
"CreditPlanMaster": 6153,
"CreditPlanMasterDescription": "ABC_Installment",
"CreditPlanType": "1"
}
]
}
}
}
Get Merchant By Network
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetMerchantByNetwork
Use this API to retrieve the list of merchants linked to any merchant network using card Account Number.
Note
In the merchant network, card account can be issued by any merchant.
Request fields detail
| Fields | Description |
|---|
Sample request body
[
{
"in": "header",
"name": "Authorization",
"description": "access token",
"required": true,
"type": "string",
"default": "Bearer "
},
{
"in": "body",
"name": "body",
"description": "requestModel.",
"schema": {
"$ref": "#/definitions/GetMerchantByNetworkRequestModel"
}
}
]
Response fields detail
| Fields | Description |
|---|
Sample response body
{
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/GetMerchantByNetworkResponseModelApiResult"
},
"examples": {
"application/json": {
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"MerchantByNetworkDetailList": [
{
"MerchantNumber": 26,
"MerchantID": 5030,
"MerchantName": "ABC_merchant"
},
{
"MerchantNumber": 27,
"MerchantID": 6001,
"MerchantName": "ABC_CanadaMerchant"
}
]
}
}
}
},
"Err100001": {
"description": "AccountNumber can not be blank."
},
"Err100008": {
"description": "AccountNumber Please enter valid Account Number."
},
"Err00016": {
"description": "System could not process your request at this time. Please try again."
},
"Err00017": {
"description": "Success."
},
"Err00018": {
"description": "Record Not Found."
}
}
Post Single Transaction
Action: POST
Endpoint: /api/CoreCredit/Transactions/PostSingleTransaction
Use this API to post any transaction by selecting the appropriate transaction code. The API permits posting of all transaction types, including debit, credit, fees, and post-payments, by selecting the invoice ID. Furthermore, the API can be used to reverse any transaction.
Note
You can also add a user-defined description which can be referred to in the future.
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 |
|
StoreID integer Optional |
Specific code assigned to a Store. Valid Values:0-9 Example:1234 |
|
RegisterID string Optional |
Unique ID assigned to a Register. Valid Values:a-z 0-9 Example:123456 Allowable Values: 50 |
|
AccountNumber string Conditional |
Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/AccountNumber is required. Allowable Values: 19 |
|
TransactionCurrencyCode string Mandatory |
Currency code corresponding to the Transaction Amount. Valid Values:840 for US Dollar Example:840 Allowable Values: 3 |
|
TransactionDescription string Optional |
User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Example:Purchase/Payment. Allowable Values: 100 |
|
TransactionCode string Mandatory |
A code to identify type of payment. Valid Values: The valid values of Transaction Code can be fetched from GetTranCodeByUserID API. Example:427248 = Principal Adjustment Allowable Values: 20 |
|
ProductCode string Optional |
Specific code assigned to the product. Valid Values: Refer Section 5.47 of Appendix Example: 12456 Allowable Values: 50 |
|
SettlementDate DateTime Optional |
Date of Settlement. Valid Values:0-9 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
TransactionAmount decimal Mandatory |
Amount of Transaction. Valid Values:0-9 Format:XXX.XX Example:500.00 |
|
CreditPlanMaster string Optional |
Plan name associated with the card account. Valid Values: 0-9 Example:6051 Allowable Values: 50 |
|
PaymentReferenceID string Optional |
Refernce ID of the Payment. Valid Values:0-9, A-z Format:XXXXXXXXXXX Example:fy76869878gh Allowable Values: 36 |
|
TransmissionDateTime DateTime Optional |
Time of transaction. Valid Values:0-9 Format:MM-DD-YYYTHH:mm:ss Example:12-30-2015T13:05:10 |
|
EffectiveDateTime DateTime Optional |
Effective Date of Transaction Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
MerchantType string Optional |
Type of Merchant Valid Values:a-z Example: Retail,Hospital Allowable Values: 50 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 Condition:At least one of AdminNumber/AccountNumber is required. |
|
ReversalTargetTranID string Optional |
Transaction number of target transaction which is going to be reversed. Valid Values: 0-9 Example:12345 Allowable Values: 20 |
|
ReturnTransactionID int64 Optional |
Transaction ID generated for The Return Transaction. Valid Values:0-9 Example:122390308 |
|
MethodName string Optional |
Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account.This is required If User wants to send transaction in ACH. Valid Values:0-9 Example:4092 Allowable Values: 25 |
|
MerchantNumber string Optional |
Number which is assigned to a Merchant. Valid Values: 0-9 Example:11642 Allowable Values: 9 |
|
InvoiceNumber string Optional |
Incoice Number for Transaction. Valid Values: A-Z 0-9 Example: AB987567757 Allowable Values: 50 |
|
FeeReversalReason string Optional |
Reason for Fee Reversal. Valid Values: 0 - Customers Goodwill , 1- Erroneous charges Example: 0 - Customers Goodwill Allowable Values: 1 |
|
CheckNumber string Optional |
Number of the Payment Check. Valid Values:0-9 Format:XXXXXXXX Example:89874545 Allowable Values: 15 |
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,
"MerchantNumber": "25636",
"StoreID": 25637,
"RegisterID": null,
"TransactionCode": "34292",
"EffectiveDateTime": null,
"AccountNumber": "9000000900001737",
"AdminNumber": 101055,
"TransactionAmount": 53.21,
"CreditPlanMaster": "21701",
"TransactionDescription": null,
"TransactionCurrencyCode": "840",
"MerchantType": null,
"InvoiceNumber": null,
"ReversalTargetTranID": "0",
"ProductCode": null,
"ReturnTransactionID": null,
"MethodName": "0",
"SettlementDate": null,
"FeeReversalReason": null,
"PaymentReferenceID": null,
"CheckNumber": null,
"TransmissionDateTime": null
}
Response fields detail
| Fields | Description |
|---|---|
|
CreditPlanMaster string |
Plan name associated with the card account. Valid Values: 0-9 Example:6051 Allowable Values: 50 |
|
PostingReference string |
Posting reference (Like -Transaction Posted Successfully) Allowable Values: 100 |
|
PostingFlag string |
With certain IDs in response, It confirms the posting of transaction. Example:1 = Success,0 failed Allowable Values: 1 |
|
TransactionAmount decimal |
Amount of Transaction. Valid Values: 0-9 Example:500.00 |
|
AccountNumber string |
Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
|
AdminNumber int64 |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 |
|
TransactionID int64 |
Transaction Number for the transaction being posted. Valid Values:0-9 Example:23654789 |
|
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9 Example:478585 Allowable Values: 15 |
|
StoreID integer |
Specific code assigned to a Store. Valid Values:0-9 Example:1234 |
|
TransactionCurrencyCode string |
Currency code corresponding to the Transaction Amount. Valid Values:840 for US Dollar Example:840 Allowable Values: 3 |
|
PostingDateTime datetime |
Date and Time of posting of the transaction. Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
TransactionDescription string |
User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Example:Purchase/Payment. Allowable Values: 100 |
|
TransactionCode string |
A code to identify type of payment. Valid Values: A-Z 0-9 Example:427248 = Principal Adjustment Allowable Values: 20 |
|
TransmissionDateTime datetime |
Time of transaction. Valid Values:0-9 Format:MM-DD-YYYTHH:mm:ss Example:12-30-2015T13:05:10 |
|
CurrencySymbol string |
This tag reflects the currency symbol |
Sample response body
{
"application/json": {
"Message": "Transaction posted successfully",
"Status": true,
"ErrorCode": "ERR01058",
"ResponseData": {
"CreditPlanMaster": "21701",
"PostingReference": null,
"PostingFlag": null,
"TransactionAmount": 53.21,
"AccountNumber": "9000000900001737",
"AdminNumber": 101055,
"TransactionID": null,
"ResponseID": "108410544",
"StoreID": 25637,
"TransactionCurrencyCode": "840",
"PostingDateTime": null,
"TransactionDescription": "45454 = INITIAL CHARGE OFF REVERSAL",
"TransactionCode": "34292",
"TransmissionDateTime": null,
"CurrencySymbol": null
}
}
}
Post Purchase Transaction
Action: POST
Endpoint: /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
}
}
}
Get Inventory Transaction ID
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetInventoryTranID
The purpose of this API is to get the transaction id which will be use for posting the inventory Sales/Return/Payment 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 Mandatory |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
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": "1000000700000093"
}
Response fields detail
| Fields | Description |
|---|---|
|
InventoryTranID string |
Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789 Allowable Values: 20 |
Sample response body
{
"application/json": {
"Message": "TranId generated successfully",
"Status": true,
"ErrorCode": "ERR0000",
"ResponseData": {
"InventoryTranID": "123372036854881808"
}
}
}
Post Inventory Transactions
Action: POST
Endpoint: /api/CoreCredit/Transactions/PostInventoryTransactions
Use this API to post a purchase transaction in bulk. Account number, merchant number, store number, and inventory details are provided along with quantity and unit price.
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 |
|
DecisionFlag string Mandatory |
Flag decides the type of transaction. Valid Values: 0- Sales 1-Return Example: 1 Allowable Values: 2 |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one Account identifier input parameter should be passed. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one Account identifier input parameter should be passed. |
|
MerchantNumber string Mandatory |
Merchant Number which is assgined to a Merchant, Mandatory If MerchantID not Inputted in API Request Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 9 |
|
StoreNumber string Mandatory |
Unique Number which is assgined to a Store. Valid Values:0-9 Example: 205136549 Allowable Values: 10 |
|
RegisterNumber string Mandatory |
Unique Number which is assgined to a register. Valid Values:0-9 Example: 205136549 Allowable Values: 10 |
|
Operator string Mandatory |
SpecialMerchantIdentifier as TransactionCode Internal Allowable Values: 50 |
|
SpecialPlans string Optional |
ID of Plan which can be applied for the Transaction. Valid Values:0-9 Example: 1234 Allowable Values: 10 |
|
NonDetailedTxnAmount decimal Conditional |
Transaction Amount Ex: 50.02 |
|
InventoryDetails array |
Array to capture the purchase/return line item. |
|
NonDetailedTxnDescription string Conditional |
User defined description of transaction. Valid Values: A-Z 0-9 Example: TestInventory Condition:If DecisionFlag = 0 then either NonDetailedTxnDescription or InventoryDetails Array details needs to be provided. |
|
DiscountAmount decimal Optional |
Amount which will deduct from Total Transaction Amount as a discount. Valid Values:0-9 Example:10.00 |
|
TaxAmount decimal Conditional |
Purchase Amount for PLAdditional Table if greater than 0 |
|
TotalAmount decimal Conditional |
Transaction Amount if source is Sales |
|
InventoryTranID string Mandatory |
Transaction ID for initiating the Inventory order. Allowable Values: 20 |
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,
"DecisionFlag": "0",
"AccountNumber": "1000000700000093",
"AdminNumber": null,
"MerchantNumber": "11276",
"StoreNumber": "11298",
"RegisterNumber": "11299",
"Operator": "test",
"SpecialPlans": "5651",
"NonDetailedTxnAmount": 0.0,
"InventoryDetails": [
{
"ItemCode": "2",
"Description": "test",
"Quantity": 2,
"UnitPrice": 200.0,
"LineItemTotal": 300.0,
"IsMarkDownInAmount": true,
"MarkdownAmount": 100.0,
"MarkdownPercent": null,
"IsNonTaxable": false
}
],
"NonDetailedTxnDescription": null,
"DiscountAmount": null,
"TaxAmount": null,
"TotalAmount": null,
"InventoryTranID": "123372036854847814"
}
Response fields detail
| Fields | Description |
|---|---|
|
PostedPlan string |
Name of the Plan with which transaction is initiated. Valid Values:0-9, A-Z Example:RegularPurchasePlan Allowable Values: 50 |
|
PostedPlan string |
Name of the Plan with which transaction is initiated. Valid Values:0-9, A-Z Example:RegularPurchasePlan Allowable Values: 50 |
Sample response body
{
"application/json": {
"Message": "Transaction posted successfully.",
"Status": true,
"ErrorCode": "ERR01058",
"ResponseData": {
"PostedPlan": null
}
}
}
Post Inventory Payment
Action: POST
Endpoint: /api/CoreCredit/Transactions/PostInventoryPayment
Use this API is to post payment transactions in bulk. Account number, merchant number, store number are provided along with payment description and total amount.
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 |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one Account identifier input parameter should be passed. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one Account identifier input parameter should be passed. |
|
MerchantNumber string Mandatory |
Merchant Number which is assgined to a Merchant, Mandatory If MerchantID not Inputted in API Request Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 9 |
|
StoreNumber string Mandatory |
Unique Number which is assgined to a Store. Valid Values:0-9 Example: 205136549 Allowable Values: 30 |
|
RegisterNumber string Mandatory |
Unique Number which is assgined to a register. Valid Values:0-9 Example: 205136549 Allowable Values: 30 |
|
Operator string Mandatory |
SpecialMerchantIdentifier as TransactionCode Internal Allowable Values: 50 |
|
SpecialPlans string Optional |
ID of Plan which can be applied for the Transaction. Valid Values:0-9 Example: 1234 Allowable Values: 10 |
|
PaymentAmount decimal Mandatory |
Amount of Payment Valid Values: 0-9 Example: 200.50 |
|
PaymentDescription string Mandatory |
Detail for the Payment Transaction. Valid Values: A-Z 0-9 Example: TestInventory Allowable Values: 30 |
|
InventoryTranID string Mandatory |
Transaction ID for initiating the Inventory order. Valid Values: Get the value from 'GetInventoryTRanID' API Example: 548965 Allowable Values: 20 |
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": "1000000700000093",
"AdminNumber": null,
"MerchantNumber": "11276",
"StoreNumber": "11298",
"RegisterNumber": "11299",
"Operator": "test",
"SpecialPlans": "5651",
"PaymentAmount": 100.0,
"PaymentDescription": null,
"InventoryTranID": "123372036854847814"
}
Response fields detail
| Fields | Description |
|---|---|
|
PostedPlan string |
Name of the Plan with which transaction is initiated. Valid Values:0-9, A-Z Example:RegularPurchasePlan Allowable Values: 50 |
Sample response body
{
"application/json": {
"Message": "Transaction posted successfully.",
"Status": true,
"ErrorCode": "ERR01058",
"ResponseData": {
"PostedPlan": null
}
}
}
Plan Pay Off
Action: POST
Endpoint: /api/CoreCredit/Transactions/PlanPayOff
This API is used to get the payoff details of any plan for an account.
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 |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
|
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values:0-9 Format:XXXXX Example:12345 |
|
PlanID integer Optional |
Credit Plan Segment Account ID. Valid Values:0-9 Format:XXXXX Example:12345 |
|
PayOffDate datetime Optional |
Date when Pay off has been made. Format:Format: MM/DD/YYYY Example:12/20/2019 |
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": "5000000000014059",
"AccountID": null,
"PlanID": 97910,
"PayOffDate": null
}
Response fields detail
| Fields | Description |
|---|---|
|
PlanList array |
PlanDetail List |
|
TotalPayoffAmount decimal |
Total Payoff Amount Valid Values:0-9 Format:XXXX.XX Example:500.00 |
Sample response body
{
"application/json": {
"Message": "Return Successfully",
"Status": true,
"ErrorCode": "ERR01093",
"ResponseData": {
"PlanList": [
{
"PlanSequence": 1,
"PlanID": 97910,
"CurrentBalance": 19.99,
"Principal": 19.99,
"PayOffAmount": 20.1,
"PayOffInterestDebit": 0.11,
"PayOffInterestCredit": 0.0
}
],
"TotalPayoffAmount": 20.1
}
}
}
Get Transaction Code By User ID
Action: POST
Endpoint: /api/CoreCredit/Transactions/GetTranCodeByUserID
Use this API to retrieve details of the transaction code posted on the account by the user or merchant. API returns Logic module, actual transaction code, and transaction description.
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 ---- es: means Spanish 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 |
|
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 |
Description - Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
UserID string Optional |
Description -user id which performed the action Valid Values:a-z,0-9 Format:XX Example:portalsuperuser Allowable Values: 30 |
|
TransactionType string Optional |
Description -Type of Transaction (purchase,payment etc) Valid Values: Puchase, Payment Format: XXXXXXX Example: Purchase Allowable Values: 1 |
|
RejectedTransactionID string Optional |
Description -ID for Rejected Transaction. Valid Values: 0-9,a-z Format: XXXXXXX Example: 241- Return Allowable Values: 20 |
|
MerchantID integer Optional |
Description:Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 |
|
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 Mandatory |
Description - Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
UserID string Optional |
Description -user id which performed the action Valid Values:a-z,0-9 Format:XX Example:portalsuperuser Allowable Values: 30 |
|
TransactionType string Optional |
Description -Type of Transaction (purchase,payment etc) Valid Values: Puchase, Payment Format: XXXXXXX Example: Purchase Allowable Values: 1 |
|
RejectedTransactionID string Optional |
Description -ID for Rejected Transaction. Valid Values: 0-9,a-z Format: XXXXXXX Example: 241- Return Allowable Values: 20 |
|
MerchantID integer Optional |
Description:Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 |
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": "1000000700000720",
"UserID": null,
"TransactionType": "1",
"RejectedTransactionID": null,
"MerchantID": 5030
}
Response fields detail
| Fields | Description |
|---|---|
|
TransactionCodeList array |
Description:List of Transaction Code |
|
TransactionCodeList array |
Description:List of Transaction Code |
Sample response body
{
"application/json": {
"Message": null,
"Status": false,
"ErrorCode": null,
"ResponseData": {
"TransactionCodeList": [
{
"LogicModule": "23",
"TransactionDescription": "000 = DIRECT CR CHG-OFF IN-HOUSE",
"ActualTransactionCode": "000",
"TransactionCode": "9145",
"TransactionDescriptionNew": "DIRECT CR CHG-OFF IN-HOUSE"
}
]
}
}
}
BalanceTransfer
Action: POST
Endpoint: /api/CoreCredit/Transactions/BalanceTransfer
This API is used to transfer the available balance transfer amount into other account (Loan/Credit) associated with different institution.
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 |
|
PayerAccountNumber string Mandatory |
Payer’s Account Number.(Card No. / Loan Account Number) Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
|
PayerAdminNumber int64 Mandatory |
Payer’s Admin Number. Valid Values:0-9 Format:XXXXXX Example:7314145404 |
|
PayeeAccountNumber string Mandatory |
Payee Account Number.(Card No. / Loan Account Number) Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
|
ReEnterPayeeAccountNumber string Mandatory |
This is the same Number as entered in PayeeAccountNumber for confirmation. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
|
PayeeAccountType string Mandatory |
Payee account type. 1 – Loan. 2 – Card. Allowable Values: 1 |
|
RequestedBTAmount decimal Mandatory |
Amount requested for Balance Transfer. |
|
CreditorsName string Conditional |
Creditor entity Name. Allowable Values: 50 |
|
PayeeAddressLine1 string Mandatory |
Payee Address Line 1. Allowable Values: 200 |
|
PayeeAddressLine2 string Optional |
Payee Address Line 2. Allowable Values: 200 |
|
PayeeAddressLine3 string Optional |
Payee Address Line 3. Allowable Values: 200 |
|
PayeeAddressLine4 string Optional |
Payee Address Line 4. Allowable Values: 200 |
|
PayeePostalCode integer Mandatory |
Payee Postal Code. Valid Values:0-9 Format:XXXXX Example:73141 |
|
PayeeCity string Mandatory |
City of Payee. Allowable Values: 100 |
|
PayeeState string Mandatory |
State of Payee. Allowable Values: 5 |
|
PayeeCountry string Mandatory |
Country of Payee. Allowable Values: 100 |
|
PromotionPlanID integer Mandatory |
ID of promotional plan. |
|
BTRequestType integer Mandatory |
This is a flag which identifies the type of request. Values: 1 : Verify 2 : Balance Transfer |
Sample request body
{
"Source": "Web",
"IPAddress": null,
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.205.0.56",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"PayerAccountNumber": "8110000000000018",
"PayerAdminNumber": null,
"PayeeAccountNumber": "8110000000000009 ",
"ReEnterPayeeAccountNumber": "8110000000000009",
"PayeeAccountType": "1",
"RequestedBTAmount": 47.0,
"CreditorsName": "ABCL",
"PayeeAddressLine1": "ABCL1",
"PayeeAddressLine2": "ABCL2",
"PayeeAddressLine3": "ABCL3",
"PayeeAddressLine4": "ABCL4",
"PayeePostalCode": 12345,
"PayeeCity": "Atlanta",
"PayeeState": "GA",
"PayeeCountry": "US",
"PromotionPlanID": 6115,
"BTRequestType": null
}
Response fields detail
| Fields | Description |
|---|---|
|
BalanceTransferStatus string |
Status received from the API. E.g. Successful/Declined/Hold etc. Allowable Values: 15 |
|
OriginatorPaymentID string |
This is the ID created at the issuer end. This ID will be acting as lifecycle ID. Allowable Values: 100 |
|
TransactionFeeAmount decimal |
Transaction Fee Amount ($). |
Sample response body
{
"application/json": {
"Message": "Balance Transfer Request Initiated successfully.",
"Status": true,
"ErrorCode": "ERR01600",
"ResponseData": {
"BalanceTransferStatus": "2",
"OriginatorPaymentID": null,
"TransactionFeeAmount": null
}
}
}
FlagTransactionForNoReward
Action: POST
Endpoint: /api/CoreCredit/Transactions/FlagTransactionForNoReward
This API is used to set the flag for Reward on a 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 |
|
TransactionID string Mandatory |
Transaction Number for transaction being posted. Valid Values:0-9 Example:23654789 Allowable Values: 20 |
|
RewardAction integer Mandatory |
This is the flag which updates the Rewards action on any transaction. If transaction is flagged, No Reward will Calculate on its Clearing. If transaction if unflagged, Reward will Calculate on its Clearing, if setup allows. Valid Values: 0 = Flagged, 1 = Unflagged Example: 0, 1 |
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": "182797659",
"RewardAction": 0
}
Response fields detail
| Fields | Description |
|---|---|
|
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9 Example:200 Allowable Values: 15 |
Sample response body
{
"application/json": {
"Message": "Transaction Flagged Successfully. No Reward will Calculate on its Clearing.",
"Status": true,
"ErrorCode": "ERR01161",
"ResponseData": {
"ResponseID": "56821650"
}
}
}