Report

Get Consolidated Funding

get

Retrieve itemized transactions for a specified timeframe, including batch and funding details for reconciliation.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters results by the start date of the settlement period. Start date must be earlier than endDate, otherwise, response returns no results. Format: YYYY-MM-DD.

endDateStringRequired

Filters results by the end date of the settlement period. Defaults to 90 days before the current date if no other parameter is provided. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

transactionBatchIdIntegerOptional

Filters results by a specific transaction batch ID. If provided, only data related to this ID is returned.

fundingRequestIdIntegerOptional

Filters results by a specific funding request. If provided, only details for the specified funding request ID are returned.

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/ConsolidatedFunding

GET /data/api/v1.0/reporting/ConsolidatedFunding?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "MerchantNumber": "6588000001234567",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "TaxpayerLegalName": "",
      "BusinessDBA": "Data Architects Inc.",
      "NextDayFunding": "No",
      "FundingRequestID": 65000,
      "TotalDepositAmount": 680.73,
      "SettlementDate": "2025-11-06T00:00:00",
      "ExpectedDepositDate": "2025-11-07T00:00:00",
      "BatchReceivedDateTime": "2025-11-05T21:22:45.137",
      "TransactionBatchID": 12345678,
      "BatchNumber": "123",
      "BatchTransactionCount": 1,
      "BatchAmount": 680.73,
      "BatchDepositAmount": 680.73,
      "AcquirerReferenceNumber": "251234567890007748386827",
      "ApprovalCode": "ABC123",
      "AuthorizationAmount": 680.73,
      "AuthorizationDateTime": null,
      "AuthorizationResponseCode": null,
      "AVSResult": "Z",
      "BillingCity": null,
      "BillingCompany": null,
      "BillingCountry": null,
      "BillingName": "Data Architects Inc. - Paylink",
      "BillingPhone": null,
      "BillingState": "",
      "BillingStreet1": null,
      "BillingStreet2": null,
      "BillingZip": "36064",
      "CardNumberMasked": "543238******1234",
      "CardProduct": "",
      "CardTransactionID": 5432100123,
      "CardType": "MasterCard",
      "CreditDebitName": "Credit",
      "Invoice": "12345",
      "IsCardPresent": "No",
      "IsCashAdvance": "No",
      "IsForeignCard": "No",
      "OrderID": "777777770",
      "POSEntryModeName": "Manual Entry",
      "PurchaseOrder": null,
      "ReferenceNumber": "777777770",
      "SalesTaxAmount": null,
      "ServiceFee": null,
      "SoftwareType": "MHVT",
      "TipAmount": null,
      "TransactionAmount": 680.73,
      "TransactionDate": "2025-11-05T00:00:00",
      "TransactionType": "Sale",
      "BaseAmount": "680.73",
      "DDALastFour": "0001",
      "isConveyed": "Yes"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant ACH Returns and Rejects

get

Retrieve ACH return and reject details grouped by the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantACHReturns

GET /data/api/v1.0/reporting/MerchantACHReturns?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantNumber": "6588000001234567",
      "TaxpayerLegalName": "",
      "BusinessDBA": "Data Architects Inc.",
      "GW_MerchantId": "000002879922",
      "PayaTerminalID": "1538018",
      "ACHTransactionID": "e7dcc479-6ae4-4f8c-88b2-fe6afad8cfa5",
      "ACHDisposition": "Returned",
      "SecCode": "PPD",
      "TransactionType": "Debit",
      "Amount": "4731.68",
      "CheckNumber": null,
      "LastFourAccountNumber": "5503",
      "CreateDateTimeUTC": "2025-10-09T15:03:14.3621382",
      "ReturnCode": "R01",
      "ReturnMessage": "Insufficient Funds",
      "Company": null,
      "FirstName": "Jennifer",
      "LastName": "Weave",
      "Street1": "",
      "Street2": "",
      "Phone": null,
      "City": "",
      "State": null,
      "PostalCode": "53711",
      "SourceSystemCustomerID": null,
      "SourceSystemOrderID": null,
      "PurchaseOrder": null
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Application

get

Retrieve the application details and status of the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filter the results by the start date when the merchant was submitted, application status, or boarded. Format: YYYY-MM-DD.

endDateStringRequired

Filter the results by the end date when the merchant was submitted, application status, or boarded. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantApplication

GET /data/api/v1.0/reporting/MerchantApplication?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "AnnualVolume": 1000000,
      "ApplicationStatusDate": "2025-03-25T06:10:32.607",
      "ApplicationStatus": "Underwriting",
      "BankIDNumber": "419304",
      "BoardedStatusDate": null,
      "BoardedStatus": null,
      "ExternalCustomerID": "",
      "MerchantDBA": "Merchant ABC",
      "MerchantEmailAddress": "[email protected]",
      "MerchantNumber": "6588000015863999",
      "MerchantPhysicalAddressLine1": "PO BOX 1230",
      "MerchantPhysicalAddressLine2": "",
      "MerchantPhysicalCity": "TOWNSHIP",
      "MerchantPhysicalStateOrProvince": "NJ",
      "MerchantPhysicalPostalCode": "08831",
      "MerchantPrincipal1FirstName": "Dave",
      "MerchantPrincipal1LastName": "LastName",
      "MerchantPrincipal1Percentage": 1,
      "ParentBusinessDBA": "Parent ISO",
      "ParentMerchantNumber": "6588000001389999",
      "ResellerBusinessDBA": "Parent ISO",
      "ResellerMerchantNumber": "6588000001389999",
      "SponsorBankDesc": "Bank",
      "MerchantTaxpayerLegalName": "Legal Name",
      "Website": null,
      "ApplicationSubmittedDate": "2025-03-25T06:10:32.507"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Attestation Status

get

Retrieve the attestation status and related compliance details for the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantAttestation

GET /data/api/v1.0/reporting/MerchantAttestation?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "AccountExecutiveName": null,
      "AttestationType": "Sporting Goods and Firearms",
      "AttestationStatus": "NonCompliant",
      "AttestationCompleteDate": null,
      "AttestationExpirationDate": null,
      "BoardingDate": "2023-03-10T00:00:00",
      "BusinessPhoneNumber": "",
      "BusinessStatusName": "Open",
      "EmailAddress": "[email protected]",
      "IsSeasonal": "No",
      "LastDepositDate": "2025-11-26T00:00:00",
      "LastStatusChangeDateTime": "2023-03-09T19:34:23.99",
      "BusinessID": 930058,
      "MerchantBusinessDBA": "text",
      "MerchantNumber": "6588000001234567",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "Principal1FirstName": "",
      "Principal1LastName": "",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "SeasonalMonths": "",
      "TaxPayerLegalName": "",
      "MasterTemplateId": 6,
      "MasterTemplateName": "Empower - Cash Discount"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Attrition

get

Retrieve the inactive merchant details including key dates of their most recent activity.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters results by the start date when first deposit settled. Format: YYYY-MM-DD.

endDateStringRequired

Filters results by the end date when last deposit settled. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantAttrition

GET /data/api/v1.0/reporting/MerchantAttrition?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "BusinessDimKey": 137807,
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantNumber": "6588000001234567",
      "MerchantDBA": "text",
      "MerchantTaxpayerLegalname": "",
      "MerchantStatusName": "Suspended",
      "ExternalCustomerID": "",
      "MerchantBoardedDateTime": "2019-11-11T00:00:00",
      "FirstDepositDate": "2019-11-18T00:00:00",
      "LatestDepositDate": "2025-06-25T00:00:00",
      "CancellationDate": "2025-10-01T00:00:00",
      "DaysOnGateway": "2151",
      "BankIDNumber": "419304",
      "CurrentSalesChannelDescription": "ISO",
      "MCC": "5812",
      "MCCDescription": "Restaurants",
      "SalesActivationDate": "2019-11-16T00:00:00",
      "DaysLastTransactionToSuspend": 100,
      "ClosedMonthVolume": null,
      "LastTransactionDate": "2025-06-23T00:00:00",
      "PriorYearClosedMonthVolume": 23684.35,
      "Prior12MonthsVolume": 162116.9
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Billing

get

Retrieve the billing activity and information grouped by month for a specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters results by the start date of the billing period. The value must be the first day of the month. Default is the first day of the previous month. Format: YYYY-MM-DD.

endDateStringRequired

Filters results by the end date of the billing period. The value must be the last day of the same month as the start date. Default is the last day of the month defined by the start date. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantBilling

GET /data/api/v1.0/reporting/MerchantBilling?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantBusinessDBA": "text",
      "MerchantNumber": "6588000001100122",
      "TaxpayerLegalName": "",
      "BankIDNumber": "123456",
      "ExternalCustomerID": null,
      "PhysicalAddress": "oosevelt Rd",
      "BillingCycleRange": "10/01/2025 - 10/31/2025",
      "Association": "Processing Fees",
      "FeeDescription": "PCI Non Compliance Fee",
      "Items": 1,
      "Volume": 0,
      "Rate": 0,
      "ItemFee": 24.95,
      "Fees": 24.95
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Equipment Records

get

Retrieve the equipment details associated with the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filter the results by the start date based on the equipment order creation. Format: YYYY-MM-DD.

endDateStringRequired

Filter the results by the end date based on the equipment order creation. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantEquipment

GET /data/api/v1.0/reporting/MerchantEquipment?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantBusinessDBA": "text",
      "MerchantNumber": "6588000001234567",
      "TaxPayerLegalName": "",
      "BoardedDateTime": "2019-10-23T00:00:00",
      "OrderDate": "2025-08-11T00:00:00",
      "OrderStatus": "Completed",
      "TerminalID": "77098749",
      "Quantity": 1,
      "ModelName": "PAX StageOnly",
      "Street": null,
      "Street2": null,
      "City": null,
      "StateName": null,
      "Zip": null,
      "TrackingNumber": "N/A",
      "SerialNumber": null
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Funding Activity

get

Retrieve the funding activity details for the specified merchant, including batch numbers, settlement dates, transaction activity, and amounts.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters results by the start date when first deposit settled. Format: YYYY-MM-DD.

endDateStringRequired

Filters results by the end date when last deposit settled. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/FundingActivity

GET /data/api/v1.0/reporting/FundingActivity?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "BusinessDBA": "text",
      "MerchantNumber": "6588000001234567",
      "MerchantTaxpayerLegalName": "text",
      "SettlementMethod": "Daily",
      "IsEMF": "Yes",
      "FundingRequestID": 62964,
      "BatchNumber": "318",
      "TerminalNumber": "77487092",
      "BatchAmount": 471.38,
      "DailyFeeAmount": -15.942,
      "SettlementDate": "2025-08-17T00:00:00",
      "ExpectedFundingDate": "2025-08-18T00:00:00",
      "FundingEventTypeName": "Deposit",
      "Amount": 455.44,
      "AccountNumberMasked": "******1234",
      "NachaFileName": "NACHA_419304_ID62964_20250816_EMF.txt",
      "BankIDNumber": "419304",
      "CreationDayOfWeek": "2025-08-16T00:00:00",
      "FundingType": "Next-Day Funding",
      "FRDateTime": "2025-08-16T22:44:24.64"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Interchange Qualification

get

Retrieve the interchange and qualification details grouped by the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters results by the date when the first settlement occurred. Format: YYYY-MM-DD.

endDateStringRequired

Filters results by the date when the last settlement occurred. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/InterchangeQualification

GET /data/api/v1.0/reporting/InterchangeQualification?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000002022572",
      "MerchantBusinessDBA": "text",
      "MerchantNumber": "6588000001234567",
      "TerminalNumber": "12345678",
      "MerchantMCC": "7629",
      "ReportStartDate": "2025-11-11",
      "ReportEndDate": "2025-11-11",
      "AuthorizationDateTime": "2025-11-10T17:21:24",
      "SettlementDateDimKey": "2025-11-11T00:00:00",
      "OLSGatewayTranLogID": 776932231,
      "AuthorizationAmount": 66.4,
      "TransactionAmount": 66.4,
      "InterchangeAmount": -0.6812,
      "TransactionDateDimKey": "2025-11-10T00:00:00",
      "CardNetworkCategory": "Visa",
      "QualificationLevelDescription": "CPS/Retail Debit",
      "InterchangeRate": 0.008,
      "InterchangeFee": 0.15,
      "PosEntryModeCode": "05",
      "PosEntryModeDescription": "Integrated circuit card read, CVV data reliable",
      "CardPresent": true,
      "RejectReasons": "Reject:. Downgrades:",
      "CardTransactionID": 5479443178
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Disputes Lifecycle

get

Retrieve the disputes lifecycle report within the specified date range of the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters results by the start date when disputes received. Format: YYYY-MM-DD.

endDateStringRequired

Filters results by the end date when disputes received. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/DisputesLifecycle

GET /data/api/v1.0/reporting/DisputesLifecycle?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerHNK": "6588000001100122",
      "ResellerDBA": "Merchant Specialists",
      "ParentHNK": "6588000001100123",
      "ParentDBA": "First Merchants LLC",
      "MID": "6588000001234567",
      "MIDLegalName": "text",
      "MIDDBA": "text",
      "CaseFamilyID": "58563095",
      "CaseNumber": 2025118038408,
      "CaseType": "Collaboration",
      "Reason": "Not as described or defective merchandise/services",
      "CaseStatus": "Settled",
      "CardNumberMasked": "543238******1234",
      "CardType": "MasterCard",
      "TransactionType": "Retail Sale",
      "OriginalTrxnFundsFlow": "NULL",
      "OriginalReferenceNumber": "465099734640482",
      "ReferenceNumber": "24193045100006849950918",
      "TransactionDate": "2025-04-10T00:00:00",
      "TransactionAmount": 992.72,
      "DisputeDate": "2025-04-27T00:00:00",
      "DisputeAmount": 992.72,
      "MerchantAmount": 992.72,
      "RespondBy": "2025-05-18T00:00:00",
      "ResponseDate": "2025-04-29T00:00:00",
      "ResolvedDate": "2025-04-28T00:00:00"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Support Ticket Activity

get

Retrieve the portfolio-level details of support ticket activity for the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filters result by the start date when the last case was modified. Format: YYYY-MM-DD.

endDateStringRequired

Filters result by the end date of the most recent case modification. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/SupportTicketActivity

GET /data/api/v1.0/reporting/SupportTicketActivity?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerMerchantNumber": "6588000001100122",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ParentMerchantNumber": "6588000001100123",
      "ParentBusinessDBA": "First Merchants LLC",
      "MerchantNumber": "6588000001234567",
      "TaxpayerLegalName": null,
      "MerchantBusinessDBA": "text",
      "CaseNumber": "03245801",
      "CaseOrigin": "Email",
      "CreatedDate": "2025-09-30T19:54:38",
      "FirstResponseDateTime": null,
      "LastModifyDateTime": "2025-10-01T15:54:05",
      "ClosedDate": "2025-10-01T15:54:05",
      "Reason": null,
      "Description": "Is there an alert for the Saturday issue?",
      "ExternalCaseStatus": null,
      "SubmittedBy": "text"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Chargebacks

get

Retrieve the chargeback details with reason codes and dates of the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filter the results by date when the first chargeback was settled in Xplor Pay system. Default to 90 days before the current date. Format: YYYY-MM-DD.

endDateStringRequired

Filter the results by date when the last chargeback was settled in Xplor Pay system. Default to the current date. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantChargebacks

GET /data/api/v1.0/reporting/MerchantChargebacks?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantNumber": "6588000001234567",
      "MerchantLegalname": "text",
      "MerchantDBA": "text",
      "ProcessingDateTime": "2025-10-13T08:25:59.433",
      "TransactionAmount": 63.53,
      "DisputeType": "Chargeback Request",
      "ReasonCodeDescription": "Not Applicable",
      "DispositionStatus": "Settled",
      "DispositionStatusDate": "2025-10-13T08:25:59.433",
      "CardNumberMasked": "543238******1234",
      "ProcessorName": "MasterCard",
      "QuestTransactionID": null,
      "TransactionDateTime": "2025-09-10T00:00:00",
      "OriginalTransactionSettlementDate": "2025-09-11T00:00:00",
      "SettlementDate": "2025-10-13T00:00:00",
      "OriginalTranRefNo": "25265085254130884100062",
      "PendingSettlementDate": null,
      "ResolvedDate": "2025-10-13T00:00:00",
      "BillingAdjustmentDate": null,
      "SettlementAmount": -63.53,
      "SourceProcessingDateTime": "2025-10-13T00:00:00",
      "BillingAdjustmentAmount": null,
      "BillingAdjustmentDescription": null,
      "TotalAmount": null
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Information

get

Retrieve the general information of the specified merchant, including ACH, CBD, and PCI status details.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantInformation

GET /data/api/v1.0/reporting/MerchantInformation?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantDBA": "text",
      "MerchantNumber": "6588000001234567",
      "MerchantTaxpayerLegalName": "",
      "ExternalCustomerID": null,
      "IsACHEnabled": "False",
      "IsSellsCBD": "False",
      "CBDAnnualRevenuePercentage": null,
      "CBDProductInventoryPercentage": null,
      "CBDIncorporatedDate": null,
      "CBDCategoryDescription": null,
      "IsMerchantCompliant": "Non-Compliant",
      "MerchantBoardedDate": "2022-03-09T00:00:00",
      "MerchantBankIDNumber": "419304",
      "MerchantIncorporationTypeDescription": "Sole proprietorship",
      "IsMerchantNextDayFundingEnabled": "No",
      "MerchantSettlementMethodName": "Daily",
      "MerchantAmexSENumber": null,
      "MerchantAmexMID": null,
      "MerchantDiscoverMID": "601123000560179",
      "MerchantStatusDescription": "Entity Record is not Active. May be re-activated.",
      "MerchantComplianceStatusDescription": "SAQ required, not taken",
      "MerchantSAQTypeCode": "Not Selected",
      "MerchantLastSAQPassDate": null,
      "MerchantSAQExpirationDate": null,
      "MerchantEmailAddress": "[email protected]",
      "MerchantBusinessPhoneNumberFull": "626-576-1415",
      "MerchantTINStatusDescription": "TIN and Name combination matches IRS SSN records",
      "MerchantMailingAddressLine1": "841 W VALLEY",
      "MerchantMailingAddressLine2": null,
      "MerchantMailingCity": "ALHAMBRA",
      "MerchantMailingPostalCode": "91803",
      "MerchantMailingStateProvince": "CA",
      "MerchantMCCDescription": "Dentists",
      "MerchantPhysicalAddressLine1": "841 W VALLEY BLVD # 105",
      "MerchantPhysicalAddressLine2": "",
      "MerchantPhysicalCity": "ALHAMBRA",
      "MerchantPhysicalPostalCode": "91803",
      "MerchantPhysicalStateOrProvince": "CA",
      "MerchantPrincipal1FirstName": "DE GIAP",
      "MerchantPrincipal1LastName": "NGUYEN",
      "MerchantPrincipal1Percentage": 1,
      "MerchantPrincipal2FirstName": null,
      "MerchantPrincipal2LastName": null,
      "MerchantPrincipal2Percentage": null
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Users

get

Retrieve the user role, status, activity, and contact information for the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantUser

GET /data/api/v1.0/reporting/MerchantUser?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "MerchantNumber": "6588000001234567",
      "BusinessID": 123456,
      "MerchantBusinessDBA": "text",
      "TaxpayerLegalName": "",
      "BusinessStatusName": "Active",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "UserName": "text",
      "UserStatus": "PasswordExpired",
      "UserFirstName": "",
      "UserLastName": "",
      "UserEmail": "[email protected]",
      "CompassLastLogin": "",
      "LastLogin": "",
      "Roles": "Compass Merchant, MerchantAdmin, MerchantHomeUser, VirtualTerminalUser, VTAccountAnalysts"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Monthly Residual Details

get

Retrieve the portfolio residual details of the specified merchant, including billed volume, fees, income, and settlement details.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filter the results by the start date of the billing month. The value must be the first day of the month. Format: YYYY-MM-DD.

endDateStringRequired

Filter the results by the end date of the billing month. The value must be the last day of the same month as the start date. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantMonthlyResiduals

GET /data/api/v1.0/reporting/MerchantMonthlyResiduals?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ActualSplitPercent": 0.95,
      "AdditionalDetail": "",
      "AmountBilled": 0,
      "AuthsBilled": 0,
      "BillingFee": 0,
      "BillingRate": 0,
      "BoardedDateTime": "2022-03-11T00:00:00",
      "CardNetworkDescription": "Visa",
      "ExternalCustomerID": null,
      "Income": 0,
      "MCC": "7629",
      "MCCDescription": "Repair Shops",
      "MerchantNumber": "6588000001100122",
      "MerchantBusinessDBA": "text",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "PricingPlanTypeName": "Discount",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ResidualDispositionGroup": "Gross Revenue",
      "ResidualFeeDescription": "ExpressMerchantFundingRevenue",
      "SettlementYearMonthName": "2025-09",
      "SortOrder": 1,
      "TaxPayerLegalName": "text",
      "TransactionsBilled": 86,
      "VolumeBilled": 8643.79
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant PCI Status

get

Retrieve the current PCI compliance status for the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantPCIStatus

GET /data/api/v1.0/reporting/MerchantPCIStatus?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "AccountExecutiveName": null,
      "BoardingDate": "2022-03-09T00:00:00",
      "BusinessID": 123456,
      "BusinessPhoneNumber": "626-576-1415",
      "BusinessStatusName": "Suspended",
      "EmailAddress": "[email protected]",
      "ExpirationDate": null,
      "IsMerchantCompliant": "N/A",
      "IsSeasonal": "No",
      "LatestDepositDate": "2022-03-14T00:00:00",
      "LastPassedDate": null,
      "LastSAQDate": null,
      "LastScanDate": null,
      "LastValidationDate": null,
      "MailingAddressLine1": "VALLEY BLVD",
      "MailingAddressLine2": null,
      "MailingCity": "ALHAMBRA",
      "MailingStateProvince": "CA",
      "MailingPostalCode": "91803",
      "MerchantBusinessDBA": "",
      "MerchantNumber": "6588000001234567",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "PCIComplianceStatusDescription": "SAQ required, not taken",
      "Principal1FirstName": "",
      "Principal1LastName": "",
      "LastStatusChangeDateTime": "2022-05-12T20:50:39.527",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "SAQStatus": "Unknown",
      "SAQType": "Not Selected",
      "ScanStatus": "Unknown",
      "SeasonalMonths": "",
      "TaxpayerLegalname": ""
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Portfolio Report

get

Retrieve the key information and activity within a portfolio of the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/Portfolio

GET /data/api/v1.0/reporting/Portfolio?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerMerchantNumber": "6588000001299999",
      "ResellerBusinessDBA": "Inc - ISV",
      "ParentMerchantNumber": "6588000001999999",
      "ParentBusinessDBA": "PARTNER",
      "MerchantNumber": "6588000001999998",
      "TaxpayerLegalName": "Tax Payer",
      "MerchantBusinessDBA": "Business",
      "PhysicalAddress1": "111 Central Ave",
      "PhysicalAddress2": "Suite 100",
      "PhysicalCity": "Ctiy",
      "PhysicalStateProvince": "MO",
      "PhysicalPostalCode": "63105",
      "MailingAddress1": "111 Central Ave",
      "MailingAddress2": "Suite 100",
      "MailingCity": "City",
      "MailingStateProvince": "MO",
      "MailingPostalCode": "63105",
      "BusinessEmailAddress": "[email protected]",
      "Principal1FirstName": "Contact",
      "Principal1LastName": "Name",
      "PrincipalHomePhoneNumber": null,
      "PrimaryContactEmailAddress": "[email protected]",
      "BusinessStatusName": "Suspended",
      "LastStatusChangeDateTime": "2020-05-30T11:08:16.843",
      "BoardedDatetime": "2019-01-25T00:00:00",
      "FirstDepositDate": null,
      "LatestDepositDate": null,
      "AccountNumberLastFour": "0000",
      "MCC": "7230",
      "BankRoutingNumberDeposits": "61099999",
      "BankRoutingNumberMonthlyFees": "610999999",
      "BankRoutingNumberDailyFees": "6109999999",
      "BankRoutingNumberAdjustments": "610999999",
      "TINLastFour": "",
      "IsSeasonal": "No",
      "SeasonalMonths": null,
      "ExternalCustomerID": "",
      "ACHAverageDebitTransactionYTD": null,
      "ACHDebitAmountYTD": null,
      "ACHDebitCountYTD": null,
      "ACHAverageCreditTransactionYTD": null,
      "ACHCreditAmountYTD": null,
      "ACHCreditCountYTD": null,
      "AverageTicketTrailingTwelveMonths": null,
      "CreditCardVolumeYTD": null,
      "CreditCardTransactionsYTD": null,
      "CreditCardAverageTicketYTD": null,
      "TransactionVolumeLastMonth": 0,
      "TransactionCountLastMonth": 0,
      "TransactionVolumeMTD": 0,
      "TransactionCountMTD": 0,
      "ChargeBackVolumeYTD": null,
      "ChargeBackTransactionsYTD": null,
      "ChargebackAverageTransactionYTD": null,
      "ChargebackVolumeLastMonth": 0,
      "ChargebackCountLastMonth": 0,
      "RiskLevelName": "Low"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Pricing

get

Retrieve the merchant pricing details based on the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantPricing

GET /data/api/v1.0/reporting/MerchantPricing?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantNumber": "6588000001234567",
      "TaxpayerLegalName": "",
      "MerchantBusinessDBA": "text",
      "ExternalCustomerID": null,
      "IsDailySettled": true,
      "IsEMF": false,
      "BoardedDate": "2025-11-18",
      "BusinessStatusName": "Active",
      "PricingFeeDescription": "PinDebit Switch Fee",
      "PricingRate": 1.25,
      "PricingFee": 0,
      "FeePaidInMonth1": null,
      "FeePaidInMonth2": null,
      "PayInMonth1": null,
      "PayInMonth2": null,
      "PricingFeeEffectiveDate": "2070-12-31",
      "PricingFeeModifiedDate": "2025-11-18T12:03:30.837",
      "PricingPlanType": "IC+",
      "EffectiveStartDateTime": "2025-11-18T00:00:00",
      "EffectiveEndDateTime": "2070-12-31T23:59:59.997",
      "PricingFeeID": 114,
      "MasterTemplateName": "Standard Template A"
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Residual Summary

get

Retrieve the summary of portfolio residuals of the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filter the results by the start date of the billing month. The value must be the first day of the month. Format: YYYY-MM-DD.

endDateStringRequired

Filter the results by the end date of the billing month. The value must be the last day of the same month as the start date. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/ResidualSummary

GET /data/api/v1.0/reporting/ResidualSummary?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResidualMonth": "2025-09",
      "AuthCount": 379,
      "AverageTicket": 101.8233,
      "Expense": 7.7057,
      "Interchange": 233.9595,
      "MerchantDBA": "text",
      "MerchantDimKey": 123456,
      "MerchantNumber": "6588000001234567",
      "NetRevenue": 155.913,
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "PassThroughRevenue": 36.9,
      "PassThroughExpense": -17.95,
      "PassThroughIncome": 18.95,
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ResidualIncome": 167.0674,
      "ResidualIncomeYTD": 1669.7593,
      "Revenue": 397.5782,
      "NetSalesAmount": 11607.86,
      "SplitPercent": 0.95,
      "TaxPayerLegalName": "",
      "TransactionCount": 114
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Terminal

get

Retrieve the terminal ID and MID details for merchants that have closed one or more batches.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantTerminal

GET /data/api/v1.0/reporting/MerchantTerminal?pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "MerchantNumber": "6588000001234567",
      "MerchantBusinessDBA": "text",
      "ExternalCustomerID": null,
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "TaxPayerLegalName": "",
      "TerminalNumber": "V1234567",
      "TerminalName": ""
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

Get Merchant Withholding

get

Retrieve the portfolio-level details of backup withholding for the specified merchant.

Query parameters

merchantNumberStringOptional

The merchant's unique identification number.

startDateStringRequired

Filter the results by date when the first merchant withholding occurred. Format: YYYY-MM-DD.

endDateStringRequired

Filter the results by date when the last merchant withholding occurred. Format: YYYY-MM-DD.

sortColumnStringOptional

Specifies the column name used to sort the result set.

sortDirectionStringOptional

Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).

pageNumberIntegerRequired

Specifies the page number of results to return when pagination is applied.

pageSizeIntegerRequired

Specifies the number of results to return per page. Maximum: 10000. Default: 50.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/reporting/MerchantWithholding

GET /data/api/v1.0/reporting/MerchantWithholding?startDate=null&endDate=null&pageNumber=null&pageSize=null HTTP/1.1
Accept: */*

{
  "pageSettings": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalPages": 98936,
    "totalRecords": 98936,
    "grandTotal": 6034175.75
  },
  "content": [
    {
      "ResellerBusinessDBA": "Merchant Specialists",
      "ResellerMerchantNumber": "6588000001100122",
      "ParentBusinessDBA": "First Merchants LLC",
      "ParentMerchantNumber": "6588000001100123",
      "MerchantBusinessDBA": "text",
      "MerchantNumber": "6588000001234567",
      "TaxPayerLegalName": "",
      "BoardedDateTime": "2019-10-23T00:00:00",
      "OrderDate": "2025-08-11T00:00:00",
      "OrderStatus": "Completed",
      "TerminalID": "77098749",
      "Quantity": 1,
      "ModelName": "PAX StageOnly",
      "Street": null,
      "Street2": null,
      "City": null,
      "StateName": null,
      "Zip": null,
      "TrackingNumber": "N/A",
      "SerialNumber": null
    }
  ],
  "metadata": {
    "exchangeId": "DataHubTesting-d019025b-d69e-485b-bb3f-5a111dac9fb9",
    "timestamp": "2025-11-05T08:10:04.182214Z"
  }
}

PreviousEnhanced Reporting NextModels

Last updated 18 hours ago

Was this helpful?

hashtagGet Consolidated Funding

hashtagGet Merchant ACH Returns and Rejects

hashtagGet Merchant Application

hashtagGet Attestation Status

hashtagGet Merchant Attrition

hashtagGet Merchant Billing

hashtagGet Merchant Equipment Records

hashtagGet Merchant Funding Activity

hashtagGet Merchant Interchange Qualification

hashtagGet Disputes Lifecycle

hashtagGet Merchant Support Ticket Activity

hashtagGet Merchant Chargebacks

hashtagGet Merchant Information

hashtagGet Merchant Users

hashtagGet Monthly Residual Details

hashtagGet Merchant PCI Status

hashtagGet Portfolio Report

hashtagGet Merchant Pricing

hashtagGet Residual Summary

hashtagGet Merchant Terminal

hashtagGet Merchant Withholding

Get Consolidated Funding

Get Merchant ACH Returns and Rejects

Get Merchant Application

Get Attestation Status

Get Merchant Attrition

Get Merchant Billing

Get Merchant Equipment Records

Get Merchant Funding Activity

Get Merchant Interchange Qualification

Get Disputes Lifecycle

Get Merchant Support Ticket Activity

Get Merchant Chargebacks

Get Merchant Information

Get Merchant Users

Get Monthly Residual Details

Get Merchant PCI Status

Get Portfolio Report

Get Merchant Pricing

Get Residual Summary

Get Merchant Terminal

Get Merchant Withholding