---
title: "Get merchant"
method: GET
path: "/v1/merchants/{merchantId}"
tags: ["Merchant"]
---

# Get merchant

`GET /v1/merchants/{merchantId}`

## Request

- Base URL: `https://sandbox.pismolabs.io/merchants`
- URL: `https://sandbox.pismolabs.io/merchants/v1/merchants/{merchantId}`
- Auth: HTTP bearer

Get merchant by ID.

For more information about merchants, see the <a href="https://developers.pismo.io/pismo-docs/docs/seller-management-overview" target="blank">Seller management overview</a> guide.

## Path parameters

- `merchantId` integer, required

## Headers

- `Content-Type` string
- `Authorization` string

## Response `200`

OK

- GETMerchantResponse
  - `id` integer: Merchant ID
  - `document_number` string: Merchant document number. This is the government document code, such as a government-issued tax ID.
  - `municipal_registration` string: Merchant's municipal registration number
  - `contact` string: Name of contact
  - `email` string: Email address
  - `zip_code` string: Postal code. This is called a zip code in the United States, but you can use other types of postal codes.
  - `address` string: Name of the street, avenue, or primary thoroughfare of the address
  - `complementary_address` string: Additional address details that help pinpoint the exact location, such as building, apartment, or floor
  - `neighborhood` string: Name of the neighborhood or administrative region where the address is located
  - `state` string: Abbreviation or full name of the state, province, or administrative division
  - `city` string: Name of the city or municipality
  - `city_code` string: Official seven-digit numeric code of the city according to the IBGE (Brazilian Institute of Geography and Statistics) code table. Used only for cities in Brazil; this code is unique per city.
  - `country` string: Full name of the country according to international standards or local registry
  - `number` integer: Numerical identifier for the specific location within a street or avenue
  - `area_code` string: Area code. The US, Canada, and certain other countries divide their telephone service into regions, which are identified by numbers called area codes. In the US, for example, area codes are 3-digit numbers.
  - `phone` string: Phone number. Parentheses and dashes are optional.
  - `additional_area_code` string: Additional area code (for `additional_phone`)
  - `additional_phone` string: Number for an additional phone. Parentheses and dashes are optional.
  - `marketplace_category` number: Marketplace category ID. The category is the type of business.
  - `status` string: Merchant status. This is a string, not an enum, so any string value is allowed, but the most commonly used values are: 'ACTIVE', 'ANALYSING', 'APPROVED', 'CANCELLED', 'PENDING', 'REJECTED'
  - `program_id` integer: Program ID for merchant account
  - `external_id` string: Internal ID used by client to reference a merchant in their domain.
  - `business_category` object: Type of business
    - `external_code` string: Code for merchant category. The category is the type of business. You can use the endpoint <a href="https://developers.pismo.io/pismo-docs/reference/get_v1-businesscategories">Retrieves business categories corresponding to query parameters</a> to get a list of business categories and their external codes.
    - `category` string: Business category name
    - `description` string: Business category description
  - `name` string: Merchant name
  - `brand_name` string: Merchant brand name. Note that this is different from a merchant's legal registered name. For example, <i>Great Company</i> as opposed to <i>Great Company, LLC</i> (legal entity name).
  - `creditor` MerchantCreditorResponse: Get response from merchant creditor.
    - `id` integer: Creditor ID
    - `name` string: Creditor name
    - `crediting_method` 'ACCOUNT': Crediting method. Must be set to `ACCOUNT`.
    - `account` object: Pismo platform account
      - `id` integer: Pismo account ID
    - `advancement_fee` string: Advancement fee for creditor.
    - `discount_rate` string: Advancement discount rate for creditor.
    - `maximum_advancement_percentage` string: Maximum advancement percentage for creditor.

## Other responses

- `400`: Bad Request
- `401`: Access token is missing or invalid
- `500`: Internal server error

---

[API](https://skmtc.dev/pismo/apis/seller-management-merchants.md) - [All operations](https://skmtc.dev/pismo/apis/seller-management-merchants/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/seller-management-merchants/revisions/f0c2e31fbbc0?raw)