post https://partnerhub-sdx-external-api.stone.com.br/affiliates
Credencia o lojista na Stone para gerar um StoneCode
Detalhamento do Payload do Request
Este payload é usado para cadastrar um novo cliente, contendo todas as informações necessárias, desde os dados da empresa até as condições comerciais e configurações de equipamento.
Campos obrigatórios.
O payload do request já é uma versão simplificada, com isso todos os campos nele são obrigatórios para o credenciamento de clientes.
Dados da Empresa e Oferta
Esta seção contém os identificadores principais da proposta comercial e os dados fiscais da empresa.
| Campo | Tipo | Descrição Detalhada |
|---|---|---|
business_unity_id | string | Identificador numérico que representa a unidade de negócio à qual a conta pertence (ex: "432" para 'Parceiro1'). |
offer_id | string | Identificador único da proposta comercial ou oferta que está sendo aplicada a este cadastro. |
document_type | number | Código que define o tipo de documento principal. Geralmente, 1 para Pessoa Física (CPF) e 2 para Pessoa Jurídica (CNPJ). |
document_number | string | O número do documento principal da empresa (neste caso, o CNPJ). |
mcc | number | Merchant Category Code. É um código numérico de 4 dígitos que classifica o ramo de atividade da empresa (ex: 7997 para clubes, academias e estabelecimentos esportivos). |
company_name | string | A Razão Social completa da empresa, conforme registrada oficialmente nos órgãos governamentais. |
trade_name | string | O Nome Fantasia da empresa, que é como ela é conhecida publicamente. |
monthly_tpv | number | Total Payment Volume. Estimativa do faturamento mensal da empresa em transações de cartão, usada para definir a elegibilidade a certas ofertas e taxas. |
Dados Bancários (bank_account_data)
bank_account_data)Objeto que agrupa todas as informações da conta bancária do cliente, onde serão depositados os valores das vendas.
| Campo | Tipo | Descrição Detalhada |
|---|---|---|
account_number | string | Número da conta bancária, sem o dígito verificador. |
account_verification_code | string | Dígito verificador (DV) da conta bancária. |
bank_branch_code | string | Número da agência bancária, sem o dígito verificador. |
bank_identifier | string | Código de compensação do banco (FEBRABAN), com 3 dígitos (ex: "197" para Stone, "001" para Banco do Brasil). |
branch_verification_code | string ou null | Dígito verificador (DV) da agência. Pode ser nulo para bancos que não o utilizam. |
bank_account_type_id | number | Código que identifica o tipo de conta bancária. Geralmente, 1 para Conta Corrente e 2 para Conta Poupança. |
head_office_payment | boolean | Valor booleano que indica se o pagamento deve ser centralizado na matriz (true) ou se deve ser pago na conta da filial (false). |
Endereço (address_list)
address_list)Objeto que contém as informações do endereço principal do estabelecimento.
Apesar do nome address_list, o exemplo mostra um objeto único. Se múltiplos endereços fossem suportados, este campo seria uma lista [].
| Campo | Tipo | Descrição Detalhada |
|---|---|---|
address_type_id | number | Código que identifica o tipo de endereço (ex: 1 para Comercial). |
neighborhood | string | Bairro do estabelecimento. |
postal_code | string | CEP (Código de Endereçamento Postal), somente números. |
state | string | Sigla da Unidade Federativa (UF) do estado. |
street_name | string | Nome da rua, avenida ou logradouro. |
city | string | Cidade do estabelecimento. |
street_number | string | Número do imóvel no logradouro. |
reference | string | Um ponto de referência para ajudar na localização. |
complement | string | Informações adicionais do endereço, como sala, andar ou bloco. |
Métodos de Captura (capture_method_list)
capture_method_list)Uma lista de objetos, onde cada objeto representa um equipamento (maquininha) a ser habilitado para o cliente.
| Campo | Tipo | Descrição Detalhada |
|---|---|---|
rental_configuration | object | Configurações de aluguel do equipamento. |
technology | string | Tecnologia do terminal (ex: "POS", "TEF"). |
is_acquirer_asset | boolean | Indica se o equipamento é um ativo da adquirente (true) ou pertence ao parceiro/cliente (false). |
terminal_model_id | number | Código que identifica o modelo do terminal. |
terminal_type_id | number | Código que identifica o tipo do terminal. |
amount_type_submit | number | Quantidade de terminais que serão solicitados. |
serial_number | string | Número de série do equipamento a ser habilitado. |
Contatos (contact_list)
contact_list)Uma lista de objetos, onde cada objeto representa um contato associado à empresa, como sócios ou representantes legais.
| Campo | Tipo | Descrição Detalhada |
|---|---|---|
address | object | Objeto de endereço residencial do contato, com a mesma estrutura do address_list. |
phone_number | string | Número de telefone do contato. |
cpf | string | CPF do contato, somente números. |
contact_name | string | Nome completo do contato. |
contact_type_id | number | Código que identifica o tipo de contato (ex: 1 para Sócio). |
email | string | Endereço de e-mail do contato. |
birthday | string | Data de nascimento no formato "AAAA-MM-DD". |
monthly_income | number | Renda mensal do contato. O valor 120000000 provavelmente está em centavos (R$ 1.200.000,00). |
occupation | string | Profissão ou ocupação principal do contato. |
legal_representative | boolean | Indica se este contato é o representante legal da empresa (true). |
Horário de Funcionamento (work_schedule)
work_schedule)Define os horários de abertura e fechamento do estabelecimento.
| Campo | Tipo | Descrição Detalhada |
|---|---|---|
open_weekday | string | Horário de abertura em dias de semana no formato "HH:mm". |
open_saturday | string | Horário de abertura aos sábados no formato "HH:mm". |
open_sunday | string | Horário de abertura aos domingos no formato "HH:mm". |
open_holiday | string | Horário de abertura em feriados no formato "HH:mm". |
close_weekday | string | Horário de fechamento em dias de semana no formato "HH:mm". |
close_saturday | string | Horário de fechamento aos sábados no formato "HH:mm". |
close_sunday | string | Horário de fechamento aos domingos no formato "HH:mm". |
close_holiday | string | Horário de fechamento em feriados no formato "HH:mm". |
open_24hrs | boolean | Indica se o estabelecimento funciona 24 horas (true) ou não (false). |