Default
Date of Merchant Boarding into Clearent systems, i.e. 2019-10-03
Allows sorting of the paginated result set, multiple order by allowed, i.e. desc(MerchantNumber),asc(TransactionAmount)
Allows a specific page to be returned from a result list.
Allows setting of the number of results to be returned per page. Maximum number of results is 10000.
GET /data/api/v1/standard/merchants HTTP/1.1
Host: boarding.clearent.net
Accept: */*
OK
{
"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": "text",
"merchantComplianceStatusDescription": "SAQ taken and passed, scan not required",
"merchantSAQTypeCode": "P2Pe",
"merchantLastSAQPassDate": "2019-10-24",
"merchantSAQExpirationDate": "2020-10-31",
"merchantEmailAddress": "[email protected]",
"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": false
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:19.8563278",
"maxId": 15
}
}Merchant MID, i.e. 6588000000999998
Allows sorting of the paginated result set, multiple order by allowed, i.e. desc(MerchantNumber),asc(TransactionAmount)
Allows a specific page to be returned from a result list.
Allows setting of the number of results to be returned per page. Maximum number of results is 10000.
GET /data/api/v1/standard/merchantCurrentPricing HTTP/1.1
Host: boarding.clearent.net
Accept: */*
OK
{
"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": "text",
"pricingRate": "0.002",
"pricingFee": "0.20",
"payInMonth1": "6",
"payInMonth2": "7"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": false
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:20.4759332",
"maxId": 15
}
}Dispute Processing Date and Time, i.e. 2019-10-30T09:00:26.473
Allows sorting of the paginated result set, multiple order by allowed, i.e. desc(MerchantNumber),asc(TransactionAmount)
Allows a specific page to be returned from a result list.
Allows setting of the number of results to be returned per page. Maximum number of results is 10000.
GET /data/api/v1/standard/merchantDisputes HTTP/1.1
Host: boarding.clearent.net
Accept: */*
OK
{
"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": "text",
"resolvedDate": "text",
"billingAdjustmentDate": "text",
"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": false
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:20.7445885",
"maxId": 15
}
}Date a case was created, i.e. 2019-10-02
Date a case was closed, i.e. 2019-10-03
Allows sorting of the paginated result set, multiple order by allowed, i.e. desc(MerchantNumber),asc(TransactionAmount)
Allows a specific page to be returned from a result list.
Allows setting of the number of results to be returned per page. Maximum number of results is 10000.
GET /data/api/v1/standard/merchantCases HTTP/1.1
Host: boarding.clearent.net
Accept: */*
OK
{
"merchantCases": [
{
"merchantNumber": "6588000000999998",
"caseNumber": "text",
"createdDate": "2019-10-02",
"closedDate": "2019-10-03",
"reason": "text",
"caseCategory": "text",
"description": "Equipment Question"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": false
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:21.0066551",
"maxId": 15
}
}Calculated Date based on Next Day funding Flag, i.e. 2019-10-03
Deposit/Withdrawal Request Date and Time, i.e. 2019-10-30T09:00:26.473
Merchant MID, i.e. 6588000000999998
Allows sorting of the paginated result set, multiple order by allowed, i.e. desc(MerchantNumber),asc(TransactionAmount)
Allows a specific page to be returned from a result list.
Allows setting of the number of results to be returned per page. Maximum number of results is 10000.
GET /data/api/v1/standard/merchantBankDeposits HTTP/1.1
Host: boarding.clearent.net
Accept: */*
OK
{
"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": false
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:21.2714154",
"maxId": 15
}
}Date transaction was settled, i.e. 2019-10-24
Date transaction was recorded by the terminal, i.e. 2019-10-23
Merchant MID, i.e. 6588000000999998
Allows sorting of the paginated result set, multiple order by allowed, i.e. desc(MerchantNumber),asc(TransactionAmount)
Allows a specific page to be returned from a result list.
Allows setting of the number of results to be returned per page. Maximum number of results is 10000.
GET /data/api/v1/standard/merchantTransactions HTTP/1.1
Host: boarding.clearent.net
Accept: */*
OK
{
"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": "text",
"oLSGatewayTranLogID": "text",
"approvalCode": "65432A",
"invoice": "I0223",
"merchantTransactionKey": "text"
}
],
"page": {
"number": 1,
"size": 10,
"totalElements": 142,
"last": false
},
"metadata": {
"exchangeId": "3kklskefje",
"timestamp": "2021-05-26T18:41:21.5611391",
"maxId": 15
}
}Was this helpful?