Get Merchant Statement V1
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantStatementV1
This API is Used to Get the Merchant Statement details.
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 |
Unique number of merchant account. Valid Values:0-9 Example:17588 Condition: Mandatory If MerchantNumber not Inputted in API Request. |
|
MerchantNumber string Conditional |
Merchant Number which is assgined to a Merchant. Valid Values:0-9 Example:205136549 Condition: Mandatory If MerchantID not Inputted in API Request. Allowable Values: 9 |
|
MerchantStatementDate datetime Mandatory |
Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY HH:mm:ss Example: 05/01/2020 23:00:02 |
|
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 |
Unique number of merchant account. Valid Values:0-9 Example:17588 Condition: Mandatory If MerchantNumber not Inputted in API Request. |
|
MerchantNumber string Conditional |
Merchant Number which is assgined to a Merchant. Valid Values:0-9 Example:205136549 Condition: Mandatory If MerchantID not Inputted in API Request. Allowable Values: 9 |
|
MerchantStatementDate datetime Mandatory |
Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY HH:mm:ss Example: 05/01/2020 23:00:02 |
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,
"MerchantID": 11269,
"MerchantNumber": null,
"MerchantStatementDate": "01/13/2017 23:00:02"
}
Response fields details
| Fields | Description |
|---|---|
|
NewSales decimal |
Indicates amount of New Sales for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
InStoreOtherCredits decimal |
Indicates amount of In Store Other Credits for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
InStoreOtherDebits decimal |
Indicates amount of In Store Other Debits for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
Discount decimal |
Indicates amount of Total Discount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NewReturnsOrCredits decimal |
Indicates amount of New Returns or Credits for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetThisReport decimal |
Indicates Net amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
LessInStorePayments decimal |
Indicates Less instore payments amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetActivitythisreport decimal |
Indicates Net Activity amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
ChangeReservePreviousBilling decimal |
Indicates the Change in Reserve Amount than Previous Billing Cycle Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
BaseFee decimal |
Indicates Base Fee amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
AccountsFee decimal |
Indicates Accounts Fee amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PrimeRateAdjustments decimal |
Indicates Prime Rate Adjustments amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
OtherCharges decimal |
Indicates Other Charges amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetthisProcessing decimal |
Net Amount for this processing period for the Merchant Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
BalanceforwardPreviousSettlement decimal |
Indicates Balance Forwarded from Previous Settlements amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetSettlement decimal |
Indicates Net Settlement amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
CurrentReserve decimal |
Indicates Current Reserve amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PreviousReserve decimal |
Indicates Previous Reserve amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
OutstandingBalanceAccounts decimal |
Indicates Outstanding Balance on Accounts amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PrimeRateKicker decimal |
Prime Rate Kicker Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PrimeRateFloor string |
Prime Rate Floor Valid Values:0-9 Format: $XXX.XX Example: $500.00 Allowable Values: 5 |
|
MerchantStatementDate datetime |
Date for which Merchant statement is generated Valid Values:0-9 Format:MM/DD/YYYY Example:05/01/2020 |
|
MerchantFeeBreakdownList array |
Header of Merchant Fee Breakdown Details |
|
NewSales decimal |
Indicates amount of New Sales for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
InStoreOtherCredits decimal |
Indicates amount of In Store Other Credits for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
InStoreOtherDebits decimal |
Indicates amount of In Store Other Debits for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
Discount decimal |
Indicates amount of Total Discount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NewReturnsOrCredits decimal |
Indicates amount of New Returns or Credits for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetThisReport decimal |
Indicates Net amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
LessInStorePayments decimal |
Indicates Less instore payments amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetActivitythisreport decimal |
Indicates Net Activity amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
ChangeReservePreviousBilling decimal |
Indicates the Change in Reserve Amount than Previous Billing Cycle Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
BaseFee decimal |
Indicates Base Fee amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
AccountsFee decimal |
Indicates Accounts Fee amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PrimeRateAdjustments decimal |
Indicates Prime Rate Adjustments amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
OtherCharges decimal |
Indicates Other Charges amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetthisProcessing decimal |
Net Amount for this processing period for the Merchant Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
BalanceforwardPreviousSettlement decimal |
Indicates Balance Forwarded from Previous Settlements amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
NetSettlement decimal |
Indicates Net Settlement amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
CurrentReserve decimal |
Indicates Current Reserve amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PreviousReserve decimal |
Indicates Previous Reserve amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
OutstandingBalanceAccounts decimal |
Indicates Outstanding Balance on Accounts amount for the Statement Period Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PrimeRateKicker decimal |
Prime Rate Kicker Valid Values:0-9 Format: $XXX.XX Example: $500.00 |
|
PrimeRateFloor string |
Prime Rate Floor Valid Values:0-9 Format: $XXX.XX Example: $500.00 Allowable Values: 5 |
|
MerchantStatementDate datetime |
Date for which Merchant statement is generated Valid Values:0-9 Format:MM/DD/YYYY Example:05/01/2020 |
|
MerchantFeeBreakdownList array |
Header of Merchant Fee Breakdown Details |
Sample response body
{
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"NewSales": 39466.27,
"InStoreOtherCredits": 0.0,
"InStoreOtherDebits": 0.0,
"Discount": 236.8,
"NewReturnsOrCredits": 12324.67,
"NetThisReport": 26904.8,
"LessInStorePayments": 12487.76,
"NetActivitythisreport": 14417.04,
"ChangeReservePreviousBilling": 0.0,
"BaseFee": 0.0,
"AccountsFee": 0.0,
"PrimeRateAdjustments": 0.0,
"OtherCharges": 0.0,
"NetthisProcessing": 0.0,
"BalanceforwardPreviousSettlement": -1201.33,
"NetSettlement": 13215.71,
"CurrentReserve": 0.0,
"PreviousReserve": 246989.82,
"OutstandingBalanceAccounts": 591928.87,
"PrimeRateKicker": 4.25,
"PrimeRateFloor": "5.50",
"MerchantStatementDate": "01/13/2017 23:00:02",
"MerchantFeeBreakdownList": null
}
}