Consulta os sellers

Retorna a lista de sellers vinculados à empresa autenticada, com suporte à pesquisa por nome ou CPF/CNPJ.

A busca por Nome ou CpfCnpj é feita com similaridade. Para busca exata por CPF/CNPJ, o valor deve conter apenas os dígitos, SEM pontos ou traços.

Requisição

CampoTipoDescriçãoObrigatório
NomeTextoParte do nome da seller a ser pesquisadaNão
CpfCnpjTextoCPF/CNPJNão
PageNúmeroNúmero da página da consulta (paginação começa em 1)Não (default = 1)

Resposta

A resposta da requisição retorna um objeto com os dados de paginação e a lista de sellers encontrados.

Estrutura de resposta:

SellerConsultaResponse

CampoTipoDescrição
PagesNúmeroTotal de páginas disponíveis
TotalNúmeroQuantidade total de sellers encontrados
ItemsArray[SellerConsultaItemResponse]Lista dos sellers

SellerConsultaItemResponse

CampoTipoDescrição
IdTextoID do seller
NomeTextoNome do seller
RazaoSocialTextoRazão Social (ou mesmo nome para pessoa física)
PessoaTextoTipo de pessoa: F (Física) ou J (Jurídica)
CPFCNPJTextoCPF/CNPJ do seller
TitularidadeTextoNome exato do titular da conta
NomeCurtoTextoNome abreviado usado em notificações (ex: SMS)
EmailTextoEndereço de e-mail
TelefoneTextoTelefone com DDD no formato 00-0000-0000
CepTextoCódigo de Endereçamento Postal
LogradouroTextoRua, avenida, etc
ComplementoTextoComplemento do endereço
NumeroTextoNúmero do endereço
BairroTextoNome do bairro
CidadeTextoNome da cidade
UFTextoUnidade da federação (UF), ex: SP, RJ
AtivoBooleanoIndica se o seller está ativo ou inativo
ContaDestinoIdTextoIdentificador único da conta destino cadastrada
CodigoBancoTextoCódigo do banco (padrão Febraban)
AgenciaContaTextoNúmero da agência
DigitoAgenciaContaTextoDígito verificador da agência
NumeroContaTextoNúmero da conta
DigitoNumeroContaTextoDígito verificador da conta
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Parte do nome da seller que foi cadastrada

string

CPF ou CNPJ do seller

int32

Número da página da consulta

Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Parâmetros inválidos

500

Erro interno ao processar consulta

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json