---
title: "Retrieve Submerchant Data"
method: GET
path: "/api/v2_1/firms/{firmPublicId}/submerchants/{submerchantId}"
tags: ["PF-Submerchant-Registration"]
---

# Retrieve Submerchant Data

`GET /api/v2_1/firms/{firmPublicId}/submerchants/{submerchantId}`

## Request

- Base URL: `https://secure.payu.com`
- URL: `https://secure.payu.com/api/v2_1/firms/{firmPublicId}/submerchants/{submerchantId}`
- Auth: HTTP bearer

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Response `200`

- object
  - `id` string: Id assigned by PayU and required in OrderCreateRequest.
  - `externalId` string: Id assigned by the Payment Facilitator.
  - `status` 'NOT_ACTIVE' | 'ACTIVE' | 'BLOCKED': Submerchant status.
  - `lastUpdated` string, YYYY-MM-DDThh:mm:ss±hh:mm: Datetime of resource creation or last update (if applicable) in ISO 8601 format.
  - `notifyUrl` string: Notifications regarding submerchant status change will be sent to address provided in this field.
  - `legalName` string: Full legal (registration) name.
  - `dbaName` string: "Doing business as" name, usually simplified website address which can be recognized by customer (e.g. when displayed on card statement).
  - `address` object: Legal address object.
    - `street` string: Legal address street including house/apartment number (if applicable).
    - `city` string: Legal address city.
    - `postalCode` string: Legal address postal code.
    - `countryCode` string: Legal address country code. Must be a valid ISO 3166-1 two-letter code.
  - `phone` string: Contact phone number.
  - `websiteUrl` string: A valid URL address of merchant's website.
  - `mcc` number: Accurate Merchant Category Code established during KYC process by the PF.
  - `riskClass` 'LOW' | 'NORMAL' | 'HIGH': Risk class assigned by Payment Facilitator (basing on requirements provided by PayU).
  - `taxId` string: Tax identification (e.g. NIP in Poland) or business identification (e.g. IČ in Czechia).
  - `representatives` object[]: Array of either principals or enterprise owners (depends on legal form). Minimum one is required.
    - `name` string: Representative's name.
    - `phone` string: Representative's phone number.
  - `legalForm` string: Dictionary value - legal entity type. Dictionaries for specific origin are available here.
  - `agreementDate` string, yyyy-mm-dd: Date when PF signed agreement with the submerchant (required by Visa for reporting purposes).
  - `payTypeCategories` string[]: Array of enumerated values: CARD, PBL. Minimum one is required.

## Other responses

- `401`

---

[API](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api.md) - [All operations](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/revisions/185e74d5e007?raw)