---
title: "Get merchant profile details"
method: GET
path: "/data/api/v1.0/standard/merchants"
tags: ["Report"]
---

# Get merchant profile details

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

Retrieve a list of merchant profiles.

## Query parameters

- `merchantBoardedDate` string — Filters the result set by the date the merchant was boarded to Xplor Pay. Format: YYYY-MM-DD.
- `merchantNumber` string — The merchant's unique identification number.
- `sortBy` string — Specifies sorting of the paginated result set. Supports multiple fields. Valid format: desc (MerchantNumber), asc (TransactionAmount).
- `pageNumber` integer — Specifies the page number of results to return when pagination is applied.
- `pageSize` integer — Specifies the number of results to return per page. Maximum: 10000.

## Response `200`

Success

- MerchantProfileResponse
  - `merchants` Merchant[] — A list of merchant records.
    - `merchantNumber` string — The merchant's unique identification number.
    - `merchantDBA` string — Doing Business As (DBA) name of the merchant.
    - `parentMerchantNumber` string — Agent or partner merchant identifier (parent MID).
    - `parentBusinessDBA` string — DBA name of the associated agent.
    - `resellerMerchantNumber` string — Partner merchant identifier (reseller MID).
    - `resellerBusinessDBA` string — DBA name of the associated partner reseller.
    - `merchantBoardedDate` string — Date when the merchant was boarded into Xplor Pay. Format: YYYY-MM-DD.
    - `merchantBankIDNumber` string — Sponsoring bank portfolio identifier
    - `merchantIncorporationTypeDescription` string — Legal incorporation type of the merchant.
    - `isMerchantNextDayFundingEnabled` string — Specifies if next-day funding is enabled for the merchant.
    - `merchantSettlementMethodName` string — Merchant settlement method for fees. Example: Daily, Monthly.
    - `merchantAmexSENumber` string — American Express (Amex) service establishment number (for OptBlue merchants).
    - `merchantAmexMID` string — Merchant identifier provided by Amex.
    - `merchantDiscoverMID` string — Merchant identifier for the Discover network.
    - `merchantStatusDescription` string — Current status of the merchant account.
    - `merchantComplianceStatusDescription` string — Current PCI compliance status.
    - `merchantSAQTypeCode` string — SAQ type applicable based on merchant environment.
    - `merchantLastSAQPassDate` string — Date of the recent successful SAQ validation.
    - `merchantSAQExpirationDate` string — Expiration date of the merchant's current SAQ validation.
    - `merchantEmailAddress` string — Primary email address of the merchant.
    - `merchantBusinessPhoneNumberFull` string — Merchant's business phone number (formatted).
    - `merchantTaxpayerLegalName` string — Legal name of the merchant registered with the IRS.
    - `merchantTINStatusDescription` string — Tax ID Number (TIN) validation status, used to determine backup withholding.
    - `merchantMailingAddressLine1` string — Mailing address line 1.
    - `merchantMailingAddressLine2` string — Mailing address line 2.
    - `merchantMailingCity` string — City of the mailing address.
    - `merchantMailingPostalCode` string — Postal code of the mailing address.
    - `merchantMailingStateProvince` string — State or province of the mailing address.
    - `merchantMCCDescription` string — Merchant Category Code (MCC) description.
    - `merchantPhysicalAddressLine1` string — Physical business location address line 1.
    - `merchantPhysicalAddressLine2` string — Physical business location address line 2.
    - `merchantPhysicalCity` string — Physical business location city.
    - `merchantPhysicalPostalCode` string — Postal code of the business location.
    - `merchantPhysicalStateOrProvince` string — State or province of the business location.
    - `merchantPrincipal1FirstName` string — First name of principal owner 1.
    - `merchantPrincipal1LastName` string — Last name of principal owner 1.
    - `merchantPrincipal1Percentage` string — Ownership percentage of principal owner 1.
    - `merchantPrincipal2FirstName` string — First name of principal owner 2.
    - `merchantPrincipal2LastName` string — Last name of principal owner 2.
    - `merchantPrincipal2Percentage` string — Ownership percentage of principal owner 2.
  - `page` Page — Pagination metadata for the result set.
    - `number` integer — Index of the current page. Increment to request the next page.
    - `size` integer — Number of records returned per page.
    - `totalElements` integer — Total number of matching merchant records.
    - `last` boolean — Specifies whether the current page is the last in the result set.
  - `metadata` Metadata — Contains internal metadata about the response.
    - `exchangeId` string — Unique identifier for the request, useful for traceability.
    - `timestamp` string — Timestamp when the request was processed.
    - `maxId` integer — Highest record ID in the response. Useful for seek-based paging.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/versions/f37077c24b66/schema)