Reports - Main API

Introduction

Reports APIs allow you to perform the activities related to reports operations.

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

API End Point
API Functionality
GET /Reports
Get user activity logs of all items from report
Create a new report
Get report by id
Update a report
Delete report
POST /ReportUserActivityLogsMain
Create a new report
GET /ReportNotificationofChange
Get notification of change from report item
GET /ReportNotificationofChangeDuplications
Get notification of change duplications from report item
GET /ReportPendingCheckBatches
Get pending check batches get from report item
GET /ReportReturnedChecks
Get returned checks get from report item
GET /Reports/{source}
Get all custom reports by source
Get check refund batch details report
Get check refund batches report
Get credit card batch details report
Get credit card batches report
Get declined checks report
Get declined credit cards report
Get late returned checks report
Get the transactions that has notifications of change in the date range
Get pending check batch details report
Get pending check batches report
GET /Reports/PFMReport
Get PFM report
Get returned checks report
Get settled check batch details report
Get settled check batched report
Get transactions by merchant
Get transactions by processors
Get summary of transactions settled in a timeframe
Get summary of transactions settled by merchant
Get transactions status
Get transactions view today
Get User Activity Logs
GET /ReportSettledCheckBatches
Get settled check batches get from report item
GET /ReportUserActivityLogsMain
Get user activity logs of all items from rport

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

Create Report

This endpoint allows the user to create a new report.

Key Request Parameters

Element Value
Method POST
Authorization Type OAuth 2.0 ROPC
URI /Reports

Note:

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

Request body parameters

Parameter Name Description Mandatory/Optional Data Type Example
UserName The username Mandatory String JohnF
MerchantCode The code of the Merchant Mandatory String  
Name The name of the user Mandatory String

Minimum Length: 0

Maximum Length: 45
Source The source  Mandatory String

Minimum Length: 0

Maximum Length: 255
Fields   Optional  

 
Filters   Optional  

 

Sample cURL Request

curl --location 'https://api.icheckdev.com/Reports' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMjUyMzk2LCJuYmYiOjE3MTAxNjU5OTZ9.cZc4ebcIMx_eVO-wvmsYXtreEkbEVQAWRc2OPZ_g-6w' \
--data '{
  "UserName": "suseelas",
  "MerchantCode": "SEDZ",
  "Name": "Suseela Subramanian",
  "Source": "Checks",
  "Id": "1",
  "Fields": "<string>",
  "Filters": "<string>"
}'

Sample Response Body

{
    "merchant": null,
    "id": 8,
    "userName": "suseelas",
    "merchantId": 0,
    "name": "Suseela Subramanian",
    "source": "Checks",
    "fields": "<string>",
    "filters": "<string>",
    "merchantCode": "SEDZ"
} 

 

Get Report by ID

This endpoint allows the user to retrieve the report of the specific ID.

Key Request Parameters

Element Value
Method GET
Authorization Type OAuth 2.0 ROPC
URI /Reports/:id

Note:

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

Sample cURL Request

curl --location 'https://api.icheckdev.com/Reports/8' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMjUyMzk2LCJuYmYiOjE3MTAxNjU5OTZ9.cZc4ebcIMx_eVO-wvmsYXtreEkbEVQAWRc2OPZ_g-6w'
 

Sample Response Body

{
    "merchant": null,
    "id": 8,
    "userName": "suseelas",
    "merchantId": 404,
    "name": "Suseela Subramanian",
    "source": "Checks",
    "fields": "<string>",
    "filters": "<string>",
    "merchantCode": "SEDZ"
}
 

Modify the data in the specific Report

This endpoint allows the user to do changes in the data in a specific report.

Key Request Parameters

Element Value
Method PUT
Authorization Type OAuth 2.0 ROPC
URI /Reports/:id

Note:

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

Request body Parameters

Parameter Name Description Mandatory/Optional Data Type Example
UserName The username Mandatory String JohnF
MerchantCode The code of the Merchant Mandatory String  
Name The name of the user Mandatory String

Minimum Length: 0

Maximum Length: 45
Source The source  Mandatory String

Minimum Length: 0

Maximum Length: 255
Fields   Optional  

 
Filters   Optional  

 

Sample cURL

curl --location --request PUT 'https://api.icheckdev.com/Reports/8' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMzM3NTUzLCJuYmYiOjE3MTAyNTExNTN9.ErIBckID5r7XEwHm_dXz35gY9K4JecgdtIBcY0jlSKU' \
--data '{
  "UserName": "suseelas",
  "MerchantCode": "FDNT",
  "Name": "Priya Gopal",
  "Source": "ACH",
  "Id": "8",
  "Fields": "<string>",
  "Filters": "<string>"
}'

Sample Response

{
    "merchant": null,
    "id": 8,
    "userName": "suseelas",
    "merchantId": 0,
    "name": "Priya Gopal",
    "source": "ACH",
    "fields": "<string>",
    "filters": "<string>",
    "merchantCode": "FDNT"
}

Delete Report by specific ID

This endpoint allows the user to delete a specific report.

Key Request Parameter

Element  Value
Method Delete
Authorization OAuth 2.0 ROPC
URI /Reports/:id

Note:

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

Sample cURL

curl --location --request DELETE 'https://api.icheckdev.com/Reports/8' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMzM3NTUzLCJuYmYiOjE3MTAyNTExNTN9.ErIBckID5r7XEwHm_dXz35gY9K4JecgdtIBcY0jlSKU'

Sample Response

"Report Deleted"

Get Reports of Check Refund Batches

This endpoints allow the user to retrieve the Check Refund Batched report

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/CheckRefundBatches

Note:

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

Query Parameters

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

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/CheckRefundBatches?from=11-01-2023&to=12-03-2024' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMzQ2MzA3LCJuYmYiOjE3MTAyNTk5MDd9.haEJqNJiG2P-8n-gvn_m4Ty0mY7g3iOpUFJdulLDG2k'

Sample Response

[
    {
        "subMerchants": null,
        "batchID": 2003,
        "batchIDStr": "905BD717EEA046689DA5AA8A6EC30D",
        "batchDate": "2023-11-21T00:00:00",
        "netRefund": 15.5200,
        "batchStatus": "S",
        "id": 0,
        "parentMerchantId": null,
        "code": "FDJT",
        "name": "FD Ecommerce Jose Test",
        "status": null
    },
    {
        "subMerchants": null,
        "batchID": 2005,
        "batchIDStr": "D73DECAE703243F3B22B56DDD51731",
        "batchDate": "2023-11-22T00:00:00",
        "netRefund": 176.1800,
        "batchStatus": "S",
        "id": 0,
        "parentMerchantId": null,
        "code": "FDJT",
        "name": "FD Ecommerce Jose Test",
        "status": null
    },
    {
        "subMerchants": null,
        "batchID": 2008,
        "batchIDStr": "C8F3157F4C6E424AACF530A93749F0",
        "batchDate": "2023-11-22T00:00:00",
        "netRefund": 98.3100,
        "batchStatus": "S",
        "id": 0,
        "parentMerchantId": null,
        "code": "FDJT",
        "name": "FD Ecommerce Jose Test",
        "status": null
    },
    {
        "subMerchants": null,
        "batchID": 2043,
        "batchIDStr": "B3285ACF46AC4B7CB1EC7346ACEECD",
        "batchDate": "2023-12-08T00:00:00",
        "netRefund": 342.9900,
        "batchStatus": "S",
        "id": 0,
        "parentMerchantId": null,
        "code": "FDJT",
        "name": "FD Ecommerce Jose Test",
        "status": null
    }
]

Get Reports of Credit Card Batches

This endpoints allows the user to retrieve Credit Card Batches report.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/CreditCardBatches

Note:

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

Query Parameters

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

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/CreditCardBatches?from=11-01-2023&to=12-03-2024' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMzQ2MzA3LCJuYmYiOjE3MTAyNTk5MDd9.haEJqNJiG2P-8n-gvn_m4Ty0mY7g3iOpUFJdulLDG2k'

Sample Response

[

   {

       "subMerchants": null,

       "id": 1987,

       "batchId": "d069d1553a7342638deb250973c649ca",

       "batchDate": "2023-11-01T14:06:07",

       "debitsSales": 1.0700,

       "creditsRefunds": 1.0000,

       "netDeposit": 0.0700,

       "parentMerchantId": null,

       "code": "EEJT",

       "name": "Elavon Ecommerce Jose Test",

       "status": null

   },

   {

       "subMerchants": null,

       "id": 1988,

       "batchId": "54a0b90a52a34b6dbdaaa929465ad71d",

       "batchDate": "2023-11-02T07:00:10",

       "debitsSales": 682.0000,

       "creditsRefunds": 0.0000,

       "netDeposit": 682.0000,

       "parentMerchantId": null,

       "code": "TEJT",

       "name": "TSYS Ecommerce Jose Test",

       "status": null

   },

   {

       "subMerchants": null,

       "id": 1989,

       "batchId": "526d24b9982746088d95a41006206d33",

       "batchDate": "2023-11-02T11:17:20",

       "debitsSales": 11.0000,

       "creditsRefunds": 0.0000,

       "netDeposit": 11.0000,

       "parentMerchantId": null,

       "code": "FDJT",

       "name": "FD Ecommerce Jose Test",

       "status": null

   }

 ]

Get Reports of Declined Checks

This endpoint allows the user to retrieve reports of declined Checks

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/DeclinedChecks

Note:

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

Query Parameters

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

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/DeclinedChecks?from=11-01-2023&to=12-02-2023' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMzQ2MzA3LCJuYmYiOjE3MTAyNTk5MDd9.haEJqNJiG2P-8n-gvn_m4Ty0mY7g3iOpUFJdulLDG2k'

Sample Response

[

   {

       "subMerchants": null,

       "customerName": "Santosh",

       "amount": 22.4500,

       "entryClassCode": "PPD",

     "confirmationId": "SEDZAFB574385730",

       "dReason": "ACH Credit transactions not allowed for Merchant: ",

       "display": "******7890",

       "dateTimeTransaction": "2023-11-08T01:55:21",

       "transactionId": 28607,

       "id": 0,

        "parentMerchantId": null,

       "code": "SEDZ",

       "name": "iCheckGateway.com",

       "status": null

   },

   {

       "subMerchants": null,

       "customerName": "Santosh",

       "amount": 1.0000,

       "entryClassCode": "PPD",

       "confirmationId": "SEDZB00CD1F5F4B8",

       "dReason": "ACH Credit transactions not allowed for Merchant: ",

       "display": "******7890",

       "dateTimeTransaction": "2023-11-08T01:55:34",

       "transactionId": 28608,

       "id": 0,

       "parentMerchantId": null,

       "code": "SEDZ",

       "name": "iCheckGateway.com",

       "status": null

   },

   {

       "subMerchants": null,

       "customerName": "Carl H Jessry",

       "amount": 11.4500,

       "entryClassCode": "CCD",

       "confirmationId": "SEDZC401345186D6",

       "dReason": "ACH Credit transactions not allowed for Merchant: ",

       "display": "******7890",

       "dateTimeTransaction": "2023-11-10T01:45:18",

       "transactionId": 28622,

       "id": 0,

       "parentMerchantId": null,

       "code": "SEDZ",

       "name": "iCheckGateway.com",

       "status": null

   }

 ]

Get Reports of Check Refund Batch Details by Batch ID

This endpoint allows the user to retrieve reports of Check refund batch details by Batch ID

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/CheckRefundBatchDetails/{batchId}

Note:

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

Header Parameter

Parameter Name Description  Data Type Mandatory/Optional Example
batchId This is the batch ID Alphanumeric Mandatory 39A5046

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/CheckRefundBatchDetails/39A5046' \
--header 'batchId: 39A5046' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwMzQ2MzA3LCJuYmYiOjE3MTAyNTk5MDd9.haEJqNJiG2P-8n-gvn_m4Ty0mY7g3iOpUFJdulLDG2k'

Sample Response

[
    {
        "batchDate": "2023-01-14T00:00:00",
        "dateTimeTransaction": "2023-01-13T13:33:00",
        "settledDate": "2023-01-20T00:00:00",
        "entryClassCode": "PPD",
        "confirmationId": "EL1Eccfd6b32934",
        "customerName": "ravi teja",
        "custom1": null,
        "display": "**3456",
        "status": "S",
        "amount": 10.0000,
        "type": "C"
    }
]

Get Reports of Credit Card Batch details

This endpoint allows the user to retrieve the Credit Card Batch details report for a specific batch ID.

Key Request Parameter

Element  Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/CreditCardBatchDetails/{batchId}

Note:

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

Header Parameters

Parameter Description Data Type Mandatory/Optional Example
batchId This is the batchId String Mandatory d069d1553a7342638deb250973c649ca

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/CreditCardBatchDetails/d069d1553a7342638deb250973c649ca' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "batchID": 0,
        "batchDate": "2023-11-01T14:06:06",
        "dateTimeTransaction": "10/31/2023 6:54:28 PM",
        "transactionDate": "2023-10-31T18:54:28Z",
        "confirmationId": "EEJT2800D517A800",
        "customerName": "Dummy Last",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "cardType": "VI",
        "display": "************1111",
        "amount": 1.0000,
        "settledDate": "2023-11-01T14:06:06",
        "status": "S",
        "type": "C",
        "referenceNumber": "",
        "statusAck": null,
        "batchUniqueId": null,
        "transactionId": 28535
    },
    {
        "batchID": 0,
        "batchDate": "2023-11-01T14:06:06",
        "dateTimeTransaction": "11/1/2023 3:58:11 PM",
        "transactionDate": "2023-11-01T15:58:11Z",
        "confirmationId": "EEJTE227D124ADA5",
        "customerName": "Name ",
        "custom1": "123",
        "custom2": "",
        "custom3": "",
        "cardType": "VI",
        "display": "************1111",
        "amount": 1.0000,
        "settledDate": "2023-11-01T14:06:06",
        "status": "S",
        "type": "D",
        "referenceNumber": "1101155812",
        "statusAck": null,
        "batchUniqueId": null,
        "transactionId": 28536
    },
    {
        "batchID": 0,
        "batchDate": "2023-11-01T14:06:06",
        "dateTimeTransaction": "11/1/2023 4:06:47 PM",
        "transactionDate": "2023-11-01T16:06:47Z",
        "confirmationId": "EEJTAC72C0631D4F",
        "customerName": "luis benavides",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "cardType": "VI",
        "display": "************2221",
        "amount": 0.0700,
        "settledDate": "2023-11-01T14:06:06",
        "status": "S",
        "type": "D",
        "referenceNumber": "1101160647",
        "statusAck": null,
        "batchUniqueId": null,
        "transactionId": 28537
    }
 ]

Get Reports of Declined Credit Cards

This endpoint allows the user to retrieve reports of declined credit cards

Key Request Parameters

Element Value
Method GET
Authorization Type OAuth 2.0 ROPC
URI /Reports/DeclinedCreditCards

Note:

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

Query Parameters

Parameter Name Description Mandatory/Optional Data Type Example
From date This is the Initial Date of Transactions Mandatory Date format 2010-06-04
To date This is the End Date of Transactions Mandatory Date format 2010-06-08

Sample cURL Request

curl --location 'https://api.icheckdev.com/Reports/DeclinedCreditCards?from=2021-03-05&to=2021-03-08' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzA5ODI2ODgxLCJuYmYiOjE3MDk3NDA0ODF9.9XFTKSCF7SIwhH5HYCu7ULce-OlTc4N9fjZKU-iPRuY'

Sample Response Body

[{"subMerchants":null,"customerName":"ICG QA - Lisandro Kuphal","amount":736.0000,"confirmationId":"FDE1T26374737C979","dReason":null,"display":"************9990","cardType":"VI","dateTimeTransaction":"2021-03-05T21:28:18","transactionId":3212,"id":0,"parentMerchantId":null,"code":"FDE1T","name":"FirstData Ecommerce 1 Test","status":null},{"subMerchants":null,"customerName":"ICG QA - Alva Schaden","amount":922.0000,"confirmationId":"FDE1T17060CEA06CE","dReason":null,"display":"************1111","cardType":"VI","dateTimeTransaction":"2021-03-05T21:29:04","transactionId":3213,"id":0,"parentMerchantId":null,"code":"FDE1T","name":"FirstData Ecommerce 1 Test","status":null},{"subMerchants":null,"customerName":"ICG QA - Kayli Senger","amount":89.0000,"confirmationId":"FDE1T31E99D47FA9A","dReason":null,"display":"************2228","cardType":"VI","dateTimeTransaction":"2021-03-05T21:30:00","transactionId":3214,"id":0,"parentMerchantId":null,"code":"FDE1T","name":"FirstData Ecommerce 1 Test","status":null},{"subMerchants":null,"customerName":"Brian Platz","amount":160.0000,"confirmationId":"TS1E6F3CAFE589B4","dReason":null,"display":"************1378","cardType":"MC","dateTimeTransaction":"2021-03-08T19:19:43","transactionId":3224,"id":0,"parentMerchantId":null,"code":"TS1E","name":"Tsys Ecommerce Test","status":null}]
 
Get Pending Check Batches Report
This endpoint allows to retrieve the pending check batches report.
 

Key Request Parameters

Element Value
Method GET
Authorization Type OAuth 2.0 ROPC
URI /Reports/PendingCheckBatches

Note:

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

Sample cURL Request

curl --location 'https://api.icheckdev.com/Reports/PendingCheckBatches' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response Body

[

   {

       "subMerchants": null,

       "batchID": "232A78727B064CD5A32C38AA84A56E",

       "batchDate": "2023-09-08T00:00:00",

       "id": 0,

       "parentMerchantId": null,

       "code": "XXZ7",

       "name": "RebiyaTesting2",

       "status": null

   },

   {

       "subMerchants": null,

       "batchID": "F76E5BA091864EC093A384F29E05D4",

       "batchDate": "2023-09-08T00:00:00",

       "id": 0,

       "parentMerchantId": null,

       "code": "SEDZ",

       "name": "iCheckGateway.com",

       "status": null

   },

   {

       "subMerchants": null,

       "batchID": "7E72331F240F4BBF823C5B4CE7DF97",

       "batchDate": "2023-09-08T00:00:00",

       "id": 0,

       "parentMerchantId": null,

       "code": "SEDZ",

       "name": "iCheckGateway.com",

       "status": null

   }

 ]

GET Reports of Late Returned Checks

This endpoint allows the user to retrieve late returned checks reports

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/LateReturnedChecks

 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 date This is the Initial Date of Transactions Mandatory Date format 2023-01-11
To date This is the End Date of Transactions Mandatory Date format 2023-12-12

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/LateReturnedChecks?from=2023-01-11&to=2023-12-12' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[

   {

       "subMerchants": null,

       "date": "2023-09-13T00:00:00",

       "confirmationId": "EEJT1b958efc55a",

       "customerName": "Velva O'Hara",

       "display": "*****6238",

       "custom1": "",

       "returnCode": "R47",

       "returnCodeDesc": "Duplicate enrollment",

       "amount": 69.0500,

       "transactionId": 24521,

       "id": 0,

       "parentMerchantId": null,

       "code": "EEJT",

       "name": "Elavon Ecommerce Jose Test",

       "status": null

   },

   {

       "subMerchants": null,

       "date": "2023-05-30T00:00:00",

       "confirmationId": "XY9Gcc9de184aca",

       "customerName": "dfsfd dsfsasdasd",

       "display": "****1234",

       "custom1": "Test Custom1",

       "returnCode": "R65",

       "returnCodeDesc": "Incorrect transaction code",

       "amount": 10.0000,

       "transactionId": 25173,

       "id": 0,

       "parentMerchantId": null,

       "code": "XY9G",

       "name": "sdfsdf",

       "status": null

   }

 ]

 GET Reports of Transactions Processor

This endpoint allows the user to retrieve transactions processor report.

Key Request Parameter

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/TransactionsProcessor

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
transactionType The type of transaction Mandatory string CC or ACH
date This is the report date Mandatory Date format 2023-03-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/TransactionsProcessor?transactionType=CC&date=2023-01-11' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "period": "Bofa",
        "processedSalesRecordAmount": 0.0,
        "processedReturnsRecordAmount": 0.0,
        "processedSalesRecordVolume": 0,
        "processedReturnsRecordVolume": 0,
        "notProcessedSalesRecordAmount": 0.0,
        "notProcessedReturnsRecordAmount": 0.0,
        "notProcessedSalesRecordVolume": 0,
        "notProcessedReturnsRecordVolume": 0,
        "approvedSalesRecordAmount": 0.0,
        "approvedReturnsRecordAmount": 0.0,
        "approvedSalesRecordVolume": 0,
        "approvedReturnsRecordVolume": 0,
        "partiallyApprovedSalesRecordAmount": 0.0,
        "partiallyApprovedReturnsRecordAmount": 0.0,
        "partiallyApprovedSalesRecordVolume": 0,
        "partiallyApprovedReturnsRecordVolume": 0,
        "settledSalesRecordAmount": 0.0,
        "settledReturnsRecordAmount": 0.0,
        "settledSalesRecordVolume": 0,
        "settledReturnsRecordVolume": 0,
        "declinedSalesRecordAmount": 0.0,
        "declinedReturnsRecordAmount": 0.0,
        "declinedSalesRecordVolume": 0,
        "declinedReturnsRecordVolume": 0,
        "voidedSalesRecordAmount": 0.0,
        "voidedReturnsRecordAmount": 0.0,
        "voidedSalesRecordVolume": 0,
        "voidedReturnsRecordVolume": 0,
        "refundedSalesRecordAmount": 0.0,
        "refundedReturnsRecordAmount": 0.0,
        "refundedSalesRecordVolume": 0,
        "refundedReturnsRecordVolume": 0,
        "returnedSalesRecordAmount": 0.0,
        "returnedReturnsRecordAmount": 0.0,
        "returnedSalesRecordVolume": 0,
        "returnedReturnsRecordVolume": 0,
        "errorSalesRecordAmount": 0.0,
        "errorReturnsRecordAmount": 0.0,
        "errorSalesRecordVolume": 0,
        "errorReturnsRecordVolume": 0
    }
 ]

GET Reports of Pending Check Batch Details by Batch Id

This endpoint allows the user to retrieve the pending check batch details report by batch Id.

Key Request Parameters

Element  Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/PendingCheckBatchDetails/{batchId}

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
batchId This is the batch Id Mandatory string 7E72331F240F4BBF823C5B4CE7DF97

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/PendingCheckBatchDetails/7E72331F240F4BBF823C5B4CE7DF97' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "batchDate": "2023-09-08T00:00:00",
        "dateTimeTransaction": "2023-09-08T07:47:00",
        "settledDate": null,
        "entryClassCode": "CCD",
        "confirmationId": "SEDZe51735dc4e1",
        "customerName": "Santosh Lenka",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "display": "******7890",
        "status": "B",
        "amount": 10.2300,
        "batchId": "7E72331F240F4BBF823C5B4CE7DF97",
        "type": "D",
        "transactionId": 27484,
        "returnCode": ""
    }
 ]

GET Reports of Transactions Settled

This endpoint allows the user to retrieve the transactions settled report.

Key Request Parameters 

Element  Value
Method GET
Authorization OAuth 2.0 ROPC
URI  /Reports/TransactionsSettled

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
transactionType The type of transaction Mandatory string CC or ACH
date This is the report date Mandatory Date format 2023-03-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/TransactionsSettled?transactionType=ACH&date=2023-3-31' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[

 {

       "period": null,

       "day": 0,

       "month": 0,

       "year": 0,

       "type": null,

       "volume": 0.0,

       "count": 0,

       "fullDate": "2023-03-30T00:00:00",

      "salesAmount": 0.0,

       "returnsAmount": 0.0,

       "salesRecord": 0,

       "returnsRecord": 0

   }

 ]

GET Reports of Transactions Merchant

This endpoint allows the user to retrieve the transactions merchant reports.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC
URI /Reports/TransactionsMerchant

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
transactionType The type of transaction Mandatory string CC or ACH
date This is the report date Mandatory Date format 2023-03-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/TransactionsMerchant?transactionType=CC&date=2023-01-11' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "period": "XY7H",
        "processedSalesRecordAmount": 0.0,
        "processedReturnsRecordAmount": 0.0,
        "processedSalesRecordVolume": 0,
        "processedReturnsRecordVolume": 0,
        "notProcessedSalesRecordAmount": 0.0,
        "notProcessedReturnsRecordAmount": 0.0,
        "notProcessedSalesRecordVolume": 0,
        "notProcessedReturnsRecordVolume": 0,
        "approvedSalesRecordAmount": 0.0,
        "approvedReturnsRecordAmount": 0.0,
        "approvedSalesRecordVolume": 0,
        "approvedReturnsRecordVolume": 0,
        "partiallyApprovedSalesRecordAmount": 0.0,
        "partiallyApprovedReturnsRecordAmount": 0.0,
        "partiallyApprovedSalesRecordVolume": 0,
        "partiallyApprovedReturnsRecordVolume": 0,
        "settledSalesRecordAmount": 0.0,
        "settledReturnsRecordAmount": 0.0,
        "settledSalesRecordVolume": 0,
        "settledReturnsRecordVolume": 0,
        "declinedSalesRecordAmount": 0.0,
        "declinedReturnsRecordAmount": 0.0,
        "declinedSalesRecordVolume": 0,
        "declinedReturnsRecordVolume": 0,
        "voidedSalesRecordAmount": 0.0,
        "voidedReturnsRecordAmount": 0.0,
        "voidedSalesRecordVolume": 0,
        "voidedReturnsRecordVolume": 0,
        "refundedSalesRecordAmount": 0.0,
        "refundedReturnsRecordAmount": 0.0,
        "refundedSalesRecordVolume": 0,
        "refundedReturnsRecordVolume": 0,
        "returnedSalesRecordAmount": 0.0,
        "returnedReturnsRecordAmount": 0.0,
        "returnedSalesRecordVolume": 0,
        "returnedReturnsRecordVolume": 0,
        "errorSalesRecordAmount": 0.0,
        "errorReturnsRecordAmount": 0.0,
        "errorSalesRecordVolume": 0,
        "errorReturnsRecordVolume": 0
    }
 ]

GET Reports of Notification Change

This endpoint allows the user to retrieve the notification change report.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI /Reports/NotificationofChange

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-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/NotificationofChange?from=2023-01-11&to=2023-02-11' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "subMerchants": null,
        "id": 4044,
        "transactionDate": "2023-01-24T19:23:49",
        "firstName": "TEST",
        "lastName": "TEST",
        "type": "D",
        "routingNumber": "",
        "accountNumber": null,
        "amount": 1.0000,
        "status": "B",
        "confirmation": "EEJT252a3b8c905",
        "noc": "C07",
        "nocDesc": "Incorrect transit/routing number,  bank account number and payment  code",
        "nocData": "",
        "transactionCheckId": 24816,
        "returnCodeId": 77,
        "returnCodeDesc": "Incorrect transit/routing number,  bank account number and payment  code",
        "transactionsCheckReturnFileId": 14742,
        "transactionsCheckReturnFilePath": null,
        "transactionsCheckReturnFileStatus": null,
        "parentMerchantId": null,
        "code": "EEJT",
        "name": "Elavon Ecommerce Jose Test"
    },
    {
        "subMerchants": null,
        "id": 4376,
        "transactionDate": "2023-01-14T03:23:56",
        "firstName": "iCG",
        "lastName": "QA",
        "type": "C",
        "routingNumber": "",
        "accountNumber": null,
        "amount": 28.9200,
        "status": "R",
        "confirmation": "EEJTe0fe655a93b",
        "noc": "C03",
        "nocDesc": "Incorrect transit/routing number and  bank account number",
        "nocData": "",
        "transactionCheckId": 24880,
        "returnCodeId": 73,
        "returnCodeDesc": "Incorrect transit/routing number and  bank account number",
        "transactionsCheckReturnFileId": 15476,
        "transactionsCheckReturnFilePath": null,
        "transactionsCheckReturnFileStatus": null,
        "parentMerchantId": null,
        "code": "EEJT",
        "name": "Elavon Ecommerce Jose Test"
    }
 ]

GET Reports of Transactions Status

This endpoint allows the user to retrieve transactions status report

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI  /Reports/TransactionsStatus

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
transactionType The type of transaction Mandatory String CC or ACH
date This is the date of the report Mandatory Date format 2023-02-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/TransactionsStatus?transactionType=CC&date=2023-01-11' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[

    {
        "period": "1/29",
        "day": 29,
        "month": 1,
        "year": 2023,
        "type": "Credit Cards",
        "volume": 1428.0000,
        "count": 7,
        "fullDate": "2023-01-29T00:00:00",
        "salesAmount": 0.0,
        "returnsAmount": 0.0,
        "salesRecord": 0,
        "returnsRecord": 0
    },
    {
        "period": "1/30",
        "day": 30,
        "month": 1,
        "year": 2023,
        "type": "Credit Cards",
        "volume": 103.0000,
        "count": 2,
        "fullDate": "2023-01-30T00:00:00",
        "salesAmount": 0.0,
        "returnsAmount": 0.0,
        "salesRecord": 0,
        "returnsRecord": 0
    },
    {
        "period": "1/31",
        "day": 31,
        "month": 1,
        "year": 2023,
        "type": "Credit Cards",
        "volume": 0.0,
        "count": 0,
        "fullDate": "2023-01-31T00:00:00",
        "salesAmount": 0.0,
        "returnsAmount": 0.0,
        "salesRecord": 0,
        "returnsRecord": 0
    }
 ]

GET Reports of Returned Checks

This endpoint allows the user to retrieve returned checks report

Key Request Parameter

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI /Reports/ReturnedChecks

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-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/ReturnedChecks?from=2023-01-11&to=2023-02-11' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "subMerchants": null,
        "date": "2023-01-30T00:00:00",
        "confirmationId": "EEJTE709908E13EF",
        "customerName": "iCG QA",
        "display": "*****6235",
        "custom1": "",
        "returnCode": "R05",
        "returnCodeDesc": "Reserved",
        "amount": 82.4800,
        "transactionId": 21076,
        "id": 0,
        "parentMerchantId": null,
        "code": "EEJT",
        "name": "Elavon Ecommerce Jose Test",
        "status": null
    },
    {
        "subMerchants": null,
        "date": "2023-01-24T00:00:00",
        "confirmationId": "EEJT252a3b8c905",
        "customerName": "TEST TEST",
        "display": "*****3123",
        "custom1": "",
        "returnCode": "R69",
        "returnCodeDesc": "Multiple Errors",
        "amount": 1.0000,
        "transactionId": 24816,
        "id": 0,
        "parentMerchantId": null,
        "code": "EEJT",
        "name": "Elavon Ecommerce Jose Test",
        "status": null
    }
 ]

Get Reports of Settled Check Batches

This endpoint allows the user to retrieve the settled check batches report.

Key Request Parameter

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI /Reports/SettledCheckBatches

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-12-11
To This is the End Date of Transactions Mandatory Date format 2023-12-31

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/SettledCheckBatches?from=2023-12-11&to=2023-12-31' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "subMerchants": null,
        "id": 2050,
        "batchId": "A96863A35C0243A8AAB1DE65E2BFDA",
        "batchDate": "2023-12-11T00:00:00",
        "grossAmount": 22.00,
        "returnedAmount": 0.00,
        "netDeposit": 22.00,
        "parentMerchantId": null,
        "code": "SEDZ",
        "name": "iCheckGateway.com",
        "status": null
    },
    {
        "subMerchants": null,
        "id": 2053,
        "batchId": "E16A2F0E65F244FA96236CEE5D4090",
        "batchDate": "2023-12-11T00:00:00",
        "grossAmount": 25.00,
        "returnedAmount": 0.00,
        "netDeposit": 25.00,
        "parentMerchantId": null,
        "code": "SEDZ",
        "name": "iCheckGateway.com",
        "status": null
    },
    {
        "subMerchants": null,
        "id": 2055,
        "batchId": "B07113B2C8984EF0B1586CDAB9BEB4",
        "batchDate": "2023-12-13T00:00:00",
        "grossAmount": 60.46,
        "returnedAmount": 0.00,
        "netDeposit": 60.46,
        "parentMerchantId": null,
        "code": "FDJT",
        "name": "FD Ecommerce Jose Test",
        "status": null
    },
    {
        "subMerchants": null,
        "id": 2075,
        "batchId": "604CDA08A9B54AA481672617163727",
        "batchDate": "2023-12-18T00:00:00",
        "grossAmount": 178.10,
        "returnedAmount": 0.00,
        "netDeposit": 178.10,
        "parentMerchantId": null,
        "code": "FDJT",
        "name": "FD Ecommerce Jose Test",
        "status": null
    }
 ]

GET Reports of Settled Check Batch Details by Batch ID

This endpoint allows the user to retrieve settled check batch details for a specific batch Id.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI /Reports/SettledCheckBatchDetails/{batchId}

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
batchId This is the batch Id Mandatory String 604CDA08A9B54AA481672617163727

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/SettledCheckBatchDetails/604CDA08A9B54AA481672617163727' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "batchDate": "2023-12-18T00:00:00",
        "dateTimeTransaction": null,
        "transactionsDate": "2023-12-18T12:14:35",
        "settledDate": "2023-12-22T00:00:00",
        "entryClassCode": "PPD",
        "confirmationId": "FDJTeb65635f9dc",
        "customerName": "iCG",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "display": "**3456",
        "status": "S",
        "amount": 75.6400,
        "batchId": "604CDA08A9B54AA481672617163727",
        "type": "D",
        "transactionId": 29183,
        "returnCode": ""
    },
    {
        "batchDate": "2023-12-18T00:00:00",
        "dateTimeTransaction": null,
        "transactionsDate": "2023-12-18T12:15:15",
        "settledDate": "2023-12-22T00:00:00",
        "entryClassCode": "PPD",
        "confirmationId": "FDJT02b5d3469dc",
        "customerName": "iCG",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "display": "**3456",
        "status": "S",
        "amount": 6.7200,
        "batchId": "604CDA08A9B54AA481672617163727",
        "type": "D",
        "transactionId": 29185,
        "returnCode": ""
    },
    {
        "batchDate": "2023-12-18T00:00:00",
        "dateTimeTransaction": null,
        "transactionsDate": "2023-12-18T12:23:58",
        "settledDate": "2023-12-22T00:00:00",
        "entryClassCode": "PPD",
        "confirmationId": "FDJT3a2f80da9dc",
        "customerName": "iCG",
        "custom1": "",
        "custom2": "",
        "custom3": "",
        "display": "**3456",
        "status": "S",
        "amount": 15.7800,
        "batchId": "604CDA08A9B54AA481672617163727",
        "type": "D",
        "transactionId": 29187,
        "returnCode": ""
    }
 ]

GET Reports of Transactions Settled by Merchant

This endpoint allows the user to retrieve the transactions settled reports by Merchant.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI /Reports/TransactionsSettledbyMerchant

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
transactionType The type of transaction Mandatory String CC or ACH
date This is the date of the report Mandatory Date format 2023-01-11

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/TransactionsSettledbyMerchant?transactionType=CC&date=2023-01-11' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[
    {
        "period": null,
        "day": 0,
        "month": 0,
        "year": 0,
        "type": null,
        "volume": 0.0,
        "count": 0,
        "fullDate": "2023-01-01T00:00:00",
        "salesAmount": 0.0,
        "returnsAmount": 0.0,
        "salesRecord": 0,
        "returnsRecord": 0
    },
    {
        "period": null,
        "day": 0,
        "month": 0,
        "year": 0,
        "type": null,
        "volume": 0.0,
        "count": 0,
        "fullDate": "2023-01-02T00:00:00",
        "salesAmount": 0.0,
        "returnsAmount": 0.0,
        "salesRecord": 0,
        "returnsRecord": 0
    },
    {
        "period": null,
        "day": 0,
        "month": 0,
        "year": 0,
        "type": null,
        "volume": 0.0,
        "count": 0,
        "fullDate": "2023-01-03T00:00:00",
        "salesAmount": 0.0,
        "returnsAmount": 0.0,
        "salesRecord": 0,
        "returnsRecord": 0
    }
 ]

GET Reports of Transactions View Today 

This endpoint allows the user to retrieve the transactions view today report.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI  /Reports/TransactionsViewToday

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
transactionType The type of transaction Mandatory String CC or ACH
date This is the date of the report Mandatory Date format 2023-01-11
Status This is the status of the transaction Mandatory string

Processed=A

Example: Processed*=A,F,S|Not Processed*=D,E,X|Settled=S|Approved=A|Partially Approved=F|Declined=D|Voided=V|Refunded=R|Error=E

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/TransactionsViewToday?transactionType=CC&date=11-01-2023&Status=Processed%3DA' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNTA2NzA3LCJuYmYiOjE3MTA0MjAzMDd9.1hAKjFdfC7YOVUXoW1sTHN70LmXkH_xGMakSZnZa_7Y'

Sample Response

[
    {
        "period": "Processed",
        "salesRecordAmount": 0.0,
        "returnsRecordAmount": 0.0,
        "salesRecordVolume": 0,
        "returnsRecordVolume": 0
    }
 ]

GET Reports of User Activity Logs by service and by the userName

This endpoint allows the user to retrieve the user activity logs by service and by the userName.

Key Request Parameters

Element Value
Method GET
Authorization OAuth 2.0 ROPC 
URI /Reports/UserActivityLogs/{service}/{userName}

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-12-11
To This is the End Date of Transactions Mandatory Date format 2023-12-31

Header Parameter

Parameter Name Description Mandatory/Optional Data Type Example
service The type of service Mandatory String auth or main
userName Name of the user Mandatory String John

Sample cURL

curl --location 'https://api.icheckdev.com/Reports/UserActivityLogs/main/suseelas?from=2023-12-11&to=2023-12-31' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1laWQiOiJlYjg1M2IzMi01MjYzLTQ3ZDMtODJjOS0yM2NkY2FjNWI4YmQiLCJ1bmlxdWVfbmFtZSI6InN1c2VlbGFzIiwiZW5jcnlwdGVkX2VtYWlsIjoiUzBRN3Z6NU5tYWt4TmFFZWZEblNxNTRhZGtzbDk5YzZGWXNtNmM4c29kND0iLCJ0eXBlIjoiIiwiaXNzIjoiaHR0cHM6Ly9hdXRoLmljaGVja2Rldi5jb20vIiwiYXVkIjoiYTMwZDg5NzQtMzYxYy00MzFiLWE1ZWUtNTkzODdiYWZhOGE3IiwiZXhwIjoxNzEwNDAyNzA5LCJuYmYiOjE3MTAzMTYzMDl9.7_qUtM2sfIB5og6nQXx-wRW8AHylGuu3GFfdMV_2LFk'

Sample Response

[

   {
        "id": 644463,
        "audited": "2023-12-26T05:36:48",
        "auditUser": "suseelas",
        "ip": "10.10.0.80",
        "controller": "Reports",
        "action": "TransactionsSettledbyMerchant",
        "tracers": null,
        "allowTraceEntitiesRollbacks": false,
        "isTraceEntitiesRolledback": false,
        "rollbackAuditLogId": null,
        "rolledbackMessage": null
    },
    {
        "id": 644464,
        "audited": "2023-12-26T05:36:48",
        "auditUser": "suseelas",
        "ip": "10.10.0.80",
        "controller": "InvoiceRegular",
        "action": "GetCounts",
        "tracers": null,
        "allowTraceEntitiesRollbacks": false,
        "isTraceEntitiesRolledback": false,
        "rollbackAuditLogId": null,
        "rolledbackMessage": null
    },
    {
        "id": 644465,
        "audited": "2023-12-26T05:36:49",
        "auditUser": "suseelas",
        "ip": "10.10.0.80",
        "controller": "TransactionRegular",
        "action": "GetTotalSalesAmount",
        "tracers": null,
        "allowTraceEntitiesRollbacks": false,
        "isTraceEntitiesRolledback": false,
        "rollbackAuditLogId": null,
        "rolledbackMessage": null
    }
 ]

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
 

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