# Report

## Get Merchant Profile Details

> Retrieve a list of merchant profiles.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchants":{"get":{"tags":["Report"],"summary":"Get Merchant Profile Details","description":"Retrieve a list of merchant profiles.","parameters":[{"name":"merchantBoardedDate","in":"query","required":false,"schema":{"type":"string","description":"Filters the result set by the date the merchant was boarded to Xplor Pay. Format: YYYY-MM-DD."}},{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantProfileResponse"}}}},"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":{"MerchantProfileResponse":{"type":"object","properties":{"merchants":{"type":"array","description":"A list of merchant records.","items":{"$ref":"#/components/schemas/Merchant"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"Merchant":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"merchantDBA":{"type":"string","description":"Doing Business As (DBA) name of the merchant."},"parentMerchantNumber":{"type":"string","description":"Agent or partner merchant identifier (parent MID)."},"parentBusinessDBA":{"type":"string","description":"DBA name of the associated agent."},"resellerMerchantNumber":{"type":"string","description":"Partner merchant identifier (reseller MID)."},"resellerBusinessDBA":{"type":"string","description":"DBA name of the associated partner reseller."},"merchantBoardedDate":{"type":"string","description":"Date when the merchant was boarded into Xplor Pay. Format: YYYY-MM-DD."},"merchantBankIDNumber":{"type":"string","description":"Sponsoring bank portfolio identifier"},"merchantIncorporationTypeDescription":{"type":"string","description":"Legal incorporation type of the merchant."},"isMerchantNextDayFundingEnabled":{"type":"string","description":"Specifies if next-day funding is enabled for the merchant."},"merchantSettlementMethodName":{"type":"string","description":"Merchant settlement method for fees. Example: Daily, Monthly."},"merchantAmexSENumber":{"type":"string","description":"American Express (Amex) service establishment number (for OptBlue merchants)."},"merchantAmexMID":{"type":"string","description":"Merchant identifier provided by Amex."},"merchantDiscoverMID":{"type":"string","description":"Merchant identifier for the Discover network."},"merchantStatusDescription":{"type":"string","description":"Current status of the merchant account."},"merchantComplianceStatusDescription":{"type":"string","description":"Current PCI compliance status."},"merchantSAQTypeCode":{"type":"string","description":"SAQ type applicable based on merchant environment."},"merchantLastSAQPassDate":{"type":"string","description":"Date of the recent successful SAQ validation."},"merchantSAQExpirationDate":{"type":"string","description":"Expiration date of the merchant's current SAQ validation."},"merchantEmailAddress":{"type":"string","description":"Primary email address of the merchant."},"merchantBusinessPhoneNumberFull":{"type":"string","description":"Merchant's business phone number (formatted)."},"merchantTaxpayerLegalName":{"type":"string","description":"Legal name of the merchant registered with the IRS."},"merchantTINStatusDescription":{"type":"string","description":"Tax ID Number (TIN) validation status, used to determine backup withholding."},"merchantMailingAddressLine1":{"type":"string","description":"Mailing address line 1."},"merchantMailingAddressLine2":{"type":"string","description":"Mailing address line 2."},"merchantMailingCity":{"type":"string","description":"City of the mailing address."},"merchantMailingPostalCode":{"type":"string","description":"Postal code of the mailing address."},"merchantMailingStateProvince":{"type":"string","description":"State or province of the mailing address."},"merchantMCCDescription":{"type":"string","description":"Merchant Category Code (MCC) description."},"merchantPhysicalAddressLine1":{"type":"string","description":"Physical business location address line 1."},"merchantPhysicalAddressLine2":{"type":"string","description":"Physical business location address line 2."},"merchantPhysicalCity":{"type":"string","description":"Physical business location city."},"merchantPhysicalPostalCode":{"type":"string","description":"Postal code of the business location."},"merchantPhysicalStateOrProvince":{"type":"string","description":"State or province of the business location."},"merchantPrincipal1FirstName":{"type":"string","description":"First name of principal owner 1."},"merchantPrincipal1LastName":{"type":"string","description":"Last name of principal owner 1."},"merchantPrincipal1Percentage":{"type":"string","description":"Ownership percentage of principal owner 1."},"merchantPrincipal2FirstName":{"type":"string","description":"First name of principal owner 2."},"merchantPrincipal2LastName":{"type":"string","description":"Last name of principal owner 2."},"merchantPrincipal2Percentage":{"type":"string","description":"Ownership percentage of principal owner 2."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 Current Pricing Configuration

> Retrieve the current pricing configuration of a merchant.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantCurrentPricing":{"get":{"tags":["Report"],"summary":"Get Current Pricing Configuration","description":"Retrieve the current pricing configuration of a merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantCurrentPricingResponse"}}}},"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":{"MerchantCurrentPricingResponse":{"type":"object","properties":{"merchantCurrentPricing":{"type":"array","description":"A list of pricing plans and associated fees that are currently active for the merchant.","items":{"$ref":"#/components/schemas/MerchantCurrentPricing"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantCurrentPricing":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"pricingPlanType":{"type":"string","description":"Type of pricing plan applied to the merchant."},"effectiveStartDateTime":{"type":"string","description":"Date and time when the pricing plan became effective."},"effectiveEndDateTime":{"type":"string","description":"Date and time when the pricing plan is no longer valid."},"pricingFeeDescription":{"type":"string","description":"Description of the fee applied under the pricing plan."},"pricingFeeID":{"type":"string","description":"Unique identifier of the specific pricing fee."},"pricingRate":{"type":"string","description":"Percentage rate applied to each transaction."},"pricingFee":{"type":"string","description":"Fixed per-item fee applied under the pricing plan."},"payInMonth1":{"type":"string","description":"Month in which the fee is charged."},"payInMonth2":{"type":"string","description":"Additional month in which the fee is charged (if applicable)."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 List of Merchant Disputes

> Retrieve a list of disputes records associated for a specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantDisputes":{"get":{"tags":["Report"],"summary":"Get List of Merchant Disputes","description":"Retrieve a list of disputes records associated for a specified merchant.","parameters":[{"name":"processingDateTime","in":"query","required":false,"schema":{"type":"string","description":"Filters disputes by the date and time when the dispute was processed."}},{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"resolvedDate","in":"query","required":false,"schema":{"type":"string","description":"Filters disputes by the date when they were resolved."}},{"name":"billingAdjustmentDate","in":"query","required":false,"schema":{"type":"string","description":"Filters disputes where a billing adjustment was applied on the specified date."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantDisputesResponse"}}}},"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":{"MerchantDisputesResponse":{"type":"object","properties":{"merchantDisputes":{"type":"array","description":"An array of dispute records returned by the request.","items":{"$ref":"#/components/schemas/MerchantDispute"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantDispute":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"cardNumberMasked":{"type":"string","description":"Masked card number associated with the disputed transaction."},"disputeType":{"type":"string","description":"Type of the dispute raised."},"originalTranRefNo":{"type":"string","description":"Acquirer reference number assigned to the original transaction (usually 23-digit numeric)."},"processingDateTime":{"type":"string","description":"Date and time when the dispute was processed."},"processorName":{"type":"string","description":"Payment network or association that issued the dispute."},"reasonCodeDescription":{"type":"string","description":"Description of the dispute reason code assigned by the card association."},"pendingSettlementDate":{"type":"string","description":"Date when the dispute entered pending settlement status."},"resolvedDate":{"type":"string","description":"Date when the dispute was resolved."},"billingAdjustmentDate":{"type":"string","description":"Date when a billing adjustment was applied due to the dispute."},"settlementAmount":{"type":"string","description":"Settlement amount of the dispute."},"settlementDate":{"type":"string","description":"Clearing date of the disputed transaction."},"sourceProcessingDateTime":{"type":"string","description":"Date and time when the dispute was processed by the source system."},"transactionAmount":{"type":"string","description":"Amount of the original transaction."},"transactionDateTime":{"type":"string","description":"Date and time when the original transaction occurred."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 List of Cases

> Retrieve a list of merchant case records.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantCases":{"get":{"tags":["Report"],"summary":"Get List of Cases","description":"Retrieve a list of merchant case records.","parameters":[{"name":"createdDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the case creation date. Format: yyyy-mm-dd."}},{"name":"closedDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the case closure date. Format: yyyy-mm-dd."}},{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantCasesResponse"}}}},"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":{"MerchantCasesResponse":{"type":"object","properties":{"merchantCases":{"type":"array","description":"List of merchant case records.","items":{"$ref":"#/components/schemas/MerchantCase"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantCase":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"caseNumber":{"type":"string","description":"Case ID assigned when the case is created."},"createdDate":{"type":"string","description":"Date the case was created."},"closedDate":{"type":"string","description":"Date the case was closed"},"reason":{"type":"string","description":"Brief reason for opening the case."},"caseCategory":{"type":"string","description":"Category assigned to the case."},"description":{"type":"string","description":"Detailed case description."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 Bank Deposit Records

> Retrieve a list of merchant bank deposit records.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantBankDeposits":{"get":{"tags":["Report"],"summary":"Get Bank Deposit Records","description":"Retrieve a list of merchant bank deposit records.","parameters":[{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"expectedFundingDate","in":"query","required":false,"schema":{"type":"string","description":"Filters deposit records by the expected funding date, calculated based on the merchant's Next Day Funding flag."}},{"name":"fundingRequestDaysOld","in":"query","required":false,"schema":{"type":"integer","description":"Filters deposit or withdrawal records by the request date and time when the funding request was created."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantBankDepositsResponse"}}}},"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":{"MerchantBankDepositsResponse":{"type":"object","properties":{"merchantBankDeposits":{"type":"array","description":"List of merchant bank deposit records returned for the request.","items":{"$ref":"#/components/schemas/MerchantBankDeposit"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantBankDeposit":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"accountNumberMasked":{"type":"string","description":"Masked bank account number, showing only the last four digits."},"amount":{"type":"string","description":"Total deposit amount credited to the merchant's bank account."},"bankIDNumber":{"type":"string","description":"Sponsoring bank's portfolio identifier."},"creationDayOfWeek":{"type":"string","description":"Three-letter abbreviation of the day of the week when the request was created."},"expectedFundingDate":{"type":"string","description":"Expected funding date, calculated based on the merchant's Next Day Funding flag."},"fRDateTime":{"type":"string","description":"Date and time when the deposit or withdrawal request was created."},"fundingEventTypeName":{"type":"string","description":"Type of money movement, such as deposit or debit."},"fundingType":{"type":"string","description":"Funding mechanism used for the deposit."},"isNextDayFundingEnabled":{"type":"string","description":"Indicates whether Next Day Funding is enabled for the merchant."},"settlementDate":{"type":"string","description":"Clearing date for the transaction settlement."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 Transaction Records

> Retrieve a list of transaction records associated to a specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantTransaction":{"get":{"tags":["Report"],"summary":"Get Transaction Records","description":"Retrieve a list of transaction records associated to a specified merchant.","parameters":[{"name":"settlementDate","in":"query","required":false,"schema":{"type":"string","description":"Filters the date of the transaction was settled in the payment system. Format: yyyy-mm-dd"}},{"name":"transactionDate","in":"query","required":false,"schema":{"type":"string","description":"Filters the date of the transaction was captured by the terminal."}},{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantTransactionsResponse"}}}},"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":{"MerchantTransactionsResponse":{"type":"object","properties":{"merchantTransactions":{"type":"array","description":"A list of transaction records returned for the merchant.","items":{"$ref":"#/components/schemas/MerchantTransaction"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantTransaction":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"settlementDate":{"type":"string","description":"Date the transaction was settled in the system."},"transactionDate":{"type":"string","description":"Date the transaction was recorded by the terminal."},"terminalNumber":{"type":"string","description":"Unique identifier for the POS device or virtual terminal."},"batchNumber":{"type":"string","description":"Identifier for the settlement batch."},"batchReceivedDateTime":{"type":"string","description":"Date and time when the batch was processed."},"cardNetworkDescription":{"type":"string","description":"Name of the card brand used in the transaction."},"cardNumberMasked":{"type":"string","description":"Masked card number used in the transaction."},"acquirerReferenceNumber":{"type":"string","description":"Acquirer lifecycle reference number for the transaction."},"transactionIdentifier":{"type":"string","description":"Transaction Identifier assigned by the card association."},"authorizationAmount":{"type":"string","description":"Amount authorized for the transaction."},"transactionAmount":{"type":"string","description":"Total amount of the transaction."},"interchangeFee":{"type":"string","description":"Per-item fee charged by the association."},"interchangeRate":{"type":"string","description":"Percentage rate charged by the association."},"interchangeAmount":{"type":"string","description":"Total interchange amount billed by the association."},"qualificationLevelDescription":{"type":"string","description":"Description of the transaction's qualification level."},"captureTypeDescription":{"type":"string","description":"Type of the transaction processed."},"accountName":{"type":"string","description":"Merchant's DBA (Doing Business As) name."},"orderID":{"type":"string","description":"Order number provided in the gateway API call."},"oLSGatewayTranLogID":{"type":"string","description":"Internal transaction log identifier."},"approvalCode":{"type":"string","description":"Authorization code returned by the association."},"invoice":{"type":"string","description":"Invoice number associated with the transaction."},"merchantTransactionKey":{"type":"string","description":"Unique key assigned to the merchant transaction."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 Closed Batches

> Retrieve the information about closed batches for the specified merchant.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantClosedBatches":{"get":{"tags":["Report"],"summary":"Get Merchant Closed Batches","description":"Retrieve the information about closed batches for the specified merchant.","parameters":[{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"expectedFundedDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the date when the transaction batch is expected to fund. Format: YYYY-MM-DD."}},{"name":"transactionBatchId","in":"query","required":false,"schema":{"type":"integer","description":"Unique identifier of the transaction batch."}},{"name":"batchStatus","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the transaction batch status. Valid values: Closed, Settled or Funded. NOTE: Status Open is always excluded from the result set."}},{"name":"expectedFundedDateRange","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a date range as start and end date for funding data. Format: YYYY-MM-DD;YYYY-MM-DD."}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount)."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantClosedBatchesResponse"}}}},"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":{"MerchantClosedBatchesResponse":{"type":"object","properties":{"merchantClosedBatches":{"type":"array","items":{"$ref":"#/components/schemas/MerchantClosedBatch"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantClosedBatch":{"type":"object","properties":{"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"storeNumber":{"type":"string","description":"Unique identifier for the merchant's store location."},"terminalID":{"type":"string","description":"The terminal identification number where the batch was processed."},"terminalName":{"type":"string","description":"Description or name of the terminal."},"batchNumber":{"type":"string","description":"The unique identifier for the closed batch."},"closedDate":{"type":"string","description":"Date when the batch was closed."},"settleDate":{"type":"string","description":"Date when the batch was settled with the bank."},"fundedDate":{"type":"string","description":"Date when the funds were deposited."},"batchTotal":{"type":"string","description":"Total amount of all transactions in the batch."},"batchFees":{"type":"string","description":"Total fees charged for processing the batch."},"sales":{"type":"string","description":"Total amount of sales transactions in the batch."},"salesCount":{"type":"string","description":"Total number of sales transactions in the batch."},"refunds":{"type":"string","description":"Total amount of refund transactions in the batch."},"refundCount":{"type":"string","description":"Total number of refund transactions in the batch."},"conveyedAmount":{"type":"string","description":"Total conveyed amount in the batch."},"conveyedCount":{"type":"string","description":"Total number of conveyed transactions in the batch."},"depositAmount":{"type":"string","description":"Actual amount deposited to merchant account."},"depositAccountNumber":{"type":"string","description":"Masked deposit account number."},"backupWithholding":{"type":"string","description":"Backup withholding amount applied to the batch."},"transactionBatchID":{"type":"integer","description":"Unique identifier for the transaction batch."},"batchStatus":{"type":"string","description":"Status of the transaction batch."},"batchTransactionCount":{"type":"integer","description":"Total number of transaction in the batch."},"rowNumber":{"type":"string","description":"Row number for the batch record."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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 Card Transaction

> Retrieve detailed card transaction records for a specified merchant, including voided transactions.

```json
{"openapi":"3.0.0","info":{"title":"StandardReporting.API","version":"1.0.0"},"paths":{"/data/api/v1.0/standard/merchantCardTransaction":{"get":{"tags":["Report"],"summary":"Get Merchant Card Transaction","description":"Retrieve detailed card transaction records for a specified merchant, including voided transactions.","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the transaction status. Valid values: Void, Settled, Funded by Other, Approved, or Success."}},{"name":"merchantNumber","in":"query","required":false,"schema":{"type":"string","description":"The merchant's unique identification number."}},{"name":"settlementStartDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the start date of the settlement period. Format: YYYY-MM-DD. If used, must include SettlementEndDate. The date range cannot exceed 90 days."}},{"name":"settlementEndDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the end date of the settlement period. Format: YYYY-MM-DD. If used, must include SettlementStartDate. The date range cannot exceed 90 days."}},{"name":"transactionStartDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the start date of the transaction period. Format: YYYY-MM-DD. If used, must include TransactionEndDate. The date range cannot exceed 90 days."}},{"name":"transactionEndDate","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the start date of the transaction period. Format: YYYY-MM-DD. If used, must include TransactionStartDate. The date range cannot exceed 90 days."}},{"name":"batchNumber","in":"query","required":false,"schema":{"type":"integer","description":"Filters results by a single batch number. Format 123."}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a single customer ID."}},{"name":"gatewayTransactionId","in":"query","required":false,"schema":{"type":"integer","description":"Filters results by a single Quest Gateway internal transaction ID."}},{"name":"invoice","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a single invoice number."}},{"name":"orderId","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a single order ID."}},{"name":"purchaseOrder","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a specific purchase order."}},{"name":"transactionAmountMax","in":"query","required":false,"schema":{"type":"number","description":"Filters results by the maximum amount in a range. If used, must include TransactionAmountMin."}},{"name":"transactionAmountMin","in":"query","required":false,"schema":{"type":"number","description":"Filters results by the minimum amount in a range. If used, must include TransactionAmountMax."}},{"name":"transactionIdentifier","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a specific transaction identifier."}},{"name":"transactionType","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a specific transaction type. Valid values: Refund, Purchase, etc."}},{"name":"transactionBatchId","in":"query","required":false,"schema":{"type":"string","description":"Filters results by a specific transaction batch ID. If provided, returns only records associated with this ID."}},{"name":"approvalCode","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the approval code returned by the card network."}},{"name":"authorizationCode","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the authorization response code returned by the processor."}},{"name":"cardNumberLast4","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the last four digits of the card number used in the transaction."}},{"name":"cardType","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the card brand used for the transaction. Valid values: American Express, Clearent, Debit Network, Discover, Electronic Benefit, MasterCard, Merlin, Not Applicable, Undefined, Unknown, Visa."}},{"name":"pendingAuth","in":"query","required":false,"schema":{"type":"string","description":"Filters results by whether the transaction is pending authorization."}},{"name":"storeNumber","in":"query","required":false,"schema":{"type":"string","description":"Filters results by unique identifier for the merchant's store location."}},{"name":"storeTerminalNumber","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the store's POS device or virtual terminal assigned by the merchant."}},{"name":"terminalNumber","in":"query","required":false,"schema":{"type":"string","description":"Filters results by the unique identifier for the POS device or virtual terminal."}},{"name":"sortColumn","in":"query","required":false,"schema":{"type":"string","description":"Specifies sorting of the paginated result set to a single column returned in data set. Example: MerchantNumber."}},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"string","description":"Specifies the sorting order of the result set. Valid values: ASC or DESC."}},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the page number of results to return when pagination is applied."}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","description":"Specifies the number of results to return per page. Maximum: 10000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantCardTransactionResponse"}}}},"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":{"MerchantCardTransactionResponse":{"type":"object","properties":{"merchantCardTransaction":{"type":"array","items":{"$ref":"#/components/schemas/MerchantCardTransaction"}},"page":{"$ref":"#/components/schemas/page"},"metadata":{"$ref":"#/components/schemas/metadata"}},"additionalProperties":false},"MerchantCardTransaction":{"type":"object","properties":{"accountName":{"type":"string","description":"Name listed on merchant account."},"accountType":{"type":"string","description":"Type of merchant account."},"acquirerReferenceNumber":{"type":"string","description":"Acquirer lifecycle reference number for the transaction."},"approvalCode":{"type":"string","description":"Authorization code returned by the card network."},"authorizationAmount":{"type":"string","description":"Amount authorized for the transaction."},"authorizationDateTime":{"type":"string","description":"Date and time when the transaction authorized. Format: YYYY-MM-DDTHH:mm:ss"},"authorizationResponseCode":{"type":"string","description":"Response code returned during transaction authorization."},"avsResult":{"type":"string","description":"Indicates whether the Address Verification Service (AVS) check was successful."},"batchNumber":{"type":"string","description":"Identifier for the settlement batch."},"batchReceivedDateTime":{"type":"string","description":"Date and time when the batch was received for processing. Format: YYYY-MM-DDTHH:mm:ss."},"billingCity":{"type":"string","description":"City name in the merchant billing address."},"billingCompany":{"type":"string","description":"Company name in the merchant billing address."},"billingCountry":{"type":"string","description":"Country code in the merchant billing address."},"billingName":{"type":"string","description":"Name of the billing contact."},"billingPhone":{"type":"string","description":"Phone number in the billing address."},"billingState":{"type":"string","description":"State code in the billing address."},"billingStreet1":{"type":"string","description":"Primary street address in the billing address."},"billingStreet2":{"type":"string","description":"Secondary street address in the billing address."},"billingZip":{"type":"string","description":"Postal code in the billing address."},"businessDBA":{"type":"string","description":"Merchant's DBA (Doing Business As) name."},"cardNumberLast4":{"type":"string","description":"Last four digits of the card used in the transaction."},"cardNumberMasked":{"type":"string","description":"Masked card number used in the transaction."},"cardProduct":{"type":"string","description":"Card product name used in the transaction."},"cardTransactionID":{"type":"string","description":"Unique identifier for the card transaction."},"cardType":{"type":"string","description":"Card brand name used in the transaction."},"creditDebitName":{"type":"string","description":"Indicates whether the transaction was a credit or debit."},"customerID":{"type":"string","description":"Unique identifier for the customer, if available."},"customerName":{"type":"string","description":"Name of the customer, if available."},"displayMessage":{"type":"string","description":"Message displayed during the transaction, if applicable."},"ExpectedFundingDate":{"type":"string","description":"Expected funding date for the transaction. Format: YYYY-MM-DD."},"invoice":{"type":"string","description":"Invoice number associated with the transaction."},"interchangeAmount":{"type":"string","description":"Total interchange amount billed by the card network."},"interchangeFee":{"type":"string","description":"Per-item fee charged by the card network."},"interchangeRate":{"type":"string","description":"Percentage rate charged by the card network."},"isCardPresent":{"type":"string","description":"Indicates whether the card was present during the transaction."},"isCashAdvance":{"type":"string","description":"Indicates whether the transaction involved a cash advance."},"isConveyed":{"type":"string","description":"Indicates whether the transaction amount was conveyed (funded externally; example: Amex Direct)"},"isForeignCard":{"type":"string","description":"Indicates whether a foreign-issued card was used."},"merchantNumber":{"type":"string","description":"The merchant's unique identification number."},"merchantcity":{"type":"string","description":"Merchant's city name."},"merchantState":{"type":"string","description":"Merchant's state code."},"merchantZip":{"type":"string","description":"Merchant's postal code."},"OrderID":{"type":"string","description":"Order ID provided in the gateway API call."},"oLSClearentTranLogID":{"type":"string","description":"Internal transaction log identifier."},"oLSGatewayTranLogID":{"type":"string","description":"Internal gateway transaction log identifier."},"pendingAuth":{"type":"string","description":"Indicates whether the transaction is in pending authorization."},"posEntryModeName":{"type":"string","description":"Entry method name used to capture the sale transaction."},"purchaseDescrption":{"type":"string","description":"Description of the transaction, if available."},"purchaseOrder":{"type":"string","description":"Purchase order number associated with the transaction, if available."},"qualificationLevelDescrption":{"type":"string","description":"Description of the transaction's qualification level."},"referenceNumber":{"type":"string","description":"Reference number assigned to the transaction."},"referenceTransactionID":{"type":"string","description":"Identifier of the referenced transaction."},"referenceTransactionID_SW":{"type":"string","description":"Additional identifier of the referenced transaction."},"returnResponseCode":{"type":"string","description":"Code returned in response to the transaction."},"SaleCreditCategory":{"type":"string","description":"Indicates whether the transaction is a sale or credit."},"salesTaxAmount":{"type":"string","description":"Sales tax amount applied to the transaction."},"serviceFee":{"type":"string","description":"Service fee applied to the transaction."},"settlementDate":{"type":"string","description":"Date the transaction was settled in the system. Time portion is set to all zeros. Format: YYYY-MM-DDTHH:mm:ss."},"shippingCity":{"type":"string","description":"City name for shipping the merchant."},"shippingCompany":{"type":"string","description":"Shipping company came for merchant."},"shippingCountry":{"type":"string","description":"Code for country for shipping the merchant."},"shippingName":{"type":"string","description":"Name of shipping contact."},"shippingPhone":{"type":"string","description":"Phone number in the shipping address."},"shippingState":{"type":"string","description":"State code in the shipping address."},"shippingStreet1":{"type":"string","description":"Primary street address in the shipping address."},"shippingStreet2":{"type":"string","description":"Secondary street address in the shipping address."},"shippingZip":{"type":"string","description":"Postal code in the shipping address."},"softwareType":{"type":"string","description":"Type of software used for processing the transaction."},"storeNumber":{"type":"string","description":"Unique identifier for the merchant's store location."},"storeterminalNumber":{"type":"string","description":"Unique identifier for the POS device or virtual terminal assigned by the merchant."},"terminalNumber":{"type":"string","description":"Unique identifier for the POS device or virtual terminal."},"tipAmount":{"type":"string","description":"Tip amount included in the transaction."},"transactionAmount":{"type":"string","description":"Total amount of the transaction."},"transactionBatchID":{"type":"string","description":"Identifier for the batch that included the transaction."},"transactioncomment":{"type":"string","description":"Comments associated with the transaction, if available."},"transactionDateTime":{"type":"string","description":"Date when the transaction was recorded by the terminal. Time portion is set to all zeros. Format: YYYY-MM-DDTHH:mm:ss."},"transactionEmailAddress":{"type":"string","description":"Email address provided during the transaction, if available."},"transactionIdentifier":{"type":"string","description":"Transaction identifier assigned by the card network."},"transactionStatus":{"type":"string","description":"Current status of the transaction. Valid values: Settled, Rejected, or Void."},"transactionType":{"type":"string","description":"Type of the transaction. For example: Sale, Void."}},"additionalProperties":false},"page":{"type":"object","description":"Pagination metadata for the result set.","properties":{"number":{"type":"integer","description":"Index of the current page. Increment to request the next page."},"size":{"type":"integer","description":"Number of records returned per page."},"totalElements":{"type":"integer","description":"Total number of matching merchant records."},"last":{"type":"boolean","description":"Specifies whether the current page is the last in the result set."}},"additionalProperties":false},"metadata":{"type":"object","description":"Contains internal metadata about the response.","properties":{"exchangeId":{"type":"string","description":"Unique identifier for the request, useful for traceability."},"timestamp":{"type":"string","description":"Timestamp when the request was processed."},"maxId":{"type":"integer","description":"Highest record ID in the response. Useful for seek-based paging."}},"additionalProperties":false},"ErrorResults":{"type":"object","description":"Contains one or more error objects returned.","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}}}}
```