Skip to main content
POST
Criar submerchant

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Body

application/json
trade_name
string
required

Nome fantasia

Required string length: 3 - 255

Razão social (PJ) ou nome completo (PF)

Required string length: 3 - 255
tax_id
string
required

CPF (11 dígitos para PF) ou CNPJ (14 dígitos para PJ)

Required string length: 11 - 20
email
string<email>
required
entity_type
enum<string>

Tipo de entidade: pf (Pessoa Física / CPF) ou pj (Pessoa Jurídica / CNPJ). Padrão: pj

Available options:
pf,
pj
phone
string
Maximum string length: 20
website
string
Maximum string length: 255
description
string
soft_descriptor
string

Descrição na fatura do cartão

Maximum string length: 22
birth_date
string

Data de nascimento (YYYY-MM-DD), recomendado para PF

Pattern: ^\d{4}-\d{2}-\d{2}$
mother_name
string

Nome da mãe, recomendado para PF

Maximum string length: 255
business_type
enum<string>
Available options:
physical,
digital,
both
product_categories
enum<string>[]
Available options:
books,
clothes,
electronics-and-art,
tools-and-utilities,
others-physics,
infoproducts,
software-and-digital-tools,
templates-and-graphics-resources,
audio-and-soundtracks,
plugins-and-extensions,
others-digital
average_ticket
number

Ticket médio em centavos

Required range: x >= 0
monthly_revenue
number

Receita mensal em centavos

Required range: x >= 0
mcc
string

Código MCC (Merchant Category Code) de 4 dígitos

Required string length: 4
Pattern: ^\d{4}$
cnaes
object[]

Lista de CNAEs do submerchant

Response

Submerchant criado com sucesso

success
boolean
Example:

true

message
string
data
object