get https://pagamentos.k8bank.com.br/PagamentosAPI/api/marketplace/sellers
Consulta os sellers vinculados a empresa que está executando a chamada desta rota, opcionalmente podem ser definidos parâmetros de pesquisa como nome ou cpfcnpj.
A consulta usará os parâmetros para pesquisa com similaridade(contendo) os parâmetros informados, caso a pesquisa do cpfcnpj seja feita por igualdade, utilize o cpfcnpj formatado(com pontos e traços).
Requisição
Campo | Tipo | Descrição |
---|---|---|
Nome | Texto | Parte do nome da seller que foi cadastrada |
CpfCnpj | Texto | CPF ou CNPJ da seller, utilize pontos e traços quando informar o valor completo |
Page | Número | Número da página |
Resposta
Campo | Tipo | Descrição |
---|---|---|
SellerConsultaResponse | - | - |
Pages | Número | Retorna o número de páginas obtidas na consulta |
Total | Número | Retorna o total de registros obtidos na consulta |
Items | Array[SellerConsultaItemResponse] | - |
SellerConsultaItemResponse | - | - |
Id | Texto | ID do seller |
Nome | Texto | Nome do seller |
RazaoSocial | Texto | Razão Social do Seller quando pessoa jurídica, repete-se o nome em case de pessoa física |
Pessoa | Texto | Tipo de pessoa do Seller(F ou J) Física ou Jurídica |
CPFCNPJ | Texto | CPF/CNPJ do cliente final da transação |
Titularidade | Texto | Nome do titular da conta de destino, este nome deve estar exatamente igual ao nome cadastrado na |
NomeCurto | Texto | Usado para envio de SMS, nome abreviado do cliente |
Texto | Endereço válido de e-mail do Seller | |
Telefone | Texto | Número de telefone no padrão 00-0000-0000 |
Cep | Texto | Número do CEP |
Logradouro | Texto | Endereço completo(Rua, Avenida, etc…) |
Complemento | Texto | Informações complementares do endereço(opcional) |
Numero | Texto | Número do endereço |
Bairro | Texto | Nome do bairro |
Cidade | Texto | Nome da cidade |
UF | Texto | Sigla da UF do endereço |
Ativo | Boleano | Retorna valor true ou false, para atualização do status do seller, como ativo ou inativo |
ContaDestinoId | Texto | Identificador único da conta de destino |
CodigoBanco | Texto | Código do banco seguindo o padrão da Febraban |
AgenciaConta | Texto | Número da agência da conta de destino |
DigitoAgenciaConta | Texto | Número do dígito da conta de destino |
NumeroConta | Texto | Número da conta de destino |
DigitoNumeroConta | Texto | Número do dígito da conta de destino |