get https://partnerhub-sdx-external-api.stone.com.br/affiliates/details
Obter detalhamento de um lojista
Estruturado Request
Para realizar a consulta é necessário que o StoneCode ou o Document sejam passados ou os dois campos, caso não passe nenhum campo a API vai retornar:
"error": "STONECODE OR DOCUMENT IS REQUIRED""
Estrutura Principal do Response
| Campo | Tipo | Descrição |
|---|---|---|
success | boolean | Indica se a requisição foi bem-sucedida. |
data | array | Uma lista contendo os objetos de dados detalhados do cliente. |
metadata | object | Objeto com as informações de paginação. |
Estrutura do Objeto de Cliente (em data)
data)Esta tabela descreve os campos principais do objeto de cliente. Os objetos aninhados são detalhados nas seções seguintes.
| Campo | Tipo | Descrição |
|---|---|---|
mode | string | Modelo comercial (ex: "aluguel"). |
stonecode | string | Código de identificação único do cliente. |
document | string | Documento (CNPJ) do cliente. |
trade_name | string | Nome Fantasia. |
status | string | Status atual do credenciamento (ex: "Análise de Risco"). |
credentiation_date | string | Data de credenciamento (formato DD/MM/AAAA). |
volume_exemption | object | Detalhes sobre a isenção por volume. |
pix | object | Detalhes sobre a configuração do Pix. |
sales_member | object | Dados do vendedor/parceiro responsável. |
contact_data | object | Dados de contato do cliente. |
address_data | object | Dados de endereço do cliente. |
bank_data | object | Dados bancários do cliente. |
commercial_conditions | object | Contém as taxas e condições comerciais. |
Detalhes dos Objetos Aninhados
| Campo | Tipo | Descrição |
|---|---|---|
volume_exemption | ||
volume_exemption.status | boolean | Indica se a isenção por volume está ativa. |
pix | ||
pix.status | boolean | Indica se o Pix está habilitado para o cliente. |
pix.fee | number | Taxa percentual cobrada nas transações Pix. |
sales_member | ||
sales_member.id | number ou null | ID do vendedor. |
sales_member.name | string | Nome do vendedor. |
sales_member.email | string ou null | E-mail do vendedor. |
sales_member.partner_id | string ou null | ID do parceiro associado. |
contact_data | ||
contact_data.type | number | Tipo de contato (ex: 1 para principal). |
contact_data.name | string | Nome do contato. |
contact_data.email | string | E-mail do contato. |
contact_data.mobile_phone | string | Telefone celular do contato. |
address_data | ||
address_data.zip | string | CEP do endereço. |
address_data.state | string | Sigla do estado (UF). |
address_data.city | string | Cidade. |
address_data.street | string | Logradouro. |
address_data.street_number | string ou null | Número do logradouro. |
address_data.complement | string ou null | Complemento do endereço. |
bank_data | ||
bank_data.bank_code | number | Código do banco (Febraban). |
bank_data.bank_name | string | Nome do banco. |
bank_data.bank_branch | string | Agência bancária. |
bank_data.bank_digit | string | Dígito da agência. |
bank_data.account_number | string | Número da conta. |
bank_data.account_digit | string | Dígito da conta. |
bank_data.account_type_id | string | ID do tipo da conta (Corrente/Poupança). |
Estrutura de commercial_conditions
commercial_conditions| Campo | Tipo | Descrição |
|---|---|---|
mcc | number | Merchant Category Code (Código da Categoria do Comerciante). |
rav | number | Taxa de antecipação de recebíveis (RAV). |
mdr | array | Uma lista com as taxas MDR por tipo de transação e bandeira. |
Estrutura do Objeto mdr
mdr| Campo | Tipo | Descrição |
|---|---|---|
transaction_type | string | Descrição do tipo de transação (ex: "Credito a vista"). |
rate | number | A taxa percentual (MDR) aplicada. |
card_brand | string | A bandeira do cartão (ex: "Visa", "MasterCard"). |