Lista todos os estabelecimentos

Endpoint que lista todos os estabelecimentos associados à um integradorId específico

Resposta da requisição

A requisição retorna um array chamado data contendo os dados dos estabelecimentos associados ao integrador.

VariávelTipoDescrição
dataArray<.Data>Dados dos estabelecimentos associados ao integrador.
pageintPágina atual da requisição.
sizeintTamanho/quantidade máxima de estabelecimentos exibidos por página.
totalRecordsintTotal geral de estabelecimentos encontrados na pesquisa.

Data

VariávelTipoDescrição
idLongIdentificador do estabelecimento. Possui o mesmo número do legalDocument.
tradeNameStringNome fantasia.
aliasNameStringDenominação do estabelecimento. Ex.: MATRIZ.
corporateNameStringRazão social.
legalDocumentStringCNPJ/CPF.
typeStringTipo do documento.
constitutionDateStringData de fundação da empresa.
addressObjetc<.Address>Objeto contendo endereço.
ownerObject<.Owner>Objeto contendo dados do sócio.
accountBankObject<.AccountBank>Objeto contendo dados de conta bancária.
cnaeStringCódigo da atividade.
businessActivityIdStringId da atividade legal.
createdAtStringData e hora de inicio do onboarding.
integratorIdStringId do integrador.
globalLimitWebBigIntegerLimite global padrão para transações WEB.
dailyLimitWebBigIntegerLimite diário padrão para transações WEB.
transactionLimitWebBigIntegerLimite por transação padrão para transações WEB.
globalLimitPayBillBigIntegerLimite global padrão para transações de pagamento de conta.
dailyLimitPayBillBigIntegerLimite diário padrão para transações de pagamento de conta.
transactionLimitPayBillBigIntegerLimite por transação padrão para transações de pagamento de conta.
statusStringStatus do pedido.

Address

VariávelTipoDescrição
streetStringRua do estabelecimento.
numberStringNúmero do estabelecimento.
postalCodeStringCódigo postal (CEP) do estabelecimento.
districtStringBairro do estabelecimento.
cityNameStringCidade do estabelecimento.
stateNameStringEstado do estabelecimento.
complementStringComplemento do endereço.

Owner

VariávelTipoDescrição
nameStringNome do sócio.
legalDocumentStringDocumento legal do sócio. CPF/CNPJ.
emailStringEmail do sócio.
cellphoneStringCelular do sócio.
birthdateStringData de nascimento do sócio.
phoneStringTelefone do sócio.
rgStringDocumento pessoal do sócio.

AccountBank

VariávelTipoDescrição
idLongId do cliente.
bankIdLongCódigo do id do banco.
agencyStringAgência da conta.
numberStringNúmero da conta.
dvStringDígito verificador.
ownerNameStringNome do dono da conta.
typeStringTipo de conta.
legalDocumentStringDocumento legal do dono da conta. CNPJ/CPF.
operationStringOperação.
bankCodeStringCódigo do banco.
Query Params
int32
required
Defaults to 1

Número da página listada

int32
required
Defaults to 10

Limite de estabelecimentos exibidos na página atual

Headers
string
required
Defaults to Bearer {access_token}

Autenticação do tipo Bearer a ser enviada. O atributo {access_token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento

string
required
Defaults to {UUID}

Refere-se ao ID único do integrador disponibilizado pelo nosso time

string
Defaults to application/json

Tipo do corpo da requisição a ser enviado

Responses

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