Details about the main API

Introduction

ReportsV2 APIs allow you to perform the activities related to reports V2 operations.

The Reports V2 - Main APIs' end points and their functionalities are given below:

API End Point	API Functionality
GET /ReportsV2/DailyTotals	Get daily totals report
GET /ReportsV2/GetBackendTransactionChecks	Get the report that returns all the backend transactions
GET /ReportsV2/GetFNBOCustomersReport	Get the merchants report for the FNBO bank, closed or active merchants
GET /ReportsV2/GetReturnedMasterChecks	Get the report that returns all the failed master transactions

iCG Authentication Service

iCG APIs are secured by OAuth 2.0 ROPC grant type. The external application must obtain user authorization before it executes an endpoint call incase this API chooses to use OAuth 2.0 ROPC Grant. This authorization includes the following steps:

You must first exchange the user's credentials for an access token.
The access token is an object containing information for authorizing client requests and refreshing the token itself.

The end-to-end authorization request is represented in the below diagram.

sequenceDiagram
    participant Merchant
    participant ICG (token URL)
    autonumber
    Merchant ->>ICG (token URL): Client ID, username, password
    ICG (token URL)->>Merchant: id_token, access token, refresh token

The above step is to generate access token using the iCG provided Client id and with Merchant's user credentials.

Key Request Parameters

Once you receive the Client ID, and the user credentials, the next step is call the OAuth 2.0 ROPC endpoint to generate the access token.

Element	Value
Method	POST
Authorization Type	OAuth 2.0 ROPC
Auth URI	https://auth.icheckdev.com/
Client ID	*****(iCG application audience ID)
Username	{username}
Password	{password}
grant_type	password

Sample cURL Request

curl -X POST \

--url 'https://auth.icheckdev.com/Login' \

--header 'Accept: application/json' \

--data 'grant_type=password' \

--data 'username={USERNAME}' \

--data 'password={PASSWORD}' \

--data 'client_id={iCG APPLICATION AUDIENCE ID}' \

On receiving the requests, iCG Authorization system validates all the parameters in the request and, if the request pass through the validation process, then it will generate your access token and return it in the response.

Sample Response Body

{
"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJjNjFhY2JhYy02NjA4LTQ3Y2YtYWIxOS0wZWQ2YmY3NTI5MTciLCJ1bmlxdWVfbmFtZSI6IlN1c2VlbGEiLCJlbmNyeXB0ZWRfZW1haWwiOiJGcGJnZ1RqbTNkbXl2cFlWVlVZNnJzcHBDKzcweFIwWGoyeTR1Mm8rc1ZRPSIsInR5cGUiOiIiLCJpc3MiOiJodHRwczovL2F1dGguaWNoZWNrZGV2LmNvbS8iLCJhdWQiOiJmMWZhN2ZmZi05MmU0LTQxMzMtOGQxMC0zNjg2OGM0OTg3YWQiLCJleHAiOjE3MDQ5MDY1MjAsIm5iZiI6MTcwNDgyMDEyMH0.Q03E-HrXto9CBzHcC43qn2wZG5VpUV4hzIfcCuRGWu4"
"token_type":"bearer"
"expires_in":86399
}

The response parameters and their descriptions are:

Parameter	Description
access_token	The access token to be used to call the functional APIs
token_type	Bearer
expires_in	The number of seconds until the access token expires

Get Reports of Daily Totals

This endpoint allows the user to retrieve the daily totals report.

Key Request Parameter

Element	Values
Method	GET
Authorization	OAuth 2.0 ROPC
URI	/ReportsV2/DailyTotals

Note:

The user can find the details to generate token in iCG Authorization API section

Query Parameter

Parameter Name	Description	Mandatory/Optional	Data Type	Example
From	This is the Initial Date of Transactions	Mandatory	Date format	2023-01-11
To	This is the End Date of Transactions	Mandatory	Date format	2023-03-13

Sample cURL

curl --location 'https://api.icheckdev.com/ReportsV2/DailyTotals?from=2023-01-11&to=2023-03-13' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNTA2NzA3LCJuYmYiOjE3MTA0MjAzMDd9.1hAKjFdfC7YOVUXoW1sTHN70LmXkH_xGMakSZnZa_7Y'

Sample Response

{
"data": [
{
"siteId": null,
"paymentMethod": "Credit Card",
"paymentType": "VISA",
"count": 63,
"volume": 15488.48
},
{
"siteId": null,
"paymentMethod": "ACH Sales",
"paymentType": "CCD",
"count": 1,
"volume": 20.00
},
{
"siteId": null,
"paymentMethod": "ACH Sales",
"paymentType": "PPD",
"count": 31,
"volume": 1380.02
},
{
"siteId": null,
"paymentMethod": "ACH Sales",
"paymentType": "TEL",
"count": 15,
"volume": 72.00
},
],
"totalCount": 35
}

Get Reports of FNBO Customers Report

This endpoint allows the user to retrieve FNBO customers report.

Key Requests Parameter

Element	Values
Method	GET
Authorization	OAuth 2.0 ROPC
URI	/ReportsV2/GetFNBOCustomersReport

Note

The user can find the details to generate token in iCG Authorization API section

Query Parameter

Parameter Name	Description	Mandatory/Optional	Data Type	Example
From	This is the Initial Date of Transactions	Mandatory	Date format	2023-01-11
To	This is the End Date of Transactions	Mandatory	Date format	2023-03-13

Sample cURL

curl --location 'https://api.icheckdev.com/ReportsV2/GetFNBOCustomersReport?from=2023-01-01&to=2023-01-31' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNTA2NzA3LCJuYmYiOjE3MTA0MjAzMDd9.1hAKjFdfC7YOVUXoW1sTHN70LmXkH_xGMakSZnZa_7Y'

Sample Response

{
"data": [],
"totalCount": 0
}

Get Reports of Returned Master Checks

This endpoints allows the user to retrieve returned master checks report

Key Requests Parameter

Element	Values
Method	GET
Authorization	OAuth 2.0 ROPC
URI	/ReportsV2/GetReturnedMasterChecks

Note

The user can find the details to generate token in iCG Authorization API section

Query Parameter

Parameter Name	Description	Mandatory/Optional	Data Type	Example
From	This is the Initial Date of Transactions	Mandatory	Date format	2023-01-11
To	This is the End Date of Transactions	Mandatory	Date format	2023-02-13

Sample cURL

curl --location 'https://api.icheckdev.com/ReportsV2/GetReturnedMasterChecks?from=2023-01-11&to=2023-02-13' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNTA2NzA3LCJuYmYiOjE3MTA0MjAzMDd9.1hAKjFdfC7YOVUXoW1sTHN70LmXkH_xGMakSZnZa_7Y

Sample Response

{
"data": [
{
"id": 24923,
"confirmationId": "EL1E5471643c947",
"returnDate": "2023-09-06T00:00:00",
"returnCode": "R37",
"amount": 10.0000,
"siteId": "EL1E",
"routing": "123123123",
"bankName": "FNBO",
"type": "C"
},
{
"id": 25005,
"confirmationId": "EEJTa624046698f",
"returnDate": "2023-09-06T00:00:00",
"returnCode": "R21",
"amount": 1587.4700,
"siteId": "EEJT",
"routing": "092900383",
"bankName": "FNBO",
"type": "D"
},
{
"id": 25035,
"confirmationId": "EEJTd0fb8b3b9e7",
"returnDate": "2023-09-06T00:00:00",
"returnCode": "R23",
"amount": 1.0000,
"siteId": "EEJT",
"routing": "092900383",
"bankName": "FNBO",
"type": "D"
},
{
"id": 25116,
"confirmationId": "EEJTf9064b51a3f",
"returnDate": "2023-09-06T00:00:00",
"returnCode": "R25",
"amount": 10.0000,
"siteId": "EEJT",
"routing": "092900383",
"bankName": "FNBO",
"type": "D"
}
],
"totalCount": 4
}

Get Reports of Backend Transaction Checks

This endpoint allows the user to retrieve backend transaction checks report.

Key Requests Parameter

Element	Values
Method	GET
Authorization	OAuth 2.0 ROPC
URI	/ReportsV2/GetBackendTransactionChecks

Note

The user can find the details to generate token in iCG Authorization API section

Query Parameter

Parameter Name	Description	Mandatory/Optional	Data Type	Example
From	This is the Initial Date of Transactions	Mandatory	Date format	2023-01-11
To	This is the End Date of Transactions	Mandatory	Date format	2023-02-13

Sample cURL

curl --location 'https://api.icheckdev.com/ReportsV2/GetBackendTransactionChecks?from=2023-01-11&to=2023-02-13' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNTA2NzA3LCJuYmYiOjE3MTA0MjAzMDd9.1hAKjFdfC7YOVUXoW1sTHN70LmXkH_xGMakSZnZa_7Y'

Sample Response

{
"data": [
{
"id": 24830,
"amount": 1.0000,
"batchID": "FB8AD18",
"batchDate": "2023-01-11T01:50:53",
"batchDescription": "ACH PROCESSING - Tel",
"effectiveDate": "2023-06-22T00:00:00",
"batchStatus": "H",
"bankName": "FNBO",
"batchType": "D",
"siteId": "EEJT"
},
{
"id": 24922,
"amount": 10.0000,
"batchID": "39A5046",
"batchDate": "2023-01-15T02:00:04",
"batchDescription": "ravi teja",
"effectiveDate": "2023-01-20T00:00:00",
"batchStatus": "B",
"bankName": "FNBO",
"batchType": "C",
"siteId": "EL1E"
},
{
"id": 24958,
"amount": 1587.4700,
"batchID": "E215DAE",
"batchDate": "2023-01-17T19:00:06",
"batchDescription": "ACH PROCESSING - Ppd",
"effectiveDate": "2023-01-21T00:00:00",
"batchStatus": "B",
"bankName": "FNBO",
"batchType": "D",
"siteId": "EEJT"
},

],
"totalCount": 9
}

To view our list of APIs, please visit the Main API page.

Developer Reference Docs

ReportsV2 - Main API

iCG Authentication Service

Key Request Parameters

Sample cURL Request

Sample Response Body