Core Card Api Quick Start

Get Merchant Statement

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantStatement

Use this API to obtain merchant statements by merchant IDs and statement dates.

Request fields details

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
MerchantID integer Conditional	Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549
MerchantStatementDate datetime Mandatory	Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY Example: 05/01/2020
ProductName string Mandatory	Reflects the name of product for the account Valid Values: a-z Format: xxxxxx Example: abcsolutionsrevolving Allowable Values: 50
Source string Mandatory	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 Mandatory	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 Mandatory	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	Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549
MerchantNumber string Conditional	Merchant Number which is assigned to a Merchant, Mandatory If Merchant ID not Inputted in API Request. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 9
MerchantStatementDate datetime Mandatory	Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY Example: 05/01/2020
ProductID integer Mandatory	ID assigned to a Program. Valid Values:0-9 Example:Fixed value provided by CoreCard.

Fields

Description

Source

string

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

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

CurrencyCode

string

Optional

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

Allowable Values:

CurrencySymbolType

string

Optional

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

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language == en: means use English ---- es: means Spanish

Allowable Values:

ExternalIP

string

IP Address of end user of API

Allowable Values:

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:

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:

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

Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549

MerchantStatementDate

datetime

Mandatory

Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY Example: 05/01/2020

ProductName

string

Mandatory

Reflects the name of product for the account Valid Values: a-z Format: xxxxxx Example: abcsolutionsrevolving

Allowable Values:

Source

string

Mandatory

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

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

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

Allowable Values:

Language

string

Optional

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

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

SessionID

string

Optional

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

Allowable Values:

100

APIVersion

string

Mandatory

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

Allowable Values:

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:

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:

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

Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549

MerchantNumber

string

Conditional

Merchant Number which is assigned to a Merchant, Mandatory If Merchant ID not Inputted in API Request. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549

Allowable Values:

MerchantStatementDate

datetime

Mandatory

Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY Example: 05/01/2020

ProductID

integer

Mandatory

ID assigned to a Program. Valid Values:0-9 Example:Fixed value 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,
  "MerchantID": 11629,
  "MerchantNumber": null,
  "MerchantStatementDate": "03/31/2016 00:00:00",
  "ProductID": 3399
}

Response fields details

Fields	Description
MerchantStatementAdjustmentList array	Header of Merchant Statement Adjustment Group Which will contain all details Adjustements as a
MerchantFeeBreakdownList array	Header of Merchant Fee Breakdown Details
GrandTotalList array	Header of Grand Total List, contains the Grand Totals for Transaction Volume, Transaction Counts and Merchant Fee
MerchantStatementHistoryList array	Header of Merchant Statement History array Which will contain all details for Each Transaction occured for the Merchant in an array.
MerchantStatementAdjustmentList array	Header of Merchant Statement Adjustment Group Which will contain all details Adjustements as a
MerchantFeeBreakdownList array	Header of Merchant Fee Breakdown Details
GrandTotalList array	Header of Grand Total List, contains the Grand Totals for Transaction Volume, Transaction Counts and Merchant Fee
MerchantStatementHistoryList array	Header of Merchant Statement History array Which will contain all details for Each Transaction occured for the Merchant in an array.

Sample response body

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "ERR0000",
  "ResponseData": {
    "MerchantStatementAdjustmentList": [
      {
        "MerchantName": "Andrisen Morton",
        "MerchantNumber": "35519",
        "MerchantStatementDate": "12/25/2015 00:00:00",
        "MerchantStatementFromDate": null,
        "MerchantStatementToDate": "12/25/2015 00:00:00",
        "ProductName": "ABC ECO",
        "GrossSalesCount": 48,
        "ReturnReversalsCount": 22,
        "GrossSalesAmount": 107665.37,
        "ReturnReversalsAmount": 84968.24,
        "MerchantFee": 538.32,
        "MerchantFeeReversal": 0.0,
        "NetAmountDue": 107127.05,
        "TotalAmountDue": 22158.81,
        "TotalAmountDueCount": 70
      }
    ],
    "MerchantFeeBreakdownList": [
      {
        "CreditPlanMaster": "Fixed APR of 3.99%-28.99% for 24 Months - 4.90",
        "TransactionCounts": 1,
        "MerchantRate": 4.9,
        "TransactionsVolume": 2000.0,
        "MerchantFee": -98.0
      }
    ],
    "GrandTotalList": [
      {
        "GrandTotalTransactionsVolume": 4054.0,
        "GrandTotalTransactionCounts": 4,
        "GrandTotalMerchantFee": -214.48
      }
    ],
    "MerchantStatementHistoryList": [
      {
        "PurchaseTranID": 1.2337203685480192E+17,
        "ReversalTranID": null,
        "Transactiontime": "01/15/2017 06:32:33",
        "TransactionPostTime": "01/15/2017 06:32:33",
        "TransactionAmount": 2000.0,
        "MerchantFee": -98.0,
        "CreditPlanMaster": "Fixed APR of 3.99%-28.99% for 24 Months - ",
        "CPMID": 6067,
        "TransactionDescription": "Purchase",
        "MerchantRate": 4.9,
        "NetSettlementAmount": 1902.0
      }
    ]
  }
}