# Report

## Get Consolidated Funding

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/ConsolidatedFunding":{"get":{"tags":["Report"],"summary":"Get Consolidated Funding","description":"Retrieve itemized transactions for a specified timeframe, including batch and funding details for reconciliation.","parameters":[{"name":"merchantNumber","description":"The merchant's unique identification number.","in":"query","required":false,"schema":{"type":"String"}},{"name":"startDate","description":"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.","in":"query","required":true,"schema":{"type":"String"}},{"name":"endDate","description":"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.","in":"query","required":true,"schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"transactionBatchId","description":"Filters results by a specific transaction batch ID. If provided, only data related to this ID is returned.","in":"query","required":false,"schema":{"type":"Integer"}},{"name":"fundingRequestId","description":"Filters results by a specific funding request. If provided, only details for the specified funding request ID are returned.","in":"query","required":false,"schema":{"type":"Integer"}},{"name":"pageNumber","description":"Specifies the page number of results to return when pagination is applied.","in":"query","required":true,"schema":{"type":"Integer"}},{"name":"pageSize","description":"Specifies the number of results to return per page. \nMaximum: 10000. Default: 50.","in":"query","required":true,"schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsolidatedFundingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"ConsolidatedFundingResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains details of consolidated funding transactions.","items":{"$ref":"#/components/schemas/ConsolidatedFundingContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"ConsolidatedFundingContent":{"type":"object","description":"Contains details of consolidated funding transactions.","properties":{"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name."},"ResellerMerchantNumber":{"type":"String","description":"The unique identifier assigned to the reseller."},"ParentBusinessDBA":{"type":"String","description":"DBA name of the parent merchant or business."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"TaxpayerLegalName":{"type":"String","description":"Merchant's legal name registered for tax purposes."},"BusinessDBA":{"type":"String","description":"The merchant's DBA name."},"NextDayFunding":{"type":"String","description":"Indicates whether next-day funding is enabled for merchant."},"FundingRequestID":{"type":"Number","description":"A unique ID assigned to the funding request."},"TotalDepositAmount":{"type":"Number","description":"The total deposit amount is deposited for the batch to the merchant account."},"SettlementDate":{"type":"String","description":"Date when the transaction was settled. Format: YYYY-MM-DDTHH:MM:SS."},"ExpectedDepositDate":{"type":"String","description":"The expected date and time when the deposit is funded. Format: YYYY-MM-DDTHH:MM:SS."},"BatchReceivedDateTime":{"type":"String","description":"Date and time when the batch was received for processing. Format: YYYY-MM-DDTHH:MM:SS.sss."},"TransactionBatchID":{"type":"Number","description":"Unique identifier assigned to the transaction batch."},"BatchNumber":{"type":"String","description":"Batch number assigned to the merchant's transactions."},"BatchTransactionCount":{"type":"Number","description":"Total number of transactions included in the batch."},"BatchAmount":{"type":"Number","description":"Total amount of all transactions in the batch."},"BatchDepositAmount":{"type":"Number","description":"Total deposit amount for the batch."},"AcquirerReferenceNumber":{"type":"String","description":"The acquirer's reference number associated with the transaction."},"ApprovalCode":{"type":"String","description":"Approval code returned by the card network."},"AuthorizationAmount":{"type":"Number","description":"The authorized amount of the transaction."},"AuthorizationDateTime":{"type":"String","description":"Date and time when the transaction occurred. Format: YY-MM-DD HH:MM:SS."},"AuthorizationResponseCode":{"type":"String","description":"Returns the authorization response code received from the processor."},"AVSResult":{"type":"String","description":"Address Verification Service (AVS) result code."},"BillingCity":{"type":"String","description":"The cardholder's billing city."},"BillingCompany":{"type":"String","description":"Cardholder's billing company name."},"BillingCountry":{"type":"String","description":"Cardholder's billing country name."},"BillingName":{"type":"String","description":"Billing name of the cardholder."},"BillingPhone":{"type":"String","description":"Cardholder's billing phone number."},"BillingState":{"type":"String","description":"Cardholder's billing state or province."},"BillingStreet1":{"type":"String","description":"The first line of the cardholder's billing street address."},"BillingStreet2":{"type":"String","description":"The second line of the cardholder's billing street address."},"BillingZip":{"type":"String","description":"Cardholder's billing ZIP or postal code."},"CardNumberMasked":{"type":"String","description":"Displays the masked card number used in the transaction."},"CardProduct":{"type":"String","description":"Indicates the card product type."},"CardTransactionID":{"type":"Number","description":"A unique transaction identifier associated with the card payment."},"CardType":{"type":"String","description":"Indicates the card brand used for the transaction. Possible values: American Express, Debit Network, Discover, Electronic Benefit, MasterCard, Merlin, Not Applicable, Undefined, Unknown, Visa."},"CreditDebitName":{"type":"String","description":"Indicates whether the transaction was processed as credit or debit."},"Invoice":{"type":"String","description":"The invoice number associated with the transaction."},"IsCardPresent":{"type":"String","description":"Indicates whether the card was physically present during the transaction. Returns Yes or No."},"IsCashAdvance":{"type":"String","description":"Indicates whether the transaction is a cash-advance. Returns Yes or No."},"IsForeignCard":{"type":"String","description":"Indicates whether the card was issued outside the merchant's country. Returns Yes or No."},"OrderID":{"type":"String","description":"The order identifier assigned by the merchant or system."},"POSEntryModeName":{"type":"String","description":"POS entry method used for the transaction. Possible values: Bar Code Read, Contact Chip Read, Contactless Chip Transmission, Contactless Magnetic Stripe Transmission, E-Commerce, Magnetic Stripe Read, Magnetic Stripe Read (Fallback), Manual Entry, Manual Entry (Fallback), Merchant-Initiated (Card on File), Mobile Commerce, Not Applicable, Undefined, Unknown, Voice Authorization, Voice Response Unit."},"PurchaseOrder":{"type":"String","description":"Purchase order number associated with the transaction."},"ReferenceNumber":{"type":"String","description":"Unique system-generated reference number for the transaction."},"SalesTaxAmount":{"type":"Number","description":"Total sales tax amount included in the transaction."},"ServiceFee":{"type":"Number","description":"The service fee applied to the transaction."},"SoftwareType":{"type":"String","description":"Software or terminal used to process the transaction."},"TipAmount":{"type":"Number","description":"The tip amount included in the transaction."},"TransactionAmount":{"type":"Number","description":"Represents the total transaction amount."},"TransactionDate":{"type":"String","description":"Date and time when the transaction occurred. Format: YYYY-MM-DDTHH:MM:SS."},"TransactionType":{"type":"String","description":"Indicates the type of transaction. Possible values: CashAdvance, CheckConversionOnly, CheckGuaranteeWithConversion, CheckVerificationWithConversion, FoodStampsReturn, N/A, QuasiCash, Refund, Sale, Unknown."},"BaseAmount":{"type":"Number","description":"Base amount of the transaction, excluding any fees or adjustments."},"DDALastFour":{"type":"Number","description":"The last four digits of the merchant's deposit account number that received the transaction funds."},"isConveyed":{"type":"String","description":"Indicates whether the transaction amount was conveyed. Funded externally; example: Amex Direct. Returns Yes or No."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant ACH Returns and Rejects

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantACHReturns":{"get":{"tags":["Report"],"summary":"Get Merchant ACH Returns and Rejects","description":"Retrieve ACH return and reject details grouped by the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantACHReturnsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantACHReturnsResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of ACH return records","items":{"$ref":"#/components/schemas/MerchantACHReturnsContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantACHReturnsContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name."},"ResellerMerchantNumber":{"type":"String","description":"The unique identifier assigned to the reseller."},"ParentBusinessDBA":{"type":"String","description":"DBA name of the parent merchant or business."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"Merchant's legal name registered for tax purposes."},"BusinessDBA":{"type":"String","description":"The merchant's DBA name."},"GW_MerchantId":{"type":"String","description":"The gateway merchant ID assigned to the merchant."},"PayaTerminalID":{"type":"String","description":"The terminal ID associated with the ACH transaction."},"ACHTransactionID":{"type":"String","description":"The unique ACH transaction identifier."},"ACHDisposition":{"type":"String","description":"Indicates the final status of the ACH transaction."},"SecCode":{"type":"String","description":"The Standard Entry Class (SEC) Code for the ACH transaction."},"TransactionType":{"type":"String","description":"The ACH transaction type. Possible values: Debit, Credit."},"Amount":{"type":"String","description":"The ACH transaction amount."},"CheckNumber":{"type":"String","description":"The check number submitted with the transaction."},"LastFourAccountNumber":{"type":"String","description":"The last four digits of the customer's bank account number."},"CreateDateTimeUTC":{"type":"String","description":"The UTC timestamp when the ACH transaction was created. Format: YYYY-MM-DDTHH:MM:SS.sssZ."},"ReturnCode":{"type":"String","description":"The ACH return code associated with the transaction."},"ReturnMessage":{"type":"String","description":"The return message that describes the reason for the ACH return."},"Company":{"type":"String","description":"The customer's company name."},"FirstName":{"type":"String","description":"The customer's first name."},"LastName":{"type":"String","description":"The customer's last name or surname."},"Street1":{"type":"String","description":"The first line of the customer's billing address."},"Street2":{"type":"String","description":"The second line of the customer's billing address."},"Phone":{"type":"String","description":"The customer's phone number."},"City":{"type":"String","description":"The customer's city name."},"State":{"type":"String","description":"The customer's state name."},"PostalCode":{"type":"String","description":"The customer's postal or ZIP Code."},"SourceSystemCustomerID":{"type":"String","description":"Unique customer identifier from the originating system."},"SourceSystemOrderID":{"type":"String","description":"Unique order identifier from the originating system."},"PurchaseOrder":{"type":"String","description":"Purchase order number referenced in the transaction."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Application

> Retrieve the application details and status of the specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantApplication":{"get":{"tags":["Report"],"summary":"Get Merchant Application","description":"Retrieve the application details and status of the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filter the results by the start date when the merchant was submitted, application status, or boarded. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filter the results by the end date when the merchant was submitted, application status, or boarded. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantApplicationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantApplicationResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains detailed information about each merchant application.","items":{"$ref":"#/components/schemas/MerchantApplicationContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantApplicationContent":{"type":"object","properties":{"AnnualVolume":{"type":"Number","description":"The merchant's estimated annual processing volume."},"ApplicationStatusDate":{"type":"String","description":"The date and time when the application status was last updated. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS)."},"ApplicationStatus":{"type":"String","description":"Indicates the status of the merchant's application. Example: Submitted, Pending, Terminal Setup, Cancelled."},"BankIDNumber":{"type":"String","description":"Unique identification number of the acquiring bank."},"BoardedStatusDate":{"type":"String","description":"Date and time when the merchant's boarded and can begin processing. Format: ISO 8601."},"BoardedStatus":{"type":"String","description":"The merchant's current boarding status, if the merchant is already onboarded. Example: Open, Closed, Suspended."},"ExternalCustomerID":{"type":"String","description":"Unique merchant's customer identifier."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantEmailAddress":{"type":"String","description":"Primary email address associated with the merchant."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantPhysicalAddressLine1":{"type":"String","description":"The first line of the merchant's physical address."},"MerchantPhysicalAddressLine2":{"type":"String","description":"The second line of the merchant's physical address, if applicable."},"MerchantPhysicalCity":{"type":"String","description":"The merchant's physical business city name."},"MerchantPhysicalStateOrProvince":{"type":"String","description":"The merchant's physical state name or province."},"MerchantPhysicalPostalCode":{"type":"String","description":"The merchant's physical postal or ZIP code."},"MerchantPrincipal1FirstName":{"type":"String","description":"First name of the primary merchant owner."},"MerchantPrincipal1LastName":{"type":"String","description":"Last name of the primary merchant owner."},"MerchantPrincipal1Percentage":{"type":"Number","description":"Ownership percentage held by the primary merchant owner."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"SponsorBankDesc":{"type":"String","description":"The name or description of the sponsor bank."},"MerchantTaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"Website":{"type":"String","description":"The merchant's business website URL."},"ApplicationSubmittedDate":{"type":"String","description":"Date when the merchant application was first created or submitted. Format: YYYY-MM-DDTHH:mm:ss.SSS."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Attestation Status

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantAttestation":{"get":{"tags":["Report"],"summary":"Get Attestation Status","description":"Retrieve the attestation status and related compliance details for the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantAttestationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantAttestationResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant attestation records.","items":{"$ref":"#/components/schemas/MerchantAttestationContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantAttestationContent":{"type":"object","properties":{"AccountExecutiveName":{"type":"String","description":"Name of the account executive assigned to the merchant."},"AttestationType":{"type":"String","description":"Type of the attestation assigned to the merchant."},"AttestationStatus":{"type":"String","description":"Current attestation status of the merchant."},"AttestationCompleteDate":{"type":"String","description":"Date and time when the merchant completed the attestation."},"AttestationExpirationDate":{"type":"String","description":"Date when the attestation expires."},"BoardingDate":{"type":"String","description":"Date when the merchant was boarded to the platform. Format: YYYY-MM-DDTHH:MM:SS."},"BusinessPhoneNumber":{"type":"String","description":"The merchant's primary business phone number."},"BusinessStatusName":{"type":"String","description":"The current business status. Example: Open, Closed, Suspended."},"EmailAddress":{"type":"String","description":"The merchant's primary business email address."},"IsSeasonal":{"type":"String","description":"Indicates whether the merchant operates seasonally."},"LastDepositDate":{"type":"String","description":"The most recent date a deposit was made to the merchant's account. Format: YYYY-MM-DDTHH:MM:SS."},"LastStatusChangeDateTime":{"type":"String","description":"The date and time when the merchant's status was last updated. Format: YYYY-MM-DDThh:mm:ss.sssZ."},"BusinessID":{"type":"Integer","description":"Unique business identifier associated with the merchant."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"Principal1FirstName":{"type":"String","description":"The first name of the merchant's primary principal."},"Principal1LastName":{"type":"String","description":"The last name of the merchant's primary principal."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"SeasonalMonths":{"type":"String","description":"The months during which the merchant operates if they are seasonal."},"TaxPayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"MasterTemplateId":{"type":"Integer","description":"Unique identifier for the pricing or configuration template assigned to the merchant."},"MasterTemplateName":{"type":"String","description":"Name of the pricing or configuration template assigned to the merchant."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Attrition

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantAttrition":{"get":{"tags":["Report"],"summary":"Get Merchant Attrition","description":"Retrieve the inactive merchant details including key dates of their most recent activity.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filters results by the start date when first deposit settled. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filters results by the end date when last deposit settled. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantAttritionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantAttritionResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant attrition records.","items":{"$ref":"#/components/schemas/MerchantAttritionContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantAttritionContent":{"type":"object","properties":{"BusinessDimKey":{"type":"Integer","description":"A unique business identifier associated with the merchant."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantTaxpayerLegalname":{"type":"String","description":"The legal business name used for tax reporting."},"MerchantStatusName":{"type":"String","description":"The merchant's current status. Possible values: Suspended."},"ExternalCustomerID":{"type":"String","description":"External identifier assigned to the merchant."},"MerchantBoardedDateTime":{"type":"String","description":"Date and time when the merchant was boarded."},"FirstDepositDate":{"type":"String","description":"Date when the merchant received its first deposit. Format: YYYY-MM-DDTHH:MM:SS."},"LatestDepositDate":{"type":"String","description":"The most recent deposit date for the merchant. Format: YYYY-MM-DDTHH:MM:SS."},"CancellationDate":{"type":"String","description":"Date when the merchant was canceled. Format: YYYY-MM-DDTHH:MM:SS."},"DaysOnGateway":{"type":"String","description":"Total number of days the merchant has been active on the gateway."},"BankIDNumber":{"type":"String","description":"Unique identifier of the merchant's sponsoring bank."},"CurrentSalesChannelDescription":{"type":"String","description":"Description of the sales channel associated with the merchant (such as ISO)."},"MCC":{"type":"String","description":"The Merchant Category Code (MCC) assigned to the merchant."},"MCCDescription":{"type":"String","description":"Description of the Merchant Category Code."},"SalesActivationDate":{"type":"String","description":"Date when the merchant's sales were activated. Format: YYYY-MM-DDTHH:MM:SS."},"DaysLastTransactionToSuspend":{"type":"Integer","description":"The number of days between the merchant's last transaction and the date the account was suspended."},"ClosedMonthVolume":{"type":"Number","description":"Total processed volume for the closed month of merchant."},"LastTransactionDate":{"type":"String","description":"Date of the merchant's most recent transaction. Format: YYYY-MM-DDTHH:MM:SS."},"PriorYearClosedMonthVolume":{"type":"Number","description":"Merchant's processed volume for the same month in the prior year."},"Prior12MonthsVolume":{"type":"Number","description":"The merchant's total processed volume over the past 12 months."},"Reason":{"type":"String","description":"Reason associated with the merchant's attrition."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Billing

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantBilling":{"get":{"tags":["Report"],"summary":"Get Merchant Billing","description":"Retrieve the billing activity and information grouped by month for a specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantBillingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantBillingResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of merchant billing records.","items":{"$ref":"#/components/schemas/MerchantBillingContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantBillingContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"BankIDNumber":{"type":"String","description":"Unique identifier of the merchant's sponsoring bank."},"ExternalCustomerID":{"type":"String","description":"External identifier assigned to the merchant."},"PhysicalAddress":{"type":"String","description":"Merchant's physical business address."},"BillingCycleRange":{"type":"String","description":"Date range for the billing cycle. Format MM/DD/YYYY – MM/DD/YYYY."},"Association":{"type":"String","description":"The type of billing category or fee group applied."},"FeeDescription":{"type":"String","description":"A description of the fee assessed during the billing cycle."},"Items":{"type":"Integer","description":"The number of fee items included in the billing calculation."},"Volume":{"type":"Number","description":"The transaction volume associated with the fee."},"Rate":{"type":"Number","description":"Rate used to calculate the fee."},"ItemFee":{"type":"Number","description":"Fee amount applied per item."},"Fees":{"type":"Number","description":"The total fees billed for the item."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Equipment Records

> Retrieve the equipment details associated with the specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantEquipment":{"get":{"tags":["Report"],"summary":"Get Merchant Equipment Records","description":"Retrieve the equipment details associated with the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filter the results by the start date based on the equipment order creation. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filter the results by the end date based on the equipment order creation. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantEquipmentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantEquipmentResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of merchant equipment records.","items":{"$ref":"#/components/schemas/MerchantEquipmentContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantEquipmentContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxPayerLegalName":{"type":"String","description":"Merchant's legal name registered for tax purposes."},"BoardedDateTime":{"type":"String","description":"The date and time when the merchant was boarded. Format: YYYY-MM-DDTHH:MM:SS."},"OrderDate":{"type":"String","description":"The date when the equipment order was ordered. Format: YYYY-MM-DDTHH:MM:SS."},"OrderStatus":{"type":"String","description":"The current status of the equipment order. Possible values: "},"TerminalID":{"type":"String","description":"Unique identifier assigned to the equipment terminal."},"Quantity":{"type":"Integer","description":"The number of equipment units in the order."},"ModelName":{"type":"String","description":"Model name of the equipment assigned to the merchant."},"Street":{"type":"String","nullable":true,"description":"First line of the equipment shipping address."},"Street2":{"type":"String","nullable":true,"description":"Second line of the equipment shipping address, if applicable."},"City":{"type":"String","nullable":true,"description":"City name associated with the shipping address."},"StateName":{"type":"String","nullable":true,"description":"State associated with the shipping address."},"Zip":{"type":"String","nullable":true,"description":"The ZIP or postal code for the shipping address."},"TrackingNumber":{"type":"String","description":"Unique shipment tracking number associated with the order."},"SerialNumber":{"type":"String","nullable":true,"description":"Serial number of the equipment."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Funding Activity

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/FundingActivity":{"get":{"tags":["Report"],"summary":"Get Merchant Funding Activity","description":"Retrieve the funding activity details for the specified merchant, including batch numbers, settlement dates, transaction activity, and amounts.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filters results by the start date when first deposit settled. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filters results by the end date when last deposit settled. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingActivityResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"FundingActivityResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains details of consolidated funding transactions.","items":{"$ref":"#/components/schemas/FundingActivityResponseContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"FundingActivityResponseContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"Doing Business As (DBA) name of the reseller associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"Unique merchant number assigned to the reseller."},"ParentBusinessDBA":{"type":"String","description":"DBA name of the parent organization in the reseller hierarchy."},"ParentMerchantNumber":{"type":"String","description":"Unique merchant number of the parent organization."},"BusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantTaxpayerLegalName":{"type":"String","description":"The merchant's legal business name used for tax reporting."},"SettlementMethod":{"type":"String","description":"The funding method used to settle the batch. Possible values: Daily."},"IsEMF":{"type":"String","description":"Indicates whether Enhanced Merchant Funding (EMF) is enabled for the merchant."},"FundingRequestID":{"type":"Integer","description":"Unique identifier of the funding request."},"BatchNumber":{"type":"String","description":"The batch number that groups the merchant's transactions."},"TerminalNumber":{"type":"String","description":"Unique terminal identifier that processed the batch."},"BatchAmount":{"type":"Number","description":"The total amount of the batch."},"DailyFeeAmount":{"type":"Number","description":"The total amount of daily fees applied to the batch."},"SettlementDate":{"type":"String","format":"date-time","description":"The date when the batch was settled. Format: YYYY-MM-DDThh:mm:ss."},"ExpectedFundingDate":{"type":"String","format":"date-time","description":"The date when the deposit is expected to be funded to the merchant's bank account. Format: YYYY-MM-DDThh:mm:ss."},"FundingEventTypeName":{"type":"String","description":"The type of funding event."},"Amount":{"type":"Number","description":"The net amount deposited to the merchant after fees and adjustments."},"AccountNumberMasked":{"type":"String","description":"The masked bank account number used for funding."},"NachaFileName":{"type":"String","description":"NACHA file name associated with the funding transaction."},"BankIDNumber":{"type":"String","description":"Unique bank identification number associated with the transaction."},"CreationDayOfWeek":{"type":"String","format":"date-time","description":"Creation date of the funding record."},"FundingType":{"type":"String","description":"Funding type assigned to the merchant."},"FRDateTime":{"type":"String","format":"date-time","description":"The date and time when the funding request was created. Format: YYYY-MM-DDThh:mm:ss.SS."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Interchange Qualification

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/InterchangeQualification":{"get":{"tags":["Report"],"summary":"Get Merchant Interchange Qualification","description":"Retrieve the interchange and qualification details grouped by the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filters results by the date when the first settlement occurred. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filters results by the date when the last settlement occurred. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterchangeQualificationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"InterchangeQualificationResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the interchange qualification records for the merchant.","items":{"$ref":"#/components/schemas/InterchangeQualificationContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"InterchangeQualificationContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantBusinessDBA":{"type":"String","description":"Merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TerminalNumber":{"type":"String","description":"Identifier of the terminal used to process the transaction."},"MerchantMCC":{"type":"String","description":"Merchant's MCC (Merchant Category Code) associated with the business type."},"ReportStartDate":{"type":"String","description":"Start date used to filter the report results. Format: YYYY-MM-DD."},"ReportEndDate":{"type":"String","description":"End date used to filter the report results. Format: YYYY-MM-DD."},"AuthorizationDateTime":{"type":"String","description":"Date and time when the transaction was authorized. Format: YYYY-MM-DDTHH:MM:SS."},"SettlementDateDimKey":{"type":"String","description":"Date when the transaction was settled. Format: YYYY-MM-DDTHH:MM:SS."},"OLSGatewayTranLogID":{"type":"Number","description":"Unique transaction identifier from the gateway transaction log."},"AuthorizationAmount":{"type":"Number","description":"The amount requested during authorization."},"TransactionAmount":{"type":"Number","description":"The final settled amount for the transaction."},"InterchangeAmount":{"type":"Number","description":"Interchange fee amount applied to the transaction."},"TransactionDateDimKey":{"type":"String","description":"Date when the transaction occurred. Format: YYYY-MM-DDTHH:MM:SS."},"CardNetworkCategory":{"type":"String","description":"The card brand used for the transaction."},"QualificationLevelDescription":{"type":"String","description":"Interchange qualification level applied to the transaction."},"InterchangeRate":{"type":"Number","description":"Interchange rate applied to the transaction."},"InterchangeFee":{"type":"Number","description":"Interchange fee charged for the transaction."},"PosEntryModeCode":{"type":"String","description":"The POS entry mode code indicating how the card was captured."},"PosEntryModeDescription":{"type":"String","description":"Description of the POS entry mode."},"CardPresent":{"type":"Boolean","description":"Indicates whether the card was physically present during the transaction."},"RejectReasons":{"type":"String","description":"A list of reasons the transaction was rejected."},"CardTransactionID":{"type":"Number","description":"The unique card transaction identifier assigned by the card processor."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Disputes Lifecycle

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/DisputesLifecycle":{"get":{"tags":["Report"],"summary":"Get Disputes Lifecycle","description":"Retrieve the disputes lifecycle report within the specified date range of the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filters results by the start date when disputes received. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filters results by the end date when disputes received. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputesLifecycleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"DisputesLifecycleResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains dispute lifecycle records for the merchant.","items":{"$ref":"#/components/schemas/DisputesLifecycleContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"DisputesLifecycleContent":{"type":"object","properties":{"ResellerHNK":{"type":"String","description":"Hierarchy node key (HNK) for the reseller associated with the merchant."},"ResellerDBA":{"type":"String","description":"Doing Business As (DBA) name of the reseller."},"ParentHNK":{"type":"String","description":"HNK of the parent organization in the hierarchy."},"ParentDBA":{"type":"String","description":"DBA name of the parent organization."},"MID":{"type":"String","description":"The merchant's unique identification number."},"MIDLegalName":{"type":"String","description":"The legal business name of the merchant."},"MIDDBA":{"type":"String","description":"The DBA name of the merchant."},"CaseFamilyID":{"type":"String","description":"A unique identifier that groups related dispute cases into a family."},"CaseNumber":{"type":"Number","description":"A unique dispute case number assigned by the card processor."},"CaseType":{"type":"String","description":"The dispute case type. Example: New Activity, Pending, or Rejected."},"Reason":{"type":"String","description":"A description reason provided for the dispute."},"CaseStatus":{"type":"String","description":"The current status of the dispute case. Example: Settled."},"CardNumberMasked":{"type":"String","description":"Masked payment card number associated with the transaction."},"CardType":{"type":"String","description":"The card brand used for the transaction. Possible values: Visa."},"TransactionType":{"type":"String","description":"The type of transaction involved in the dispute."},"OriginalTrxnFundsFlow":{"type":"String","description":"Indicates the original funds flow for the transaction."},"OriginalReferenceNumber":{"type":"String","description":"The original reference number provided by the card network."},"ReferenceNumber":{"type":"String","description":"The acquiring reference number associated with the disputed transaction."},"TransactionDate":{"type":"String","format":"date-time","description":"The date the original transaction occurred. Format: YYYY-MM-DDTHH:MM:SS."},"TransactionAmount":{"type":"Number","description":"The amount of the original transaction."},"DisputeDate":{"type":"String","format":"date-time","description":"Date when the dispute was initiated. Format: YYYY-MM-DDTHH:MM:SS."},"DisputeAmount":{"type":"Number","description":"The disputed amount."},"MerchantAmount":{"type":"Number","description":"Amount assigned to the merchant for the dispute case."},"RespondBy":{"type":"String","format":"date-time","description":"Date by which the merchant must respond to the dispute case. Format: YYYY-MM-DDTHH:MM:SS."},"ResponseDate":{"type":"String","format":"date-time","description":"The date when merchant responded to the dispute case. Format: YYYY-MM-DDTHH:MM:SS."},"ResolvedDate":{"type":"String","format":"date-time","description":"The date when dispute was resolved. Format: YYYY-MM-DDTHH:MM:SS."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Support Ticket Activity

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/SupportTicketActivity":{"get":{"tags":["Report"],"summary":"Get Merchant Support Ticket Activity","description":"Retrieve the portfolio-level details of support ticket activity for the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filters result by the start date when the last case was modified. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filters result by the end date of the most recent case modification. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketActivityResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"SupportTicketActivityResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant case records.","items":{"$ref":"#/components/schemas/SupportTicketActivityContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"SupportTicketActivityContent":{"type":"object","properties":{"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"MerchantBusinessDBA":{"type":"String","description":"Merchant's Doing Business As (DBA) name."},"CaseNumber":{"type":"String","description":"Unique identification number assigned to the case."},"CaseOrigin":{"type":"String","description":"The communication channel through which the case was created."},"CreatedDate":{"type":"String","description":"Date and time when the case was created. Format: YYYY-MM-DDTHH:MM:SS."},"FirstResponseDateTime":{"type":"String","description":"Date and time when the first response was provided for the case. Format: YYYY-MM-DDTHH:MM:SS."},"LastModifyDateTime":{"type":"String","description":"Date and time when the case was last updated. Format: YYYY-MM-DDTHH:MM:SS."},"ClosedDate":{"type":"String","description":"Date and time when the case was closed. Format: YYYY-MM-DDTHH:MM:SS."},"Reason":{"type":"String","description":"A brief description of the issue or reason for the case."},"Description":{"type":"String","description":"Detailed information or message content provided in the case."},"ExternalCaseStatus":{"type":"String","description":"Current case status shown to external users."},"SubmittedBy":{"type":"String","description":"Name of the person who submitted the case."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Chargebacks

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantChargebacks":{"get":{"tags":["Report"],"summary":"Get Merchant Chargebacks","description":"Retrieve the chargeback details with reason codes and dates of the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filter the results by date when the last chargeback was settled in Xplor Pay system. Default to the current date. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantChargebacksResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantChargebacksResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of merchant records.","items":{"$ref":"#/components/schemas/MerchantChargebacksContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantChargebacksContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantLegalname":{"type":"String","description":"The merchant's legal business name."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"ProcessingDateTime":{"type":"String","description":"The date and time when the dispute was processed. Format: YYYY-MM-DDTHH:mm:ss."},"TransactionAmount":{"type":"Number","description":"The amount of the original transaction."},"DisputeType":{"type":"String","description":"Type of the dispute classification."},"ReasonCodeDescription":{"type":"String","description":"The description of the dispute reason code associated with the case."},"DispositionStatus":{"type":"String","description":"The current status of the dispute."},"DispositionStatusDate":{"type":"String","description":"Date and time when the disposition status was last updated. Format: YYYY-MM-DDTHH:mm:ss."},"CardNumberMasked":{"type":"String","description":"The masked card number associated with the original transaction."},"ProcessorName":{"type":"String","description":"The card network handling the transaction."},"QuestTransactionID":{"type":"String","description":"The unique identifier for the transaction from the Quest system."},"TransactionDateTime":{"type":"String","description":"Date and time of the original transaction. Format: YYYY-MM-DDTHH:mm:ss."},"OriginalTransactionSettlementDate":{"type":"String","description":"The settlement date of the original transaction. Format: YYYY-MM-DDTHH:mm:ss."},"SettlementDate":{"type":"String","description":"Date when the dispute was settled. Format: YYYY-MM-DDTHH:mm:ss."},"OriginalTranRefNo":{"type":"String","description":"The reference number of the original transaction."},"PendingSettlementDate":{"type":"String","description":"The pending settlement date of the original transaction. Format: YYYY-MM-DDTHH:mm:ss."},"ResolvedDate":{"type":"String","description":"Date when the dispute was resolved. Format: YYYY-MM-DDTHH:mm:ss."},"BillingAdjustmentDate":{"type":"String","description":"Date when the billing adjustment was applied for the dispute."},"SettlementAmount":{"type":"Number","description":"The amount settled for the dispute."},"SourceProcessingDateTime":{"type":"String","description":"Processing date and time provided by the source system. Format: YYYY-MM-DDTHH:mm:ss."},"BillingAdjustmentAmount":{"type":"Number","description":"The amount of the billing adjustment."},"BillingAdjustmentDescription":{"type":"String","description":"Description of the billing adjustment."},"TotalAmount":{"type":"Number","description":"Total amount calculated for the dispute."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Information

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantInformation":{"get":{"tags":["Report"],"summary":"Get Merchant Information","description":"Retrieve the general information of the specified merchant, including ACH, CBD, and PCI status details.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantInformationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantInformationResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant attrition records.","items":{"$ref":"#/components/schemas/MerchantInformationContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantInformationContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantTaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"ExternalCustomerID":{"type":"String","nullable":true,"description":"External identifier assigned to the merchant."},"IsACHEnabled":{"type":"String","description":"Indicates whether the merchant is enabled for ACH (Automated Clearing House) processing."},"IsSellsCBD":{"type":"String","description":"Indicates whether the merchant sells CBD products."},"CBDAnnualRevenuePercentage":{"type":"Number","nullable":true,"description":"The percentage of the merchant's annual revenue generated from CBD products."},"CBDProductInventoryPercentage":{"type":"Number","nullable":true,"description":"The percentage of the merchant's inventory consisting of CBD products."},"CBDIncorporatedDate":{"type":"String","nullable":true,"description":"Date of the merchant's CBD business was incorporated."},"CBDCategoryDescription":{"type":"String","nullable":true,"description":"Description of the CBD category the merchant operates in."},"IsMerchantCompliant":{"type":"String","description":"Indicates whether the merchant meets compliance requirements."},"MerchantBoardedDate":{"type":"String","description":"Date when the merchant was boarded into the payments platform."},"MerchantBankIDNumber":{"type":"String","description":"Merchant's assigned bank identification number (BIN)."},"MerchantIncorporationTypeDescription":{"type":"String","description":"The merchant's legal business structure."},"IsMerchantNextDayFundingEnabled":{"type":"String","description":"Indicates whether the merchant is eligible for next-day funding."},"MerchantSettlementMethodName":{"type":"String","description":"The merchant's settlement method."},"MerchantAmexSENumber":{"type":"String","nullable":true,"description":"The merchant's American Express SE number."},"MerchantAmexMID":{"type":"String","nullable":true,"description":"American Express MID (Merchant ID) assigned to the merchant."},"MerchantDiscoverMID":{"type":"String","description":"Discover network MID assigned to the merchant."},"MerchantStatusDescription":{"type":"String","description":"The merchant's current status description in the system."},"MerchantComplianceStatusDescription":{"type":"String","description":"Merchant's compliance status, including any required actions."},"MerchantSAQTypeCode":{"type":"String","description":"Self-Assessment Questionnaire (SAQ) type selected by the merchant."},"MerchantLastSAQPassDate":{"type":"String","nullable":true,"description":"Date when the merchant last passed their SAQ assessment."},"MerchantSAQExpirationDate":{"type":"String","nullable":true,"description":"Expiration date of the merchant's current SAQ certification."},"MerchantEmailAddress":{"type":"String","description":"The merchant's primary email address."},"MerchantBusinessPhoneNumberFull":{"type":"String","description":"Merchant's primary business phone number."},"MerchantTINStatusDescription":{"type":"String","description":"Validation status of the merchant's Tax Identification Number (TIN)."},"MerchantMailingAddressLine1":{"type":"String","description":"First line of the merchant's mailing address."},"MerchantMailingAddressLine2":{"type":"String","nullable":true,"description":"Second line of the merchant's mailing address."},"MerchantMailingCity":{"type":"String","description":"City name of the merchant's mailing address."},"MerchantMailingPostalCode":{"type":"String","description":"Postal or ZIP code of the merchant's mailing address."},"MerchantMailingStateProvince":{"type":"String","description":"State or province of the merchant's mailing address."},"MerchantMCCDescription":{"type":"String","description":"The merchant category code (MCC) description defining the business type."},"MerchantPhysicalAddressLine1":{"type":"String","description":"First line of the merchant's physical address."},"MerchantPhysicalAddressLine2":{"type":"String","description":"Second line of the merchant's physical address, if available."},"MerchantPhysicalCity":{"type":"String","description":"City of the merchant's physical location."},"MerchantPhysicalPostalCode":{"type":"String","description":"Postal or ZIP code of the merchant's physical location."},"MerchantPhysicalStateOrProvince":{"type":"String","description":"State or province of the merchant's physical location."},"MerchantPrincipal1FirstName":{"type":"String","description":"First name of the merchant's primary principal."},"MerchantPrincipal1LastName":{"type":"String","description":"Last name of the merchant's primary principal."},"MerchantPrincipal1Percentage":{"type":"Number","description":"Ownership percentage of the primary principal."},"MerchantPrincipal2FirstName":{"type":"String","nullable":true,"description":"First name of the merchant's second principal, if applicable."},"MerchantPrincipal2LastName":{"type":"String","nullable":true,"description":"The last name of the merchant's second principal."},"MerchantPrincipal2Percentage":{"type":"Number","nullable":true,"description":"Ownership percentage of the second principal."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Users

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantUser":{"get":{"tags":["Report"],"summary":"Get Merchant Users","description":"Retrieve the user role, status, activity, and contact information for the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantUserResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantUserResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list users' information.","items":{"$ref":"#/components/schemas/MerchantUserContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantUserContent":{"type":"object","properties":{"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"BusinessID":{"type":"Integer","description":"The business's internal system identifier."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"BusinessStatusName":{"type":"String","description":"Displays the current status of the merchant's business."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"UserName":{"type":"String","description":"Username associated with the merchant user account."},"UserStatus":{"type":"String","description":"Current status of the user account. Example: Active, Locked."},"UserFirstName":{"type":"String","description":"The user's first name."},"UserLastName":{"type":"String","description":"The user's last name."},"UserEmail":{"type":"String","description":"Email address associated with the user account."},"CompassLastLogin":{"type":"String","description":"Date and time when the user last logged in to Compass."},"LastLogin":{"type":"String","description":"Date and time when the user last logged in to the portal."},"Roles":{"type":"String","description":"A list of roles assigned to the user. Example: Compass Merchant, MerchantAdmin, MerchantHomeUser, VirtualTerminalUser, VTAccountAnalysts."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Monthly Residual Details

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantMonthlyResiduals":{"get":{"tags":["Report"],"summary":"Get Monthly Residual Details","description":"Retrieve the portfolio residual details of the specified merchant, including billed volume, fees, income, and settlement details.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonthlyResidualsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MonthlyResidualsResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of merchant residual records.","items":{"$ref":"#/components/schemas/MonthlyResidualsContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MonthlyResidualsContent":{"type":"object","properties":{"ActualSplitPercent":{"type":"Number","description":"Percentage of the residual amount allocated to the reseller or partner."},"AdditionalDetail":{"type":"String","description":"Additional notes or supplemental information related to the residual entry."},"AmountBilled":{"type":"Number","description":"Total residual amount billed for the merchant for the corresponding month."},"AuthsBilled":{"type":"Integer","description":"Number of authorizations included in the billed transaction count."},"BillingFee":{"type":"Number","description":"Total billing fee applied to the merchant for the period."},"BillingRate":{"type":"Number","description":"Rate applied when calculating the billing fee."},"BoardedDateTime":{"type":"String","description":"Date and time when the merchant was originally boarded into the system (YYYY-MM-DDTHH:MM:SS)."},"CardNetworkDescription":{"type":"String","description":"Card network associated with the residual record. Possible values: Visa, Mastercard."},"ExternalCustomerID":{"type":"String","nullable":true,"description":"The merchant's external customer identifier."},"Income":{"type":"Number","description":"Net income generated from the merchant's transactions for the period."},"MCC":{"type":"String","description":"Merchant's category code (MCC) that defines the type of business."},"MCCDescription":{"type":"String","description":"Description of the merchant category code."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"PricingPlanTypeName":{"type":"String","description":"The pricing plan type assigned to the merchant."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ResidualDispositionGroup":{"type":"String","description":"The category under which the residual income is classified."},"ResidualFeeDescription":{"type":"String","description":"Description of the residual fee or revenue type applied."},"SettlementYearMonthName":{"type":"String","description":"Year and month of the settlement period. Format: YYYY-MM."},"SortOrder":{"type":"Integer","description":"Sorting sequence number for ordering residual records."},"TaxPayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"TransactionsBilled":{"type":"Integer","description":"Total number of transactions included in billing calculations."},"VolumeBilled":{"type":"Number","description":"Total transaction volume billed for the merchant during the period."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant PCI Status

> Retrieve the current PCI compliance status for the specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantPCIStatus":{"get":{"tags":["Report"],"summary":"Get Merchant PCI Status","description":"Retrieve the current PCI compliance status for the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPCIStatusResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantPCIStatusResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant PCI status records.","items":{"$ref":"#/components/schemas/MerchantPCIStatusContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantPCIStatusContent":{"type":"object","description":"Contains a list of merchant PCI status records.","properties":{"AccountExecutiveName":{"type":"String","description":"Name of the account executive assigned to the merchant."},"BoardingDate":{"type":"String","description":"Indicates the date when the merchant was initially boarded. Format: YYYY-MM-DDTHH:MM:SS."},"BusinessID":{"type":"Integer","description":"Internal business identifier associated with the merchant."},"BusinessPhoneNumber":{"type":"String","description":"Merchant's primary business phone number."},"BusinessStatusName":{"type":"String","description":"Indicates the current business status of the merchant. Example: Open, Suspended."},"EmailAddress":{"type":"String","description":"The merchant's primary email address."},"ExpirationDate":{"type":"String","description":"Date when PCI attestation or compliance status expires."},"IsMerchantCompliant":{"type":"String","description":"Indicates whether the merchant is PCI-compliant."},"IsSeasonal":{"type":"String","description":"Indicates whether the merchant operates seasonally."},"LatestDepositDate":{"type":"String","description":"Date of the most recent deposit for the merchant."},"LastPassedDate":{"type":"String","description":"Date when the merchant last passed PCI scanning requirements."},"LastSAQDate":{"type":"String","description":"Indicates the date when the merchant last completed the SAQ."},"LastScanDate":{"type":"String","description":"Date of the merchant's most recent PCI scan."},"LastValidationDate":{"type":"String","description":"Date of the most recent PCI validation review."},"MailingAddressLine1":{"type":"String","description":"First line of the merchant's mailing address."},"MailingAddressLine2":{"type":"String","description":"Second line of the merchant's mailing address."},"MailingCity":{"type":"String","description":"Specifies the merchant's mailing city."},"MailingStateProvince":{"type":"String","description":"The merchant's mailing state or province."},"MailingPostalCode":{"type":"String","description":"Postal code for the merchant's mailing address."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"PCIComplianceStatusDescription":{"type":"String","description":"Describes the merchant's PCI compliance status in detail."},"Principal1FirstName":{"type":"String","description":"First name of the primary principal or owner."},"Principal1LastName":{"type":"String","description":"Last name of the primary principal or owner."},"LastStatusChangeDateTime":{"type":"String","description":"Indicates the date and time when the merchant's status last changed. Format: YYYY-MM-DDTHH:MM:SS.sss."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"SAQStatus":{"type":"String","description":"Indicates the current SAQ status for the merchant."},"SAQType":{"type":"String","description":"Specifies the SAQ type assigned to the merchant."},"ScanStatus":{"type":"String","description":"Indicates the current PCI scan status for the merchant."},"SeasonalMonths":{"type":"String","description":"The months during which the merchant operates if seasonal."},"TaxpayerLegalname":{"type":"String","description":"The legal business name used for tax reporting."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Portfolio Report

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/Portfolio":{"get":{"tags":["Report"],"summary":"Get Portfolio Report","description":"Retrieve the key information and activity within a portfolio of the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"PortfolioResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of portfolio records.","items":{"$ref":"#/components/schemas/PortfolioContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"PortfolioContent":{"type":"object","description":"Contains a list of portfolio records.","properties":{"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"PhysicalAddress1":{"type":"String","description":"Merchant's physical address line 1."},"PhysicalAddress2":{"type":"String","description":"Merchant's physical address line 2."},"PhysicalCity":{"type":"String","description":"Merchant's physical city name."},"PhysicalStateProvince":{"type":"String","description":"Merchant's physical state or province."},"PhysicalPostalCode":{"type":"String","description":"Merchant's physical ZIP or postal code."},"MailingAddress1":{"type":"String","description":"Merchant's primary mailing address line 1."},"MailingAddress2":{"type":"String","description":"Merchant's mailing address line 2."},"MailingCity":{"type":"String","description":"The merchant's mailing city."},"MailingStateProvince":{"type":"String","description":"Merchant's mailing state or province."},"MailingPostalCode":{"type":"String","description":"Merchant's mailing ZIP or postal code."},"BusinessEmailAddress":{"type":"String","description":"The merchant's primary contact email address."},"Principal1FirstName":{"type":"String","description":"First name of the merchant's primary principal."},"Principal1LastName":{"type":"String","description":"Last name of the merchant's primary principal."},"PrincipalHomePhoneNumber":{"type":"String","description":"Home phone number of the merchant's primary principal."},"PrimaryContactEmailAddress":{"type":"String","description":"The merchant's primary contact email address."},"BusinessStatusName":{"type":"String","description":"Current business status assigned to the merchant. Possible values: Active, Suspended."},"LastStatusChangeDateTime":{"type":"String","description":"Date and time of the merchant's last status change."},"BoardedDatetime":{"type":"String","description":"Date and time when the merchant account was boarded."},"FirstDepositDate":{"type":"String","description":"Date when the merchant received their first deposit."},"LatestDepositDate":{"type":"String","description":"Date of the most recent deposit issued to the merchant."},"AccountNumberLastFour":{"type":"String","description":"Last four digits of the merchant's bank account number."},"MCC":{"type":"String","description":"Merchant Category Code (MCC) associated with the merchant."},"BankRoutingNumberDeposits":{"type":"String","description":"Bank routing number where deposits are credited."},"BankRoutingNumberMonthlyFees":{"type":"String","description":"Bank routing number used to debit monthly fees."},"BankRoutingNumberDailyFees":{"type":"String","description":"Bank routing number used to debit daily fees."},"BankRoutingNumberAdjustments":{"type":"String","description":"Bank routing number used for adjustment transactions."},"TINLastFour":{"type":"String","description":"last four digits of the merchant's tax identification number (TIN)."},"IsSeasonal":{"type":"String","description":"Indicates whether the merchant operates seasonally. Values: Yes, No."},"SeasonalMonths":{"type":"String","description":"Months during which a seasonal merchant operates."},"ExternalCustomerID":{"type":"String","description":"The external system's customer identifier."},"ACHAverageDebitTransactionYTD":{"type":"Number","description":"Average ACH debit transaction amount year-to-date."},"ACHDebitAmountYTD":{"type":"Number","description":"Total ACH debit amount processed year-to-date."},"ACHDebitCountYTD":{"type":"Integer","description":"Total number of ACH debit transactions processed year-to-date."},"ACHAverageCreditTransactionYTD":{"type":"Number","description":"Average ACH credit transaction amount year-to-date."},"ACHCreditAmountYTD":{"type":"Number","description":"Total ACH credit amount processed year-to-date."},"ACHCreditCountYTD":{"type":"Integer","description":"Total number of ACH credit transactions processed year-to-date."},"AverageTicketTrailingTwelveMonths":{"type":"Number","description":"Average ticket size calculated over the last 12 months."},"CreditCardVolumeYTD":{"type":"Number","description":"Total credit card processing volume year-to-date."},"CreditCardTransactionsYTD":{"type":"Integer","description":"Total number of credit card transactions year-to-date."},"CreditCardAverageTicketYTD":{"type":"Number","description":"Average credit card transaction amount year-to-date."},"TransactionVolumeLastMonth":{"type":"Number","description":"Total processing volume for the prior full month."},"TransactionCountLastMonth":{"type":"Integer","description":"Number of transactions for the prior full month."},"TransactionVolumeMTD":{"type":"Number","description":"Total processing volume for the current month-to-date."},"TransactionCountMTD":{"type":"Integer","description":"Total number of transactions processed for the current month-to-date."},"ChargeBackVolumeYTD":{"type":"Number","description":"Total chargeback volume year-to-date."},"ChargeBackTransactionsYTD":{"type":"Integer","description":"Total number of chargeback transactions year-to-date."},"ChargebackAverageTransactionYTD":{"type":"Number","description":"The average chargeback amount year-to-date."},"ChargebackVolumeLastMonth":{"type":"Number","description":"Total processing volume for the prior full transaction month."},"ChargebackCountLastMonth":{"type":"Integer","description":"Number of chargeback transactions for the most recent month."},"RiskLevelName":{"type":"String","description":"The risk level assigned to the merchant. Possible values: Low, Medium, High."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Pricing

> Retrieve the merchant pricing details based on the specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantPricing":{"get":{"tags":["Report"],"summary":"Get Merchant Pricing","description":"Retrieve the merchant pricing details based on the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPricingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantPricingResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant pricing records.","items":{"$ref":"#/components/schemas/MerchantPricingContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantPricingContent":{"type":"object","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"ExternalCustomerID":{"type":"String","nullable":true,"description":"External identifier assigned to the merchant."},"IsDailySettled":{"type":"Boolean","description":"Indicates whether the merchant settles transactions daily."},"IsEMF":{"type":"Boolean","description":"Indicates whether Express Merchant Funding (EMF) is enabled."},"BoardedDate":{"type":"String","description":"Displays the date when the merchant was boarded. Format: YYYY-MM-DD."},"BusinessStatusName":{"type":"String","description":"Displays the current status of the merchant's business."},"PricingFeeDescription":{"type":"String","description":"Describes the fee applied to the merchant's pricing plan."},"PricingRate":{"type":"Number","description":"Displays the pricing rate as a percentage in two decimal places. Example:1.25%."},"PricingFee":{"type":"Number","description":"Fixed fee amount applied for the pricing item."},"FeePaidInMonth1":{"type":"Number","nullable":true,"description":"Fee paid in the first month of the billing period"},"FeePaidInMonth2":{"type":"Number","nullable":true,"description":"Fee paid in the second month of the billing period, if applicable."},"PayInMonth1":{"type":"Number","nullable":true,"description":"Indicates the amount payable in the first month."},"PayInMonth2":{"type":"Number","nullable":true,"description":"Indicates the amount payable in the second month, if applicable."},"PricingFeeEffectiveDate":{"type":"String","description":"Date when the pricing fee becomes effective. Format: YYYY-MM-DD."},"PricingFeeModifiedDate":{"type":"String","description":"Date and time when the pricing fee was last modified. Format: YYYY-MM-DDTHH:MM:SS.sss."},"PricingPlanType":{"type":"String","description":"Displays the type of pricing plan applied."},"EffectiveStartDateTime":{"type":"String","description":"Start date and time of the pricing plan's validity period. Format: YYYY-MM-DDTHH:MM:SS."},"EffectiveEndDateTime":{"type":"String","description":"End date and time of the pricing plan's validity period. Format: YYYY-MM-DDTHH:MM:SS.sss."},"PricingFeeID":{"type":"Number","description":"Identifies the pricing fee record."},"MasterTemplateName":{"type":"String","description":"Displays the name of the master pricing template associated with the merchant."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Residual Summary

> Retrieve the summary of portfolio residuals of the specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/ResidualSummary":{"get":{"tags":["Report"],"summary":"Get Residual Summary","description":"Retrieve the summary of portfolio residuals of the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"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.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResidualSummaryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"ResidualSummaryResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of residual summary records.","items":{"$ref":"#/components/schemas/ResidualSummaryContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"ResidualSummaryContent":{"type":"object","description":"Contains a list of residual summary records.","properties":{"ResidualMonth":{"type":"String","description":"Month for which the residual summary is calculated. Format: YYYY-MM."},"AuthCount":{"type":"Integer","description":"Total number of authorization transactions for the month."},"AverageTicket":{"type":"Number","description":"Average transaction amount for the month."},"Expense":{"type":"Number","description":"Total processing expenses deducted for the month."},"Interchange":{"type":"Number","description":"Total interchange fees assessed for the month."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantDimKey":{"type":"Integer","description":"Dimension key used for merchant identification in reporting."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"NetRevenue":{"type":"Number","description":"Merchant's net revenue after expenses and interchange fees."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"PassThroughRevenue":{"type":"Number","description":"Total pass-through revenue generated for the month."},"PassThroughExpense":{"type":"Number","description":"Total pass-through expenses deducted for the month."},"PassThroughIncome":{"type":"Number","description":"The total pass-through income."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ResidualIncome":{"type":"Number","description":"Total residual income earned for the reseller for the month."},"ResidualIncomeYTD":{"type":"Number","description":"Year-to-date residual income earned for the reseller."},"Revenue":{"type":"Number","description":"The merchant's total revenue processed for the month."},"NetSalesAmount":{"type":"Number","description":"Total net sales amount processed during the month."},"SplitPercent":{"type":"Number","description":"Revenue split percentage allocated to the reseller."},"TaxPayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"TransactionCount":{"type":"Integer","description":"The total number of transactions processed during the month."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Terminal

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantTerminal":{"get":{"tags":["Report"],"summary":"Get Merchant Terminal","description":"Retrieve the terminal ID and MID details for merchants that have closed one or more batches.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantTerminalResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantTerminalResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of payment terminal records of merchant.","items":{"$ref":"#/components/schemas/MerchantTerminalContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantTerminalContent":{"type":"object","properties":{"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantBusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"ExternalCustomerID":{"type":"String","nullable":true,"description":"External customer identifier assigned to the merchant."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"TaxPayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"TerminalNumber":{"type":"String","description":"Unique identifier assigned to the payment terminal."},"TerminalName":{"type":"String","description":"Descriptive label or configured name for the payment terminal."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Merchant Withholding

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

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/MerchantWithholding":{"get":{"tags":["Report"],"summary":"Get Merchant Withholding","description":"Retrieve the portfolio-level details of backup withholding for the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filter the results by date when the first merchant withholding occurred. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filter the results by date when the last merchant withholding occurred. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"sortColumn","in":"query","required":false,"description":"Specifies the column name used to sort the result set.","schema":{"type":"String"}},{"name":"sortDirection","in":"query","required":false,"description":"Specifies the sorting order for the results. Valid values: ASC (ascending) or DESC (descending).","schema":{"type":"String"}},{"name":"pageNumber","in":"query","required":true,"description":"Specifies the page number of results to return when pagination is applied.","schema":{"type":"Integer"}},{"name":"pageSize","in":"query","required":true,"description":"Specifies the number of results to return per page. Maximum: 10000. Default: 50.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantWithholdingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"MerchantWithholdingResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains the list of merchant withholding records.","items":{"$ref":"#/components/schemas/MerchantWithholdingContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"MerchantWithholdingContent":{"type":"object","description":"Contains a list of withholding records.","properties":{"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"TaxIDLastFour":{"type":"String","description":"Last four digits of the Tax Identification Number (TIN)."},"TotalWithheld":{"type":"Number","description":"Total withheld amount for the merchant during the specified reporting period."},"WithholdingStartDate":{"type":"String","description":"Date when the withholding period began. Format: YYYY-MM-DDTHH:MM:SS."},"WithholdingEndDate":{"type":"String","description":"Date when the withholding period ended or is scheduled to end. Format: YYYY-MM-DDTHH:MM:SS."},"WithholdingStatus":{"type":"String","description":"Current withholding status of the merchant."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Quick Merchant Overview

> Retrieve key merchant processing activity across a portfolio, including batch timelines and monthly performance metrics.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/QuickMerchantOverview":{"get":{"tags":["Report"],"summary":"Get Quick Merchant Overview","description":"Retrieve key merchant processing activity across a portfolio, including batch timelines and monthly performance metrics.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"The merchant's unique identification number.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickMerchantOverviewResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"QuickMerchantOverviewResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant overview records.","items":{"$ref":"#/components/schemas/QuickMerchantOverviewContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"QuickMerchantOverviewContent":{"type":"object","description":"Contains a list of merchant overview records.","properties":{"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"MerchantDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"MerchantTaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"BoardedDate":{"type":"String","description":"Date when the merchant was onboarded."},"FirstBatchDate":{"type":"String","description":"Date when the first batch was processed."},"LastBatchDate":{"type":"String","description":"Date of the most recent or last processed batch."},"VolumeMTD":{"type":"Number","description":"Total transaction volume processed month-to-date."},"TransactionsMTD":{"type":"Integer","description":"Total number of transactions processed month-to-date."},"VolumeLastMonth":{"type":"Number","description":"Total transaction volume processed in the previous month."},"TransactionsLastMonth":{"type":"Integer","description":"Total number of transactions processed in the previous month."},"AverageTicket":{"type":"Number","description":"Average transaction amount calculated across processed transactions."},"StatusDescription":{"type":"String","description":"Current status of the merchant."},"MCCDescription":{"type":"String","description":"Merchant Category Code (MCC) description associated with the merchant."},"RiskLevel":{"type":"String","description":"Risk level classification of the merchant."},"TINLastFour":{"type":"String","description":"Last four digits of the merchant's Tax Identification Number (TIN)."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```

## Get Unmatched Refunds

> Retrieve key merchant transaction activity for unmatched refunds.

```json
{"openapi":"3.0.0","info":{"title":"Reporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/reporting/UnmatchedRefunds":{"get":{"tags":["Report"],"summary":"Get Unmatched Refunds","description":"Retrieve key merchant transaction activity for unmatched refunds.","parameters":[{"name":"merchantNumber","in":"query","required":false,"description":"Filters results for a specific merchant using a unique merchant's identification number.","schema":{"type":"String"}},{"name":"startDate","in":"query","required":true,"description":"Filters results by the start date of the transmission period. Format: YYYY-MM-DD.","schema":{"type":"String"}},{"name":"endDate","in":"query","required":true,"description":"Filters results by the end date of the transmission period. Format: YYYY-MM-DD.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmatchedRefundsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResults"}}}}}}}},"components":{"schemas":{"UnmatchedRefundsResponse":{"type":"object","properties":{"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"content":{"type":"array","description":"Contains a list of merchant transactions unmatched refunds.","items":{"$ref":"#/components/schemas/UnmatchedRefundsContent"}},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"PageSettings":{"type":"object","description":"Contains pagination details for the response.","properties":{"pageNumber":{"type":"Integer","description":"Current page number of the result set."},"pageSize":{"type":"Integer","description":"Number of records returned per page."},"totalPages":{"type":"Integer","description":"Total number of pages available."},"totalRecords":{"type":"Integer","description":"Total number of records in the dataset."},"grandTotal":{"type":"Number","description":"Represents the total amount across all pages."}},"additionalProperties":false},"UnmatchedRefundsContent":{"type":"object","description":"Contains a list of unmatched refund records.","properties":{"ResellerMerchantNumber":{"type":"String","description":"The reseller's unique merchant identification number."},"ResellerBusinessDBA":{"type":"String","description":"The reseller's Doing Business As (DBA) name associated with the merchant."},"ParentMerchantNumber":{"type":"String","description":"Unique identifier assigned to the parent merchant."},"ParentBusinessDBA":{"type":"String","description":"The Doing Business As (DBA) name of the merchant's parent organization."},"MerchantNumber":{"type":"String","description":"The merchant's unique identification number."},"TaxpayerLegalName":{"type":"String","description":"The legal business name used for tax reporting."},"BusinessDBA":{"type":"String","description":"The merchant's Doing Business As (DBA) name."},"CardNumberMasked":{"type":"String","description":"Displays the masked card number used in the transaction."},"CardTransactionID":{"type":"Number","description":"A unique transaction identifier associated with the card transaction."},"CardProduct":{"type":"String","description":"Indicates the card product type."},"CardType":{"type":"String","description":"Card brand used for the transaction. Possible values: American Express, Debit Network, Discover, Electronic Benefit, MasterCard, Merlin, Not Applicable, Undefined, Unknown, Visa."},"TransactionDate":{"type":"String","description":"Date and time when the transaction occurred. Format: YYYY-MM-DDTHH:MM:SS."},"TransactionAmount":{"type":"Number","description":"Total transaction amount."},"TransactionType":{"type":"String","description":"Indicates the type of transaction. Possible values: Unmatched Refund."},"Invoice":{"type":"String","description":"The invoice number associated with the transaction."},"OrderID":{"type":"String","description":"The order identifier assigned by the merchant or system."},"TransactionBatchID":{"type":"Number","description":"Unique identifier assigned to the transaction batch."},"BatchNumber":{"type":"String","description":"Batch number assigned to the merchant transactions."},"SoftwareType":{"type":"String","description":"Software or terminal used to process the transaction."}},"additionalProperties":false},"Metadata":{"type":"object","description":"Contains metadata for the API response.","properties":{"exchangeId":{"type":"String","description":"Identifies the unique ID associated with the data exchange request."},"timestamp":{"type":"String","description":"Displays the UTC timestamp when the response was generated."}},"additionalProperties":false},"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"type":"object","properties":{"errorMessage":{"type":"String","description":"Describes the reason for the error."},"resultCode":{"type":"Integer","description":"Numeric code that identifies the type of error returned by the request."},"timeStamp":{"type":"String","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"additionalProperties":false}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/reporting/enhanced-reporting/report.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.