Clearent Reporting API

Version 1
Revision History
Date Version Description Page(s)
7/27/2022 1.0 Initial Document Release All

8/22/2022 1.01 Added field-level data, included all reports. All

9/14/2022 1.02 Added Response Examples 12, 17, 21,

26, 30, 35,41
1/11/2023 1.03 Added expectedFundingDate date range filter 5, 10
details
Table of Contents
Clearent Reporting API ................................................................................................................. 1
Revision History ............................................................................................................................... 2
Table of Contents ............................................................................................................................. 3
Getting Started ........................................................................................................................... 4
Using this API ............................................................................................................................. 4
Using this Document .................................................................................................................. 4
A. Merchants Report ............................................................................................................ 5
B. Merchant Bank Deposits Report .................................................................................... 13
C. Merchant Cases Report ................................................................................................. 18
D. Merchant Closed Batches Report .................................................................................. 22
E. Merchant Current Pricing Report ................................................................................... 28
F. Merchant Disputes Report ............................................................................................. 32
G. Merchant Transactions Report ...................................................................................... 37
Getting Started
The Reporting API is a REST based API that can be used to view reports with Clearent. All our
endpoints require the use of the secure protocol HTTPS as well as HTTP headers containing:
1. a secret access key provided by Clearent
2. the merchant identifier associated with the resource that you wish to view. These
endpoints support the GET HTTP method.

Request a sandbox access key

Using this API

To use this API, send your request in this example format:
Method: GET
Production Host: reporting.clearent.net
Basepath: /data/api/v1
Schemes: HTTPS
Headers:
Content-Type: application/json
Accept: application/json
AccessKey: SECRET ACCESS KEY

Using this Document

Field level information presented in the endpoint tables is defined as follows:
Field Name Name of the field, which must be used exactly as specified.
M/C/O Indicates if the field is Mandatory, Conditional, or Optional.
String Indicates the field type.
No Indicates the allowed number of characters.
Valid Characters Indicates the allowed character types with examples.
Description A short description of the data and usage for the given field.
A. Merchants Report
Purpose Use this report to retrieve data about merchants (i.e., MIDs,
mailing/physical addresses, SAQ and compliance information).
Method GET
Endpoint /standard/merchants
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchants

Parameters
Field Name M/C/O Type No Valid Characters Description

merchantBoardedDate O Date 10 Alphanumeric (a-z,A- Date of merchant

Z,0-9) . = \ [ ] # : _ ? * / boarding into Clearent
@ ; - & and space systems

Example: 2019-10-03

sortBy O Text Alphanumeric (a-z,A- Allows sorting of the

Z,0-9) . = \ [ ] # : _ ? * / paginated result set,
@ ; - & and space multiple order by
allowed.
Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific page to

be returned from a result
Example: 10 list.

pageSize O Number Numeric (0-9) Allows setting of the

number of results to be
Max results: 1000 returned per page.

Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden
Example Values: Merchants Array
Field Name M/C/O Type No Valid Characters Description

isMerchantNextDayFu O Text 3 Alphanumeric (a-z,A- Indicates if the merchant

ndingEnabled Z,0-9) . = \ [ ] # : _ ? * / is early merchant funding
@ ; - & and space enabled.

Example: Yes

merchantAmexMID O Text 20 Alphanumeric (a-z,A- Amex conveyed merchant

Z,0-9) . = \ [ ] # : _ ? * / identifier.
@ ; - & and space

Example: 1230000001

merchantAmexSENu O Text 10 Alphanumeric (a-z,A- AMEX service

mber Z,0-9) . = \ [ ] # : _ ? * / establishment number for
@ ; - & and space OptBlue merchants.

Example: 3210000001

merchantBankIDNum O Text 62 Alphanumeric (a-z,A- The sponsoring bank

ber Z,0-9) . = \ [ ] # : _ ? * / portfolio identifier.
@ ; - & and space

Example: 412099

merchantBoardedDat O Date 10 Alphanumeric (a-z,A- Date of merchant boarding

e Z,0-9) . = \ [ ] # : _ ? * / into Clearent systems.
@ ; - & and space

Example: 2019-10-03

merchantBusinessPho O Text 50 Alphanumeric (a-z,A- Merchant phone number

neNumberFull Z,0-9) . = \ [ ] # : _ ? * / formatted.
@ ; - & and space

Example: 314-555-1212

merchantCompliance O Text 250 Alphanumeric (a-z,A- Current PCI status.

StatusDescription Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: SAQ taken

and passed, scan not
required

merchantStatusDescri O Text
ption Example:
merchantDBA O Text 250 Alphanumeric (a-z,A- Merchant DBA Name.
Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Charlies Pub

merchantDiscoverMID O Text 20 Alphanumeric (a-z,A- Discover network

Z,0-9) . = \ [ ] # : _ ? * / merchant identifier.
@ ; - & and space

Example:
601000000000001

merchantEmailAddres O Text 128 Alphanumeric (a-z,A- Email address of

s Z,0-9) . = \ [ ] # : _ ? * / merchant.
@ ; - & and space

Example:
charles@gmail.com

merchantIncorporation O Text 50 Alphanumeric (a-z,A- Merchant’s legal

TypeDescription Z,0-9) . = \ [ ] # : _ ? * / incorporation type.
@ ; - & and space

Example: Limited
Liability Company

merchantLastSAQPas O Date 10 Alphanumeric (a-z,A- Most recent date the

sDate Z,0-9) . = \ [ ] # : _ ? * / merchant passed their
@ ; - & and space Self-Assessment
Questionnaire (SAQ).
Example: 2019-10-24

merchantMCCDescrip O Text 80 Alphanumeric (a-z,A- Merchant Category Code

tion Z,0-9) . = \ [ ] # : _ ? * / Description.
@ ; - & and space

Example: Restaurant

merchantMailingAddre O Text 100 Alphanumeric (a-z,A- Merchant mailing street

ssLine1 Z,0-9) . = \ [ ] # : _ ? * / address for line 1.
@ ; - & and space

Example: 123 Main

Street

merchantMailingAddre O Text 100 Alphanumeric (a-z,A- Merchant extended

ssLine2 Z,0-9) . = \ [ ] # : _ ? * / mailing address for line 2.
@ ; - & and space

Example: Apt. 503

merchantMailingAddre O Text 100 Alphanumeric (a-z,A- Merchant mailing address
ssCity Z,0-9) . = \ [ ] # : _ ? * / for City.
@ ; - & and space

Example: Saint Louis

merchantMailingAddre O Text 30 Alphanumeric (a-z,A- Merchant mailing address

ssPostalCode Z,0-9) . = \ [ ] # : _ ? * / for postal code.
@ ; - & and space

Example: 63141

merchantMailingAddre O Text 50 Alphanumeric (a-z,A- Merchant mailing address

ssStateProvince Z,0-9) . = \ [ ] # : _ ? * / for State or Province.
@ ; - & and space

Example: MO

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

merchantPhysicalAddr O Text 100 Alphanumeric (a-z,A- Merchant business street

essLine1 Z,0-9) . = \ [ ] # : _ ? * / address for line 1.
@ ; - & and space

Example: 123 Main

Street

merchantPhysicalAddr O Text 100 Alphanumeric (a-z,A- Merchant extended

essLine2 Z,0-9) . = \ [ ] # : _ ? * / business street address
@ ; - & and space for line 2.

Example: Apt. 503

merchantPhysicalCity O Text 100 Alphanumeric (a-z,A- Merchant business

Z,0-9) . = \ [ ] # : _ ? * / address for city.
@ ; - & and space

Example: Saint Louis

merchantPhysicalPost O Text 30 Alphanumeric (a-z,A- Merchant business

alCode Z,0-9) . = \ [ ] # : _ ? * / address for postal code.
@ ; - & and space

Example: 63141
merchantPhysicalStat O Text 2 Alphanumeric (a-z,A- Merchant business
eOrProvince Z,0-9) . = \ [ ] # : _ ? * / address for state or
@ ; - & and space province.

Example: MO

merchantPrincipal1Fir O Text 50 Alphanumeric (a-z,A- First name of principal

stName Z,0-9) . = \ [ ] # : _ ? * / owner 1.
@ ; - & and space

Example: Charles

merchantPrincipal1La O Text 50 Alphanumeric (a-z,A- Last name of principal

stName Z,0-9) . = \ [ ] # : _ ? * / owner 1.
@ ; - & and space

Example: Brown

merchantPrincipal1Pe O Numeric 18 Numeric (0-9) and . Percent of ownership for

rcentage principal owner 1.
Example: .25

merchantPrincipal2Fir O Text 50 Alphanumeric (a-z,A- First name of principal

stName Z,0-9) . = \ [ ] # : _ ? * / owner 2.
@ ; - & and space

Example: Lucy

merchantPrincipal2La O Text 50 Alphanumeric (a-z,A- Last name of principal

stName Z,0-9) . = \ [ ] # : _ ? * / owner 2.
@ ; - & and space

Example: Van Pelt

merchantPrincipal2Pe O Numeric 18 Numeric (0-9) and . Percent of ownership for

rcentage principal owner 2.
Example: .25

merchantSAQExpirati O Date 10 Alphanumeric (a-z,A- Expiration date for

onDate Z,0-9) . = \ [ ] # : _ ? * / merchant SAQ.
@ ; - & and space

Example: 2019-10-24

merchantSAQTypeCo O Text 32 Alphanumeric (a-z,A- Type of SAQ as

de Z,0-9) . = \ [ ] # : _ ? * / determined by merchant
@ ; - & and space environment.

Example: P2Pe
merchantSettlementM O Text 128 Alphanumeric (a-z,A- Method of merchant fee
ethodName Z,0-9) . = \ [ ] # : _ ? * / settlement. Monthly or
@ ; - & and space Daily.

Example: Monthly

merchantTINStatusDe O Text 250 Alphanumeric (a-z,A- Tax ID number validation

scription Z,0-9) . = \ [ ] # : _ ? * / status which determines
@ ; - & and space backup withholding.

Example: TIN and Name

combination matches
IRS records
merchantTaxpayerLeg O Text 100 Alphanumeric (a-z,A- Legal name registered
alName Z,0-9) . = \ [ ] # : _ ? * / with the IRS for the
@ ; - & and space merchant.

Example: Charlie’s Pub

LLC

parentBusinessDBA O Text 250 Alphanumeric (a-z,A- Agent name of partner.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Woodstock

parentMerchantNumb O Text 30 Alphanumeric (a-z,A- Agent of Partner Merchant

er Z,0-9) . = \ [ ] # : _ ? * / MID number.
@ ; - & and space

Example:
6588000000987654

resellerBusinessDBA O Text 250 Alphanumeric (a-z,A- Partner DBA name.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Snoopy
Software

resellerMerchantNum O Text 30 Alphanumeric (a-z,A- Partner MID number.

ber Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example:
6588000000999999
Example Values: Metadata
Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a-z,A- Identifier for this API call.

Z,0-9) . = \ [ ] # : _ ? * Can be provided for
/ @ ; - & and space tracing interactions.

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a-z,A- Timestamp of when the

Z,0-9) . = \ [ ] # : _ ? * API call occurred.
/ @ ; - & and space

Example: 2019-12-
12T22:59:10.244049
8

Example Values: Page

Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or Indicates if the given page

False is the last page in the
report.
Example: false

number O Number Numeric (0-9) Index of paging object.

Increment to get new
Example: 1 pages of response.

size O Number Numeric (0-9) Indicates the number of

records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in

the returned report.
Example: 142
Example Response: Merchants Report
{
"merchants": [
{
"merchantNumber": "6588000000999998",
"merchantDBA": "Charlies Pub",
"parentMerchantNumber": "6588000000987654",
"parentBusinessDBA": "Woodstock",
"resellerMerchantNumber": "6588000000999999",
"resellerBusinessDBA": "Snoopy Software",
"merchantBoardedDate": "2019-10-03",
"merchantBankIDNumber": "412099",
"merchantIncorporationTypeDescription": "Limited liability company",
"isMerchantNextDayFundingEnabled": "Yes",
"merchantSettlementMethodName": "Monthly",
"merchantAmexSENumber": "3210000001",
"merchantAmexMID": "1230000001",
"merchantDiscoverMID": "601000000000001",
"merchantStatusDescription": "string",
"merchantComplianceStatusDescription": "SAQ taken and passed, scan not required",
"merchantSAQTypeCode": "P2Pe",
"merchantLastSAQPassDate": "2019-10-24",
"merchantSAQExpirationDate": "2020-10-31",
"merchantEmailAddress": "charles@gmail.com",
"merchantBusinessPhoneNumberFull": "314-555-1212",
"merchantTaxpayerLegalName": "Charlie's Pub LLC",
"merchantTINStatusDescription": "TIN and Name combination matches IRS records",
"merchantMailingAddressLine1": "123 Main Street",
"merchantMailingAddressLine2": "Apt. 503",
"merchantMailingCity": "Saint Louis",
"merchantMailingPostalCode": "63141",
"merchantMailingStateProvince": "MO",
"merchantMCCDescription": "Restaurant",
"merchantPhysicalAddressLine1": "123 Main Street",
"merchantPhysicalAddressLine2": "Apt. 503",
"merchantPhysicalCity": "Saint Louis",
"merchantPhysicalPostalCode": "63141",
"merchantPhysicalStateOrProvince": "MO",
"merchantPrincipal1FirstName": "Charles",
"merchantPrincipal1LastName": "Brown",
"merchantPrincipal1Percentage": ".25",
"merchantPrincipal2FirstName": "Lucy",
"merchantPrincipal2LastName": "Van Pelt",
"merchantPrincipal2Percentage": ".25"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}
B. Merchant Bank Deposits Report
Purpose Use this report to view settlement and funding details by Merchant ID
(i.e., amount, settlement date, expected funding date, etc.).
Method GET
Endpoint /standard/merchantBankDeposits
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchantBankDeposits

Parameters:
Field Name M/C/O Type No Valid Characters Description

expectedFundingDate O Datetime 25 Alphanumeric (a-z,A- Calculated date based on

Z,0-9) . = \ [ ] # : _ ? * / Next Day Funding flag.
@ ; - & and space

Example: 2019-10-02
T00:00:00 Time is
always 00:00:00

fundingRequestDaysOl O Datetime 25 Alphanumeric (a-z,A- Deposit/withdrawal

d Z,0-9) . = \ [ ] # : _ ? * / request date and time.
@ ; - & and space

Example: 2019-10-30

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant MID Number.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example:
6588000000999998
sortBy O Text Alphanumeric (a-z,A- Allows sorting of the
Z,0-9) . = \ [ ] # : _ ? * / paginated result set,
@ ; - & and space multiple order by allowed.

Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific page to

be returned from a result
Example: 10 list.
pageSize O Number Numeric (0-9) Allows setting of the
number of results to be
Max results: 1000 returned per page.

Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden

Example Values: Merchant Bank Deposits Array

Field Name M/C/O Type No Valid Characters Description

accountNumberMask O Text 20 Alphanumeric (a-z,A- Bank account number

ed Z,0-9) . = \ [ ] # : _ ? * masked up to last 4-digits.
/ @ ; - & and space

Example: ******1234

amount O Money 19 Numeric with decimal Amount of the bank

deposit.
Example: 543.00

bankIDNumber O Text 64 Alphanumeric (a-z,A- Sponsoring bank portfolio

Z,0-9) . = \ [ ] # : _ ? * identifier.
/ @ ; - & and space

Example: 412099

creationDayOfWeek O Text 25 Alphanumeric (a-z,A- Three letter abbreviation

Z,0-9) . = \ [ ] # : _ ? * of the day of the week for
/ @ ; - & and space fRDateTime.

Example: MON

expectedFundingDat O Date 10 Alphanumeric (a-z,A- Calculated date based on

e Z,0-9) . = \ [ ] # : _ ? * Next Day Funding flag.
/ @ ; - & and space

Example: 2019-10-02
fRDateTime O Datetime 25 Alphanumeric (a-z,A- Deposit/withdrawal
Z,0-9) . = \ [ ] # : _ ? * request date and time.
/ @ ; - & and space

Example: 2019-10-
30T09:00:23.473

fundingEventTypeNa O Text 100 Alphanumeric (a-z,A- Description of the

me Z,0-9) . = \ [ ] # : _ ? * debit/credit money
/ @ ; - & and space movement.

Example: Deposit

fundingType O Text 24 Alphanumeric (a-z,A- Description of the funding

Z,0-9) . = \ [ ] # : _ ? * mechanism.
/ @ ; - & and space

Example: Standard
Two-Day Funding

isNextDayFundingEn O Boolean 1 Returns Yes or No Next day funding flag.

abled
Example: Yes

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * Number.
/ @ ; - & and space

Example:
6588000000999998

settlementDate O Date 10 Alphanumeric (a-z,A- Transaction clearing date.

Z,0-9) . = \ [ ] # : _ ? * Timestamp is Central
/ @ ; - & and space Standard Time.

Example: 2019-10-03
Example Values: Metadata
Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a-z,A- Identifier for this API call.

Z,0-9) . = \ [ ] # : _ ? * Can be provided for
/ @ ; - & and space tracing interactions.

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a-z,A- Timestamp of when the

Z,0-9) . = \ [ ] # : _ ? * API call occurred.
/ @ ; - & and space

Example: 2019-12-
12T22:59:10.2440498

Example Values: Page

Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or False Indicates if the given page

is the last page in the
Example: false report.

number O Number Numeric (0-9) Index of paging object.

Increment to get new
Example: 1 pages of response.

size O Number Numeric (0-9) Indicates the number of

records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in

the returned report.
Example: 142
Example Response: Merchant Bank Deposits Report
{
"merchantBankDeposits": [
{
"merchantNumber": "6588000000999998",
"accountNumberMasked": "******1234",
"amount": "543.00",
"bankIDNumber": "412099",
"creationDayOfWeek": "MON",
"expectedFundingDate": "2019-10-03",
"fRDateTime": "2019-10-30T09:00:26.473",
"fundingEventTypeName": "Deposit",
"fundingType": "Standard Two Day Funding",
"isNextDayFundingEnabled": "Yes",
"settlementDate": "2019-10-03"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}
C. Merchant Cases Report
Purpose Use this report to look up merchant cases (i.e., reason, description,
merchant number, etc.)
Method GET
Endpoint /standard/merchantCases
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchantCases

Parameters
Field Name M/C/O Type No Valid Characters Description

createdDate O Datetime 25 Alphanumeric (a-z,A- Date a case was created.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-02

closedDate O Datetime 25 Alphanumeric (a-z,A- Date a case was closed.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-03
sortBy O Text Alphanumeric (a-z,A- Allows sorting of the
Z,0-9) . = \ [ ] # : _ ? * / paginated result set,
@ ; - & and space multiple order by allowed.

Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific page to

be returned from a result
Example: 10 list.

pageSize O Number Numeric (0-9) Allows setting of the

number of results to be
Max results: 1000 returned per page.
Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden

Example Values: Merchant Cases Array

Field Name M/C/O Type No Valid Characters Description

caseCategory O Text 255 Alphanumeric (a-z,A- Case category assignment

Z,0-9) . = \ [ ] # : _ ? * / for internal tracking.
@ ; - & and space

Example:

caseNumber O Text 30 Alphanumeric (a-z,A- ID number assigned to the

Z,0-9) . = \ [ ] # : _ ? * / case when it was opened.
@ ; - & and space

Example: 00123456

createdDate O Datetime 25 Alphanumeric (a-z,A- Date a case was created.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-02

closedDate O Datetime 25 Alphanumeric (a-z,A- Date a case was closed.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-03

description O Text 800 Alphanumeric (a-z,A- Case description.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Equipment
question
merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)
Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

reason O Text 40 Alphanumeric (a-z,A- Freeform text field used to

Z,0-9) . = \ [ ] # : _ ? * / describe transaction
@ ; - & and space reason.

Example:

Example Values: Metadata

Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a-z,A- Identifier for this API call.

Z,0-9) . = \ [ ] # : _ ? * Can be provided for
/ @ ; - & and space tracing interactions.

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a-z,A- Timestamp of when the

Z,0-9) . = \ [ ] # : _ ? * API call occurred.
/ @ ; - & and space

Example: 2019-12-
12T22:59:10.244049
8

Example Values: Page

Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or Indicates if the given page

False is the last page in the
report.
Example: false

number O Number Numeric (0-9) Index of paging object.

Increment to get new
Example: 1 pages of response.
size O Number Numeric (0-9) Indicates the number of
records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in

the returned report.
Example: 142

Example Response: Merchant Cases Report

{
"merchantCases": [
{
"merchantNumber": "6588000000999998",
"caseNumber": "string",
"createdDate": "2019-10-02",
"closedDate": "2019-10-03",
"reason": "string",
"caseCategory": "string",
"description": "Equipment Question"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}
D. Merchant Closed Batches Report
Purpose Use this report to review closed batches information (i.e., batch fees,
batch numbers, closed date, deposit amount, funded date, etc.).
Method GET
Endpoint /standard/merchantClosedBatches
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchantClosedBatches

Parameters
Field Name M/C/O Type No Valid Characters Description

batchStatus O Text 25 Alphanumeric (a-z,A- Batch processing

Z,0-9) . = \ [ ] # : _ ? * / status: Closed,
@ ; - & and space Settled, Funded, or
Open.
Example: Settled

expectedFundingDate O Datetime 25 Alphanumeric (a-z,A- Calculated date

Z,0-9) . = \ [ ] # : _ ? * / based on Next Day
@ ; - & and space Funding flag.

Example: 2019-10-04
T00:00:00 Time is
always 00:00:00

expectedFundingDate O Date Alphanumeric (a-z,A- Use this to filter the

Range Z,0-9) . = \ [ ] # : _ ? * / expectedFunding
@ ; - & and space Date by start and end
dates.
Example: {2019-10-
02};#{2019-10-10} See example

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998
sortBy O Text Alphanumeric (a-z,A- Allows sorting of the
Z,0-9) . = \ [ ] # : _ ? * / paginated result set,
@ ; - & and space multiple order by
allowed.
 Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific

page to be returned
Example: 10 from a result list.

pageSize O Number Numeric (0-9) Allows setting of the

number of results to
Max results: 1000 be returned per
page.

Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden

Example Values: Merchant Closed Batches Array

Field Name M/C/O Type No Valid Characters Description

backupWithholding O Number 19 Numeric (0-9) and Amount withheld from the

decimal batch total for backup
withholding.
Example: 234.10

batchFees O Number 19 Numeric (0-9) and Amount withheld from the

decimal batch total for batch fees
(i.e., daily fees)
Example: 2.30

batchNumber O Number 10 Numeric (0-9) Batch ID number.

Example: 278

batchTotal O Money 19 Numeric with decimal Net total of transactions in

the batch.
Example: 543.00
ClosedDate O Datetime 25 Alphanumeric (a-z,A- Date a case was closed.
Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-03

conveyedAmount O Money 19 Numeric with decimal Transaction total amount

conveyed to card brand
Example: 422.49 (i.e., as a pass-thru without
fees).

conveyedCount O Number 10 Numeric (0-9) Count of transactions

whose amount is
Example: 2 conveyed.

depositAccountNumbe O Text 20 Alphanumeric (a-z,A- Merchant account number

r Z,0-9) . = \ [ ] # : _ ? * / where the amount is
@ ; - & and space deposited.

Example:

depositAmount O Number 19 Numeric (0-9) and Represent the settled

decimal volume less fees,
chargebacks, and
Example: 2089.00 adjustments.

fundedDate O Date 10 Alphanumeric (a-z,A- Date funds were expected

Z,0-9) . = \ [ ] # : _ ? * / to be deposited into
@ ; - & and space Merchant’s bank account.

Example: 2019-10-04

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

refundCount O Number 10 Numeric (0-9) The count of refund

transactions within the
Example: 4 batch.

refunds O Money 19 Numeric with decimal Total amount of refund

transactions within the
Example: 243.56 batch.

sales O Money 19 Numeric with decimal Total amount of sales

transactions within the
Example: 3205.43 batch.
salesCount O Number 10 Numeric (0-9) The count of sales
transactions within the
Example: 26 batch.

settleDate O Datetime 25 Alphanumeric (a-z,A- The date the deposit is

Z,0-9) . = \ [ ] # : _ ? * / sent via ACH to the deposit
@ ; - & and space account. This does not
represent when the funds
Example: 2019-10- are posted to the account.
03T00:00:00 Time is always 00:00:00.

storeNumber O Text 32 Alphanumeric (a-z,A- Store identification number

Z,0-9) . = \ [ ] # : _ ? * / programmed into POS.
@ ; - & and space

Example: 7658

terminalID O Text 32 Alphanumeric (a-z,A- ID number associated with

Z,0-9) . = \ [ ] # : _ ? * / a given terminal.
@ ; - & and space

Example: 7658

terminalName O Text 255 Alphanumeric (a-z,A- Customer defined name of

Z,0-9) . = \ [ ] # : _ ? * / the Terminal.
@ ; - & and space

Example:

Example Values: Metadata

Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a- Identifier for this API call.

z,A-Z,0-9) . = \ [ ] # : Can be provided for tracing
_ ? * / @ ; - & and interactions.
space

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a- Timestamp of when the API

z,A-Z,0-9) . = \ [ ] # : call occurred.
_ ? * / @ ; - & and
space
 Example: 2019-12-
12T22:59:10.24404
98

Example Values: Page

Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or Indicates if the given page

False is the last page in the
report.
Example: false

number O Number Numeric (0-9) Index of paging object.

Increment to get new
Example: 1 pages of response.

size O Number Numeric (0-9) Indicates the number of

records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in

the returned report.
Example: 142

Example Response: Merchant Closed Batches Report

{
"merchantClosedBatches": [
{
"merchantNumber": "6588000000999998",
"storeNumber": "7658",
"terminalID": "string",
"terminalName": "string",
"batchNumber": "278",
"closedDate": "2019-10-03",
"settleDate": "2019-10-03",
"fundedDate": "2019-10-04",
"batchTotal": "543.00",
"batchFees": "2.30",
"sales": "3205.43",
"salesCount": "26",
"refunds": "243.56",
"refundsCount": "4",
"conveyedAmount": "422.49",
"conveyedCount": "2",
"depositAmount": "2089.00",
"depositAccountNumber": "string",
"backupWithholding": "234.10",
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
 "last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}
E. Merchant Current Pricing Report
Purpose Use this report to retrieve merchant current pricing information (i.e.,
pricing plan type, pricing fee description, pricing rate, etc.).
Method GET
Endpoint /standard/merchantCurrentPricing
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchantCurrentPricing

Parameters
Field Name M/C/O Type No Valid Characters Description

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

sortBy O Text Alphanumeric (a-z,A- Allows sorting of the

Z,0-9) . = \ [ ] # : _ ? * / paginated result set,
@ ; - & and space multiple order by allowed.

Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific page to

be returned from a result
Example: 10 list.

pageSize O Number Numeric (0-9) Allows setting of the

number of results to be
Max results: 1000 returned per page.
Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden

Example Values: Merchant Current Pricing Array

Field Name M/C/O Type No Valid Characters Description

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

pricingPlanType O Text 30 Alphanumeric (a-z,A- Name of pricing plan type.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Discount
Plus

effectiveStartDateTim O Datetime 25 Alphanumeric (a-z,A- Effective start date/time of

e Z,0-9) . = \ [ ] # : _ ? * / pricing plan.
@ ; - & and space

Example: 2019-10-
30T09:00:26.473

effectiveEndDateTime O Datetime 25 Alphanumeric (a-z,A- Effective end date/time of

Z,0-9) . = \ [ ] # : _ ? * / pricing plan.
@ ; - & and space

Example: 2019-10-
30T09:00:26.473

pricingFeeDescription O Text 255 Alphanumeric (a-z,A- Description of pricing fee.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Monthly
Account Fee
pricingFeeID O Number 10 Numeric (0-9) Internal ID assigned based
on account pricing.
Example:

pricingRate O Number 10 Numeric (0-9) with Rate percentage of

decimal transaction amount.

Example: 0.002

pricingFee O Number 10 Numeric (0-9) with Per item fee amount.

decimal

Example: 0.02

payInMonth1 O Number 10 Numeric (0-9) Month of fee charged.

Example: 6

payInMonth2 O Number 10 Numeric (0-9) Month of fee charged.

Example: 7

Example Values: Metadata

Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a-z,A- Identifier for this API call.

Z,0-9) . = \ [ ] # : _ ? * Can be provided for
/ @ ; - & and space tracing interactions.

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a-z,A- Timestamp of when the

Z,0-9) . = \ [ ] # : _ ? * API call occurred.
/ @ ; - & and space

Example: 2019-12-
12T22:59:10.244049
8
Example Values: Page
Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or Indicates if the given page

False is the last page in the
report.
Example: false

number O Number Numeric (0-9) Index of paging object.

Increment to get new
Example: 1 pages of response.

size O Number Numeric (0-9) Indicates the number of

records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in

the returned report.
Example: 142

Example Response: Merchant Current Pricing Report

{
"merchantCurrentPricing": [
{
"merchantNumber": "6588000000999998",
"pricingPlanType": "IC+, Discount, Discount Plus",
"effectiveStartDateTime": "2019-10-30T09:00:26.473",
"effectiveEndDateTime": "2019-10-30T09:00:26.473",
"pricingFeeDescription": "Monthly Account Fee",
"pricingFeeID": "string",
"pricingRate": "0.002",
"pricingFee": "0.20",
"payInMonth1": "6",
"payInMonth2": "7"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}
F. Merchant Disputes Report
Purpose Use this report to retrieve merchant disputes information (i.e.,
dispute type, merchant number, resolved date, settlement amount,
etc.).
Method GET
Endpoint /standard/merchantDisputes
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchantDisputes

Parameters
Field Name M/C/O Type No Valid Characters Description

billingAdjustmentDate O Datetime 25 Alphanumeric (a-z,A- The date a billing

Z,0-9) . = \ [ ] # : _ ? * / adjustment was issued
@ ; - & and space to the merchant.

Example: 2019-10-
30T09:00:26.473

processingDateTime O Datetime 25 Alphanumeric (a-z,A- Date and time of dispute

Z,0-9) . = \ [ ] # : _ ? * / processing. Timestamp
@ ; - & and space is Central Standard
Time.
Example: 2019-10-
30T09:00:26.473

sortBy O Text Alphanumeric (a-z,A- Allows sorting of the

Z,0-9) . = \ [ ] # : _ ? * / paginated result set,
@ ; - & and space multiple order by
allowed.
Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific page to

be returned from a result
Example: 10 list.

pageSize O Number Numeric (0-9) Allows setting of the

number of results to be
Max results: 1000 returned per page.
Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden

Example Values: Merchant Disputes Array

Field Name M/C/O Type No Valid Characters Description

billingAdjustmentDate O Datetime 25 Alphanumeric (a-z,A- Date of billing adjustment.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-3
cardNumberMasked O Text 20 Alphanumeric (a-z,A- Card number used on
Z,0-9) . = \ [ ] # : _ ? * / transaction is returned in
@ ; - & and space masked format.

Example:
421111**2345

disputeType O Text 128 Alphanumeric (a-z,A- Dispute description.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Chargeback
request

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

originalTranRefNo O Text 30 Alphanumeric (a-z,A- A 23-digit numeric string.

Z,0-9

Example:
983910473283921234
61237
pendingSettlementDat O Datetime 25 Alphanumeric (a-z,A- Date the disputed amount
e Z,0-9) . = \ [ ] # : _ ? * / is to be credited to
@ ; - & and space merchant or cardholder.

Example: 2019-10-
30T09:00:26.473

sourceProcessingDate O Datetime 25 Alphanumeric (a-z,A- Date and time of dispute

Time Z,0-9) . = \ [ ] # : _ ? * / processing. Timestamp is
@ ; - & and space Central Standard Time.

Example: 2019-10-
30T09:00:26.473

processingDateTime O Datetime 25 Alphanumeric (a-z,A- Date and time of dispute

Z,0-9) . = \ [ ] # : _ ? * / processing. Timestamp is
@ ; - & and space Central Standard Time.

Example: 2019-10-
30T09:00:26.473

processorName O Text 128 Alphanumeric (a-z,A- Association of the dispute.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Visa

reasonCodeDescriptio O Text 500 Alphanumeric (a-z,A- Dispute reason assigned

n Z,0-9) . = \ [ ] # : _ ? * / by association.
@ ; - & and space

Example: 123

resolvedDate O Datetime 10 Alphanumeric (a-z,A- Date of dispute resolution.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 2019-10-03

settlementAmount O Money 19 Numeric with decimal Amount settled on the

dispute transaction.
Example: 349.00

settlementDate O Datetime 10 Alphanumeric (a-z,A- Transaction clearing date.

Z,0-9) . = \ [ ] # : _ ? * / Timestamp is Central
@ ; - & and space Standard Time.

Example: 2019-10-03
transactionAmount O Money 19 Numeric with decimal Amount of disputed
transaction.
Example: 349.00

transactionDateTime O Datetime 25 Alphanumeric (a-z,A- Date and time of original

Z,0-9) . = \ [ ] # : _ ? * / transaction. Timestamp is
@ ; - & and space based on the time zone of
the terminal where the
Example: 2019-10- transaction occurred.
30T9:00.26.473

Example Values: Metadata

Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a-z,A- Identifier for this API call.

Z,0-9) . = \ [ ] # : _ ? * Can be provided for
/ @ ; - & and space tracing interactions.

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a-z,A- Timestamp of when the

Z,0-9) . = \ [ ] # : _ ? * API call occurred.
/ @ ; - & and space

Example: 2019-12-
12T22:59:10.244049
8

Example Values: Page

Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or Indicates if the given page

False is the last page in the
report.
Example: false

number O Number Numeric (0-9) Index of paging object.

Increment to get new
Example: 1 pages of response.
size O Number Numeric (0-9) Indicates the number of
records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in

the returned report.
Example: 142

Example Response: Merchant Disputes Report

{
"merchantDisputes": [
{
"merchantNumber": "6588000000999998",
"cardNumberMasked": "421111**2345",
"disputeType": "Chargeback Request",
"originalTranRefNo": "23 digit Numeric String",
"processingDateTime": "2019-10-30T09:00:26.473",
"processorName": "Visa",
"reasonCodeDescription": "Alpha Numeric String",
"pendingSettlementDate": "string",
"resolvedDate": "string",
"billingAdjustmentDate": "string",
"settlementAmount": "345.00",
"settlementDate": "2019-10-03",
"sourceProcessingDateTime": "2019-10-30T09:00:26.473",
"transactionAmount": "456.00",
"transactionDateTime": "2019-10-30T09:00:26.473"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}
G. Merchant Transactions Report
Purpose Use this report to retrieve transaction details (i.e., interchange
amount, settlement date, terminal number, etc.).
Method GET
Endpoint /standard/merchantTransactions
Produces application/json

Production URL:
https://reporting.clearent.net/data/api/v1/standard/merchantTransactions

Parameters
Field Name M/C/O Type No Valid Characters Description

settlementDate O Datetime 10 Alphanumeric (a-z,A-Z,0- Transaction clearing

9) . = \ [ ] # : _ ? * / @ ; - date. Timestamp is
& and space Central Standard Time.

Example: 2019-10-24

transactionDate O Datetime 10 Alphanumeric (a-z,A-Z,0- Date transaction was

9) . = \ [ ] # : _ ? * / @ ; - recorded by the
& and space terminal. Timestamp is
based on the time zone
Example: 2019-10-24 of the terminal where
T9:00.26.473 the transaction
occurred.

merchantNumber O Text 30 Alphanumeric (a-z,A-Z,0- Merchant ID (MID)

9) . = \ [ ] # : _ ? * / @ ; - Number.
& and space

Example:
6588000000999998
sortBy O Text Alphanumeric (a-z,A-Z,0- Allows sorting of the
9) . = \ [ ] # : _ ? * / @ ; - paginated result set,
& and space multiple order by
allowed.
Example :
desc(MerchantNumber),
asc(TransactionAmount)

pageNumber O Number Numeric (0-9) Allows a specific page

to be returned from a
Example: 10 result list.
pageSize O Number Numeric (0-9) Allows setting of the
number of results to be
Max results: 1000 returned per page.

Response Messages
Code Status

200 OK

401 Unauthorized

403 Forbidden

Example Values: Merchant Transactions Array

Field Name M/C/O Type No Valid Characters Description

accountName O Text 128 Alphanumeric (a-z,A- Merchant DBA name.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: Charlies
Pub

acquirerReferenceNu O Text 23 Alphanumeric (a-z,A- Lifecycle reference

mber Z,0-9) . = \ [ ] # : _ ? * / number for a transaction.
@ ; - & and space

Example:
127389875342567890
12346

approvalCode O Text 128 Alphanumeric (a-z,A- Association authorization

Z,0-9) . = \ [ ] # : _ ? * / code.
@ ; - & and space

Example: 65432A

authorizationAmount O Number 18 Numeric (0-9) with Amount of authorized

decimal transaction.

Example: 234.55

batchNumber O Text 32 Alphanumeric (a-z,A- Batch ID number.

Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: 278
batchReceivedDateTi O Datetime 25 Alphanumeric (a-z,A- Date when the batch
me Z,0-9) . = \ [ ] # : _ ? * / processed. Timestamp is
@ ; - & and space Central Standard Time.

Example: 2019-12-
12T22:59:10.2440498

captureTypeDescriptio O Text 250 Alphanumeric (a-z,A- Description of the card

n Z,0-9) . = \ [ ] # : _ ? * / capture type for the
@ ; - & and space transaction (i.e., Purchase,
Cash Advance, Return,
Example: Purchase Quasi Cash, Pin Pad
Debit, Debit Return, Food
Stamps Sale, Food
Stamps Return, Cash
Benefits Sale, Check
Verification with
Conversion, Check
Guarantee with
Conversion, Check
conversion Only)

cardNetworkDescriptio O Text 250 Alphanumeric (a-z,A- Description of the network

n Z,0-9) . = \ [ ] # : _ ? * / on which the transaction
@ ; - & and space occurred.

Example: Visa

cardNumberMasked O Text 50 Alphanumeric (a-z,A- Card number used on

Z,0-9) . = \ [ ] # : _ ? * / transaction is returned in
@ ; - & and space masked format.

Example:
421111**2345

interchangeAmount O Number 18 Numeric with decimal Total amount billed by

association.
Example: 223.00

interchangeFee O Number 18 Numeric with decimal Fee assessed related to

the interchange rates
Example: 0.20 established by the credit
card associations.

interchangeRate O Number 18 Numeric with decimal Percentage of transaction

amount charged by
Example: .0012 association.
invoice O Text 255 Alphanumeric (a-z,A- Merchant invoice number.
Z,0-9) . = \ [ ] # : _ ? * /
@ ; - & and space

Example: I0223

merchantNumber O Text 30 Alphanumeric (a-z,A- Merchant ID (MID)

Z,0-9) . = \ [ ] # : _ ? * / Number.
@ ; - & and space

Example:
6588000000999998

merchantTransactionK O Number 19 Numeric (0-9) This is an internal number

ey string used for transaction
Example: tracking.

oLSGatewayTranLogI O Number 19 Numeric (0-9) Gateway transaction log

D ID number.
Example:

orderID O Text 255 Alphanumeric (a-z,A- Customer supplied order

Z,0-9) . = \ [ ] # : _ ? * / number.
@ ; - & and space

Example: 0034362

qualificationLevelDesc O Text 250 Alphanumeric (a-z,A- Friendly qualification level

ription Z,0-9) . = \ [ ] # : _ ? * / name description.
@ ; - & and space

Example: Merit II

settlementDate O Date 10 Alphanumeric (a-z,A- Date the transaction was

Z,0-9) . = \ [ ] # : _ ? * / settled. Timestamp is
@ ; - & and space Central Standard Time.

Example: 2019-10-03

terminalNumber O Text 32 Alphanumeric (a-z,A- Unique identifier for a

Z,0-9) . = \ [ ] # : _ ? * / single POS machine or
@ ; - & and space virtual terminal.

Example: V7865489

transactionAmount O Number 18 Numeric with decimal Amount of transaction.

Example: 456.00
transactionDate O Date 10 Alphanumeric (a-z,A- Date transaction was
Z,0-9) . = \ [ ] # : _ ? * / recorded by the terminal.
@ ; - & and space Timestamp is based on
the time zone of the
Example: 2019-20-23 terminal where the
T9:00.26.473 transaction occurred.

transactionIdentifier O Text 64 Alphanumeric (a-z,A- Association assigned

Z,0-9) . = \ [ ] # : _ ? * / transaction identifier.
@ ; - & and space

Example:
567893874900876

Example Values: Metadata

Field Name M/C/O Type No Valid Characters Description

exchangeID O Text Alphanumeric (a-z,A- Identifier for this API call.

Z,0-9) . = \ [ ] # : _ ? * Can be provided for tracing
/ @ ; - & and space interactions.

Example: kklskefje

maxId O Number Numeric (0-9) Highest ID for records

returned. Can be used for
Example: 15 seek paging.

timestamp O Datetime Alphanumeric (a-z,A- Timestamp of when the API

Z,0-9) . = \ [ ] # : _ ? * call occurred.
/ @ ; - & and space

Example: 2019-12-
12T22:59:10.244049
8

Example Values: Page

Field Name M/C/O Type No Valid Characters Description

last O Boolean Returns True or Indicates if the given page is

False the last page in the report.

Example: false

number O Number Numeric (0-9) Index of paging object.

Increment to get new pages
Example: 1 of response.
size O Number Numeric (0-9) Indicates the number of
records per page.
Example: 10

totalElements O Number Numeric (0-9) Total number of pages in the

returned report.
Example: 142

Example Response: Merchant Transactions Report

{
"merchantTransactions": [
{
"merchantNumber": "6588000000999998",
"settlementDate": "2019-10-24",
"transactionDate": "2019-10-23",
"terminalNumber": "V7865489",
"batchNumber": "278",
"batchReceivedDateTime": "yy-mm-dd hh:mm:ss",
"cardNetworkDescription": "Visa",
"cardNumberMasked": "421111**2345",
"acquirerReferenceNumber": "12738987534256789012346",
"transactionIdentifier": "567893874900876",
"authorizationAmount": "234.55",
"transactionAmount": "456.00",
"interchangeFee": "0.20",
"interchangeRate": ".0012",
"interchangeAmount": ".2012",
"qualificationLevelDescription": "Merit II",
"captureTypeDescription": "Purchase",
"accountName": "Charlies Pub",
"orderID": "string",
"oLSGatewayTranLogID": "string",
"approvalCode": "65432A",
"invoice": "I0223",
"merchantTransactionKey": "string"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": true
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}

Example request: expectedFundingDate field (cURL format)

curl https://reporting.clearent.net/data/api/v1/standard/merchantClosedBatches?ExpectedFundedDateRange=2022-
10-19;%232022-10-20 -H "AccessKey: {Your Access Key}" -H "Content-Type: application/json"