Report

Get Merchant Profile Details

get

Retrieve a list of merchant profiles.

Query parameters

merchantBoardedDatestringOptional

Filters the result set by the date the merchant was boarded to Xplor Pay. Format: YYYY-MM-DD.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchants

GET /data/api/v1.0/standard/merchants HTTP/1.1
Host: 
Accept: */*

{
  "merchants": [
    {
      "merchantNumber": "6588000000999998",
      "merchantDBA": "Charlies Pub",
      "parentMerchantNumber": "6588000000987654",
      "parentBusinessDBA": "Woodstock",
      "resellerMerchantNumber": "6588000000999999",
      "resellerBusinessDBA": "Snoopy Software",
      "merchantBoardedDate": "2019-10-03",
      "merchantBankIDNumber": "412099",
      "merchantIncorporationTypeDescription": "Limited liability company",
      "isMerchantNextDayFundingEnabled": "Yes",
      "merchantSettlementMethodName": "Monthly",
      "merchantAmexSENumber": "3210000001",
      "merchantAmexMID": "1230000001",
      "merchantDiscoverMID": "601000000000001",
      "merchantStatusDescription": "text",
      "merchantComplianceStatusDescription": "SAQ taken and passed, scan not required",
      "merchantSAQTypeCode": "P2Pe",
      "merchantLastSAQPassDate": "2019-10-24",
      "merchantSAQExpirationDate": "2020-10-31",
      "merchantEmailAddress": "[email protected]",
      "merchantBusinessPhoneNumberFull": "314-555-1212",
      "merchantTaxpayerLegalName": "Charlie's Pub LLC",
      "merchantTINStatusDescription": "TIN and Name combination matches IRS records",
      "merchantMailingAddressLine1": "123 Main Street",
      "merchantMailingAddressLine2": "Apt. 503",
      "merchantMailingCity": "Saint Louis",
      "merchantMailingPostalCode": "63141",
      "merchantMailingStateProvince": "MO",
      "merchantMCCDescription": "Restaurant",
      "merchantPhysicalAddressLine1": "123 Main Street",
      "merchantPhysicalAddressLine2": "Apt. 503",
      "merchantPhysicalCity": "Saint Louis",
      "merchantPhysicalPostalCode": "63141",
      "merchantPhysicalStateOrProvince": "MO",
      "merchantPrincipal1FirstName": "Charles",
      "merchantPrincipal1LastName": "Brown",
      "merchantPrincipal1Percentage": ".25",
      "merchantPrincipal2FirstName": "Lucy",
      "merchantPrincipal2LastName": "Van Pelt",
      "merchantPrincipal2Percentage": ".25"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

Get Current Pricing Configuration

get

Retrieve the current pricing configuration of a merchant.

Query parameters

merchantNumberstringOptional

The merchant's unique identification number.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantCurrentPricing

GET /data/api/v1.0/standard/merchantCurrentPricing HTTP/1.1
Host: 
Accept: */*

{
  "merchantCurrentPricing": [
    {
      "merchantNumber": "6588000000999998",
      "pricingPlanType": "IC+, Discount, Discount Plus",
      "effectiveStartDateTime": "2019-10-30T09:00:26.473",
      "effectiveEndDateTime": "2019-10-30T09:00:26.473",
      "pricingFeeDescription": "Monthly Account Fee",
      "pricingFeeID": "text",
      "pricingRate": "0.002",
      "pricingFee": "0.20",
      "payInMonth1": "6",
      "payInMonth2": "7"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

Get List of Merchant Disputes

get

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

Query parameters

processingDateTimestringOptional

Filters disputes by the date and time when the dispute was processed.

resolvedDatestringOptional

Filters disputes by the date when they were resolved.

billingAdjustmentDatestringOptional

Filters disputes where a billing adjustment was applied on the specified date.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantDisputes

GET /data/api/v1.0/standard/merchantDisputes HTTP/1.1
Host: 
Accept: */*

{
  "merchantDisputes": [
    {
      "merchantNumber": "6588000000999998",
      "cardNumberMasked": "421111**2345",
      "disputeType": "Chargeback Request",
      "originalTranRefNo": "23 digit Numeric String",
      "processingDateTime": "2019-10-30T09:00:26.473",
      "processorName": "Visa",
      "reasonCodeDescription": "Alpha Numeric String",
      "pendingSettlementDate": "text",
      "resolvedDate": "text",
      "billingAdjustmentDate": "text",
      "settlementAmount": "345.00",
      "settlementDate": "2019-10-03",
      "sourceProcessingDateTime": "2019-10-30T09:00:26.473",
      "transactionAmount": "456.00",
      "transactionDateTime": "2019-10-30T09:00:26.473"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

Get List of Cases

get

Retrieve a list of merchant case records.

Query parameters

createdDatestringOptional

Filters results by the case creation date. Format: yyyy-mm-dd.

closedDatestringOptional

Filters results by the case closure date. Format: yyyy-mm-dd.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantCases

GET /data/api/v1.0/standard/merchantCases HTTP/1.1
Host: 
Accept: */*

{
  "merchantCases": [
    {
      "merchantNumber": "6588000000999998",
      "caseNumber": "text",
      "createdDate": "2019-10-02",
      "closedDate": "2019-10-03",
      "reason": "text",
      "caseCategory": "text",
      "description": "Equipment Question"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

Get Bank Deposit Records

get

Retrieve a list of merchant bank deposit records.

Query parameters

merchantNumberstringOptional

The merchant's unique identification number.

expectedFundingDatestringOptional

Filters deposit records by the expected funding date, calculated based on the merchant's Next Day Funding flag.

fundingRequestDaysOldintegerOptional

Filters deposit or withdrawal records by the request date and time when the funding request was created.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantBankDeposits

GET /data/api/v1.0/standard/merchantBankDeposits HTTP/1.1
Host: 
Accept: */*

{
  "merchantBankDeposits": [
    {
      "merchantNumber": "6588000000999998",
      "accountNumberMasked": "******1234",
      "amount": "543.00",
      "bankIDNumber": "412099",
      "creationDayOfWeek": "MON",
      "expectedFundingDate": "2019-10-03",
      "fRDateTime": "2019-10-30T09:00:26.473",
      "fundingEventTypeName": "Deposit",
      "fundingType": "Standard Two Day Funding",
      "isNextDayFundingEnabled": "Yes",
      "settlementDate": "2019-10-03"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

Get Transaction Records

get

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

Query parameters

settlementDatestringOptional

Filters the date of the transaction was settled in the payment system. Format: yyyy-mm-dd

transactionDatestringOptional

Filters the date of the transaction was captured by the terminal.

merchantNumberstringOptional

The merchant's unique identification number.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantTransaction

GET /data/api/v1.0/standard/merchantTransaction HTTP/1.1
Host: 
Accept: */*

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

Get Merchant Closed Batches

get

Retrieve the information about closed batches for the specified merchant.

Query parameters

merchantNumberstringOptional

The merchant's unique identification number.

expectedFundedDatestringOptional

Filters results by the date when the transaction batch is expected to fund. Format: YYYY-MM-DD.

batchStatusstringOptional

Filters results by the transaction batch status. Valid values: Closed, Settled or Funded. NOTE: Status Open is always excluded from the result set.

expectedFundedDateRangestringOptional

Filters results by a date range as start and end date for funding data. Format: YYYY-MM-DD;YYYY-MM-DD.

sortBystringOptional

Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantClosedBatches

GET /data/api/v1.0/standard/merchantClosedBatches HTTP/1.1
Host: 
Accept: */*

{
  "merchantClosedBatches": [
    {
      "merchantNumber": "6588000009999998",
      "storeNumber": "2999",
      "terminalID": "4999",
      "terminalName": "",
      "batchNumber": "295",
      "closedDate": "2025-05-07T00:00:00",
      "settleDate": "2025-05-09T00:00:00",
      "fundedDate": "2025-05-09T00:00:00",
      "batchTotal": "5156.8500",
      "batchFees": "0.0000",
      "sales": "5156.8500",
      "salesCount": "6",
      "refunds": "0.0000",
      "refundCount": "0",
      "conveyedAmount": "0.0000",
      "conveyedCount": "0",
      "depositAmount": "5156.8500",
      "depositAccountNumber": "******9999",
      "backupWithholding": "0.0000",
      "transactionBatchID": 118429999,
      "batchStatus": "Funded",
      "batchTransactionCount": 9,
      "rowNumber": "1"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

Get Merchant Card Transaction

get

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

Query parameters

statusstringOptional

Filters results by the transaction status. Valid values: Void, Settled, Funded by Other, Approved, or Success.

merchantNumberstringOptional

The merchant's unique identification number.

settlementStartDatestringOptional

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.

settlementEndDatestringOptional

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.

transactionStartDatestringOptional

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.

transactionEndDatestringOptional

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.

batchNumberintegerOptional

Filters results by a single batch number. Format 123.

customerIdstringOptional

Filters results by a single customer ID.

gatewayTransactionIdintegerOptional

Filters results by a single Quest Gateway internal transaction ID.

invoicestringOptional

Filters results by a single invoice number.

orderIdstringOptional

Filters results by a single order ID.

purchaseOrderstringOptional

Filters results by a specific purchase order.

transactionAmountMaxnumberOptional

Filters results by the maximum amount in a range. If used, must include TransactionAmountMin.

transactionAmountMinnumberOptional

Filters results by the minimum amount in a range. If used, must include TransactionAmountMax.

transactionIdentifierstringOptional

Filters results by a specific transaction identifier.

transactionTypestringOptional

Filters results by a specific transaction type. Valid values: Refund, Purchase, etc.

transactionBatchIdstringOptional

Filters results by a specific transaction batch ID. If provided, returns only records associated with this ID.

approvalCodestringOptional

Filters results by the approval code returned by the card network.

authorizationCodestringOptional

Filters results by the authorization response code returned by the processor.

cardNumberLast4stringOptional

Filters results by the last four digits of the card number used in the transaction.

cardTypestringOptional

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.

pendingAuthstringOptional

Filters results by whether the transaction is pending authorization.

storeNumberstringOptional

Filters results by unique identifier for the merchant's store location.

storeTerminalNumberstringOptional

Filters results by the store's POS device or virtual terminal assigned by the merchant.

terminalNumberstringOptional

Filters results by the unique identifier for the POS device or virtual terminal.

sortColumnstringOptional

Specifies sorting of the paginated result set to a single column returned in data set. Example: MerchantNumber.

sortDirectionstringOptional

Specifies the sorting order of the result set. Valid values: ASC or DESC.

pageNumberintegerOptional

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

pageSizeintegerOptional

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

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/api/v1.0/standard/merchantCardTransaction

GET /data/api/v1.0/standard/merchantCardTransaction HTTP/1.1
Host: 
Accept: */*

{
  "merchantCardTransaction": [
    {
      "accountName": "",
      "accountType": "",
      "acquirerReferenceNumber": "24193045062006680837799",
      "approvalCode": "",
      "authorizationAmount": "29.94000000",
      "authorizationDateTime": "2025-03-01T00:53:37",
      "authorizationResponseCode": "00",
      "avsResult": "No",
      "batchNumber": "50",
      "batchReceivedDateTime": "2025-03-03T13:09:22.157",
      "billingCity": "",
      "billingCompany": "",
      "billingCountry": "",
      "billingName": "",
      "billingPhone": "",
      "billingState": "",
      "billingStreet1": "",
      "billingStreet2": "",
      "billingZip": "",
      "businessDBA": "Charlies Pub",
      "cardNumberLast4": "0001",
      "cardNumberMasked": "434257******999",
      "cardProduct": "VisaClassicCard",
      "cardTransactionID": "3195623205",
      "cardType": "Visa",
      "creditDebitName": "Debit",
      "customerID": "",
      "customerName": "",
      "displayMessage": "",
      "ExpectedFundingDate": "2025-03-02",
      "invoice": "",
      "interchangeAmount": "0.00000000",
      "interchangeFee": "0.00000000",
      "interchangeRate": "0.00000000",
      "isCardPresent": "false",
      "isCashAdvance": "false",
      "isConveyed": "false",
      "isForeignCard": "false",
      "merchantNumber": "123456789012345",
      "merchantcity": "Dallas",
      "merchantState": "TX",
      "merchantZip": "75001",
      "OrderID": "",
      "oLSClearentTranLogID": "25321193516",
      "oLSGatewayTranLogID": "25321193516",
      "pendingAuth": "false",
      "posEntryModeName": "CARD_NOT_PRESENT",
      "purchaseDescrption": "",
      "purchaseOrder": "",
      "qualificationLevelDescrption": "Qualified",
      "referenceNumber": "24193045062",
      "referenceTransactionID": "",
      "referenceTransactionID_SW": "",
      "returnResponseCode": "00",
      "SaleCreditCategory": "Sale",
      "salesTaxAmount": "0.00000000",
      "serviceFee": "0.00000000",
      "settlementDate": "2025-03-01T00:00:00",
      "shippingCity": "",
      "shippingCompany": "",
      "shippingCountry": "",
      "shippingName": "",
      "shippingPhone": "",
      "shippingState": "",
      "shippingStreet1": "",
      "shippingStreet2": "",
      "shippingZip": "",
      "softwareType": "Virtual Terminal",
      "storeNumber": "001",
      "storeterminalNumber": "",
      "terminalNumber": "VT123456",
      "tipAmount": "0.00000000",
      "transactionAmount": "29.94000000",
      "transactionBatchID": "50",
      "transactioncomment": "",
      "transactionDateTime": "2025-03-01T00:00:00",
      "transactionEmailAddress": "",
      "transactionIdentifier": "24193045062006680837799",
      "transactionStatus": "Settled",
      "transactionType": "Sale"
    }
  ],
  "page": {
    "number": 1,
    "size": 10,
    "totalElements": 142,
    "last": false
  },
  "metadata": {
    "exchangeId": "3kklskefje",
    "timestamp": "2021-05-26T18:41:19.8563278",
    "maxId": 15
  }
}

PreviousStandard Reporting NextModels

Last updated 2 minutes ago

Was this helpful?