Skip to main content
GET
/
v1
/
merchants
/
{merchantId}
Get merchant by ID
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId} \
  --header 'x-api-key: <api-key>'
{
  "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "name": "Example Company",
  "full_name": "Example Company LTDA",
  "document_number": "16525269000121",
  "document_type": "CNPJ",
  "contact": {
    "first_name": "John",
    "last_name": "Silva",
    "phone": "+551199999999",
    "email": "[email protected]",
    "mother_name": "Maria Silva",
    "birth_date": "15-08-1990",
    "document_number": "81146431023",
    "politically_exposed": false,
    "declared_income": 5000,
    "occupation": "SOFTWARE_DEVELOPER",
    "net_worth": 50000,
    "address": {
      "street": "Contact Street",
      "street_number": "456",
      "complement": "Apt 201",
      "neighborhood": "Contact Neighborhood",
      "zipcode": "87654321",
      "country": "076",
      "state": "RJ",
      "city": "Rio de Janeiro"
    }
  },
  "status": "ACTIVE",
  "address": {
    "street": "Example Street",
    "street_number": "123",
    "complement": "Suite 101",
    "neighborhood": "Downtown",
    "zipcode": "12345678",
    "country": "076",
    "state": "SP",
    "city": "São Paulo"
  },
  "transfer_configurations": {
    "automatic_transfer_enabled": true,
    "transfer_frequency": "DAILY",
    "rail": "PIX",
    "utc_hour_of_day": 12,
    "day_of_week": 1,
    "day_of_month": 1,
    "min_balance": 1000
  },
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z",
  "document_tax_type": "PJ",
  "company_logo_url": "https://example.com/logo.png",
  "website_url": "https://example.com",
  "webhook_enabled": false,
  "declared_revenue": 50000
}

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
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