Skip to main content
GET
Get merchant by ID

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

Merchant ID

Response

Merchant details

Transformed company data returned by the API

id
string
required
Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

name
string
required
Example:

"Example Company"

full_name
string
required
Example:

"Example Company LTDA"

document_number
string
required

CPF (11 digits) or CNPJ (14 characters). CNPJ may be numeric or alphanumeric (IN RFB 2229/2024): first 12 positions are [A-Z0-9], last 2 are numeric check digits. Formatting is stripped and letters are uppercased on input.

Example:

"16525269000121"

document_type
enum<string>
required
Available options:
CNPJ,
CPF
Example:

"CNPJ"

contact
object
required
status
enum<string>
required
Available options:
PENDING_ACTIVATION,
ACTIVE,
INACTIVE,
BLOCKED
Example:

"ACTIVE"

address
object
required
transfer_configurations
object
required
created_at
string<date-time>
required
Example:

"2023-01-01T00:00:00Z"

updated_at
string<date-time>
required
Example:

"2023-01-01T00:00:00Z"

document_tax_type
enum<string>

Document tax type:

  • PF: Pessoa Física (Individual) - for CPF companies
  • PJ: Pessoa Jurídica (Legal Entity) - for CNPJ companies
  • MEI: Microempreendedor Individual - for CNPJ companies
  • ME: Microempresa (Micro Enterprise) - for CNPJ companies
Available options:
PJ,
MEI,
ME,
PF
Example:

"PJ"

company_logo_url
string
Example:

"https://example.com/logo.png"

website_url
string
Example:

"https://example.com"

webhook_enabled
boolean

Whether webhooks are enabled for this company

Example:

false

declared_revenue
integer | null

Annual revenue in whole reais (BRL) for Banco Central compliance (Circular 3.978/2020)

Required range: x >= 0
Example:

50000