Consultar loja por id externo

Use esse endpoint para consultar uma loja com um identificador externo.

Serviço exclusivo para processadora Dock.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/lojas/externo/' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json'

{ "id": 1, "razaoSocial": "REDE NUMERO 1 LTDA", "nomeFantasia": "REDE NUMERO 1", "tipoContrato": { "id": 1, "descricao": "TIPO CONTRATO PADRAO", "status": "A", "idBin": 177, "formaLimite": "L", "cartaoGerado": "A", "tipoSenhaCartao": "3", "utilizaDigitoFixo": "N", "digitoFixo": 0, "cadastroClientesComCargaELote": "S", "permitirPagamentoAvulsoClienteConvenio": "S", "utilizaCartaoMulticash": "N", "utilizaCartaoPresente": "N", "utilizaFaturamentoMinimoConvenio": "N", "valorFaturamentoMinimoConvenio": 53.1, "tipoCartao": "F", "tipoExibicaoFatFodCliente": "D", "habPagLoteModuloConvenio": "N", "validaJurosSaque": "N", "habilitarConsultaSemEncargos": "N", "validarVendaRotativaSaldoMensal": "N", "idBinSegundaVia": 144, "liberacaoLimitePosCorte": "N", "habLimiteExtra": "N", "tipoSenha": "JA_INDICADA_POR_CARTAO", "tipoLimite": 1, "persisted": true }, "unidadeNegocio": { "id": 1, "descricao": "ADMINISTRADORA", "persisted": true }, "limiteParcelamento": 200.33, "logradouro": "LOGRADOURO", "numero": "1", "complemento": "COMPLEMENTO", "cep": "58000000", "bairro": "CENTRO", "cidade": "JOÃO PESSOA", "estado": "PB", "cnpj": "00000000000001", "dataCadastro": "2023-06-06T13:29:19.203407", "idExterno": "a1b2c3d4e5f6", "email": "rpe@rpe.tech", "inscricaoEstadual": "string", "telefone": { "id": 26, "area": "83", "numero": "999999999" }, "telefoneAdicional": { "id": 26, "area": "83", "numero": "999999999" }, "numeroEstabelecimento": -9007199254740991, "naturezaEstabelecimento": "PROPRIO", "observacao": "Cadastro de lojas." }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

idExterno

string

requerido

Identificador externo (id do estabelecimento na processadora) da loja a ser consultada.

Padrão:

a1b2c3d4e5f6

Exemplo:

a1b2c3d4e5f6

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Respostas

🟢200OK

application/json

Body

integer <int64>

opcional

Identificador do estabelecimento.

Exemplo:

razaoSocial

string

opcional

A razão social.

Exemplo:

REDE NUMERO 1 LTDA

nomeFantasia

string

opcional

Nome fantasia do estabelecimento.

Exemplo:

REDE NUMERO 1

tipoContrato

object (TipoContratoCardsResponse)

opcional

Informações sobre o tipo de contrato.

integer <int64>

opcional

Identificador do contrato.

Exemplo:

descricao

string

opcional

Descrição do tipo de contrato

Exemplo:

TIPO CONTRATO PADRAO

status

string

opcional

Status do contrato.

Valor	Descrição
A	Status ativo
C	Status cancelado

Exemplo:

idBin

integer <int64>

opcional

Identificador do BIN (Bank Identification Number) associado à loja.

Exemplo:

177

formaLimite

string

opcional

Especifica a forma ou o método de definição do limite de crédito ou de operações para a loja.

Valor	Descrição
C	Limite de crédito total disponível
L	Limite fixo predefinido
M	Limite renovado mensalmente
P	Limite específico para compras parceladas
T	Combinação de diferentes tipos de limite

Exemplo:

cartaoGerado

string

opcional

Tipo de cartão gerado para a loja. Este campo indica o estado ou a categoria do cartão.

Valor	Descrição
A	Cartão gerado e ativo
B	Cartão gerado e bloqueado

Exemplo:

tipoSenhaCartao

string

opcional

Tipo de senha do cartão.

Valor	Descrição
0	Inicia vazia, pode ser alterada. Senha do cartão anterior é replicada
1	Inicia vazia
2	Gerada aleatoriamente
3	Gerada aleatoriamente, mas pode ser alterada
4	Baseada nos primeiros dígitos do CPF, não pode ser alterada
5	Baseada nos primeiros dígitos do CPF
6	Gerada aleatoriamente, mas a primeira senha vem da TAC
7	Gerada aleatoriamente, primeira senha copiada da TAC

Exemplo:

utilizaDigitoFixo

string

opcional

Indica se a loja utiliza dígito fixo em suas operações, com valores possíveis como "S" ou "N".

Exemplo:

digitoFixo

integer <int32>

opcional

Especifica o dígito fixo utilizado pela loja em suas operações.

Exemplo:

cadastroClientesComCargaELote

string

opcional

Indica se o cadastro de clientes é realizado por meio de carga e lote, com valores possíveis como "S" ou "N".

Exemplo:

permitirPagamentoAvulsoClienteConvenio

string

opcional

Indica se a loja permite pagamentos avulsos por clientes de convênios, com valores possíveis como "S" ou "N".

Exemplo:

utilizaCartaoMulticash

string

opcional

Indica se a loja utiliza o cartão Multicash em suas operações, com valores possíveis como "S" ou "N".

Exemplo:

utilizaCartaoPresente

string

opcional

Indica se a loja utiliza cartões presente em suas operações, com valores possíveis como "S" ou "N".

Exemplo:

utilizaFaturamentoMinimoConvenio

string

opcional

Indica se a loja utiliza um valor mínimo de faturamento para clientes de convênio, com valores possíveis como "S" ou "N".

Exemplo:

valorFaturamentoMinimoConvenio

number

opcional

Especifica o valor mínimo de faturamento aplicável aos clientes de convênio da loja.

Exemplo:

53.1

tipoCartao

string

opcional

Tipo de cartão.

Exemplo:

tipoExibicaoFatFodCliente

string

opcional

Define o tipo de exibição das informações de faturamento e eventos fora de domínio para o cliente.

Exemplo:

habPagLoteModuloConvenio

string

opcional

Indica se o pagamento em lote está habilitado para o módulo de convênio da loja, com valores possíveis como "S" ou "N".

Exemplo:

validaJurosSaque

string

opcional

Indica se a validação de juros se aplica a operações de saque, com valores possíveis como "S" ou "N".

Exemplo:

habilitarConsultaSemEncargos

string

opcional

Indica se está habilitada a consulta sem encargos, com valores possíveis como "S" ou "N".

Exemplo:

validarVendaRotativaSaldoMensal

string

opcional

Indica se a validação de vendas rotativas considera o saldo mensal, com valores possíveis como "S" ou "N".

Exemplo:

idBinSegundaVia

integer <int64>

opcional

Identificador único associado ao BIN (Bank Identification Number) utilizado para emissão de segunda via.

Exemplo:

144

liberacaoLimitePosCorte

string

opcional

Indica se há liberação de limite após o corte. Especifica se a loja permite a liberação de crédito ou limite após o período de corte de fatura, com valores possíveis como "S" ou "N".

Exemplo:

habLimiteExtra

string

opcional

Indica se está habilitado o limite extra para clientes, com valores possíveis como "S" ou "N".

Exemplo:

tipoSenha

string

opcional

Define o tipo de senha utilizada pelos clientes da loja.

Exemplo:

JA_INDICADA_POR_CARTAO

tipoLimite

integer <int32>

opcional

Especifica o tipo de limite aplicado aos clientes da loja.

Exemplo:

unidadeNegocio

object (UnidadeNegocioCardsResponse)

opcional

integer <int64>

opcional

Identificador da unidade de negócio.

Exemplo:

descricao

string

opcional

Descrição da unidade de negócio.

Exemplo:

ADMINISTRADORA

limiteParcelamento

number

opcional

Limite de parcelamento.

Exemplo:

200.33

logradouro

string

opcional

Logradouro do estabelecimento.

Exemplo:

LOGRADOURO

numero

string

opcional

Número do endereço do estabelecimento.

Exemplo:

complemento

string

opcional

Complemento do endereço, se houver.

Exemplo:

COMPLEMENTO

cep

string

opcional

CEP (código postal) do endereço.

Exemplo:

58000000

bairro

string

opcional

Bairro do estabelecimento.

Exemplo:

CENTRO

cidade

string

opcional

Cidade onde é localizado o estabelecimento.

Exemplo:

JOÃO PESSOA

estado

string

opcional

Unidade Federativa (ou estado).

Exemplo:

cnpj

string

opcional

O CNPJ do estabelecimento.

Exemplo:

00000000000001

sigla

string

opcional

Sigla do tipo de banco.

Exemplo:

SGL

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor