Cadastrar uma loja

Use este endpoint para cadastrar uma loja para fazer um acordo.

Serviço exclusivo para processadora Dock.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/lojas' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "idExterno": "a1b2c3d4e5f6", "nomeFantasia": "RPE", "razaoSocial": "RETAIL PAYMENT ECOSSYSTEM", "cnpj": "44168283000150", "inscricaoEstadual": "123.456.789-1112", "endereco": { "rua": "Rua Rodrigo Mayume Chaves Piscina Júnior", "bairro": "Bessa", "localidade": "João Pessoa", "uf": "PB", "complemento": "CORE", "numero": "123", "cep": "99999999" }, "telefone": { "area": "83", "numero": "999999999" }, "telefoneAdicional": { "area": "83", "numero": "999999999" }, "email": "[email protected]", "observacao": "Modelo de response: cadastro de lojas.", "numeroEstabelecimento": 123456, "naturezaEstabelecimento": "PROPRIO" }'

[ { "id": 1, "dataCadastro": "2023-06-06T13:29:19.203407", "idExterno": "a2b2c3t4e5f6", "nomeFantasia": "RPE", "razaoSocial": "RETAIL PAYMENT ECOSSYSTEM", "cnpj": "22023603000141", "inscricaoEstadual": "129864802855", "endereco": { "id": 1, "rua": "Rua das Matas", "bairro": "Bessa", "localidade": "João Pessoa", "uf": "PB", "complemento": "CORE", "numero": "123", "cep": "99999999" }, "telefone": { "id": 26, "area": "83", "numero": "999999999" }, "telefoneAdicional": { "id": 26, "area": "83", "numero": "999999999" }, "email": "[email protected]", "naturezaEstabelecimento": "PROPRIO", "numeroEstabelecimento": 123456, "observacao": "Modelo de response: 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 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

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

idExterno

string

requerido

Identificador externo do estabelecimento.

Os testes exigem um idExterno único a cada execução

<= 64 Caracteres

Exemplo:

a1b2c3d4e5f6

nomeFantasia

string

requerido

Nome fantasia do estabelecimento.

Exemplo:

RPE

razaoSocial

string

requerido

A razão social.

<= 256 Caracteres

Exemplo:

RETAIL PAYMENT ECOSSYSTEM

cnpj

string

requerido

O CNPJ do estabelecimento.

Para realizar testes, gere um novo CNPJ a cada requisição utilizando a ferramenta de sua escolha.

Exemplo:

44168283000150

inscricaoEstadual

string

opcional

A inscrição estadual.

Para realizar testes, gere uma nova inscricaoEstadual a cada requisição utilizando a ferramenta de sua escolha.

<= 16 Caracteres

Exemplo:

129864802855

Padrão de combinação:

(^[0-9-./]*)|^$

endereco

object (EnderecoRequest)

requerido

Informações sobre o endereço.

rua

string

requerido

Endereço físico da loja ou da unidade de negócio.

<= 256 Caracteres

Exemplo:

Rua Rodrigo Mayume Chaves Piscina Júnior

bairro

string

requerido

Bairro onde a loja ou unidade de negócio está localizada.

<= 256 Caracteres

Exemplo:

Bessa

localidade

string

requerido

Cidade onde o estabelecimento está cadastrado.

<= 256 Caracteres

Exemplo:

João Pessoa

string

requerido

Estado onde o estabelecimento está cadastrado.

>= 2 Caracteres<= 2 Caracteres

Exemplo:

complemento

string

opcional

Complemento do endereço, se houver.

<= 256 Caracteres

Exemplo:

CORE

numero

string

opcional

Número do endereço do estabelecimento.

<= 64 Caracteres

Exemplo:

123

cep

string

requerido

CEP (Código de Endereçamento Postal) associado ao endereço da loja ou unidade de negócio.

Exemplo:

99999999

Padrão de combinação:

[0-9]{8}

telefone

TelefoneRequest

requerido

Informações para requisição de adição de telefone.

One of

allOf {2}

One of

TelefoneRequest

Processadora Cards

Informações para requisição de adição de telefone.

telefoneAdicional

object (TelefoneAdicionalRequest)

opcional

Informações sobre o telefone adicional.

area

string

opcional

O código de área (DDD).

Exemplo:

numero

string

opcional

O número de telefone.

Exemplo:

999999999

Padrão de combinação:

([\d]{8}[\d]?)|^$

string

opcional

Email para contato com o estabelecimento.

<= 64 Caracteres

Exemplo:

[email protected]

observacao

string

opcional

Obsevação sobre o estabelecimento.

<= 256 Caracteres

Exemplo:

Modelo de response: cadastro de lojas.

numeroEstabelecimento

integer <int64>

requerido

Número do estabelecimento.

Exemplo:

123456

naturezaEstabelecimento

enum<string>

requerido

Natureza do estabelecimento.

Valores permitidos:

PROPRIOCREDENCIADO

Exemplo:

PROPRIO

Examples

Respostas

🟢201Criado

application/json

Created

Body

Uma lista com os estabelecimentos cadastrados.

array of:

integer <int64>

opcional

Identificador do estabelecimento.

Exemplo:

dataCadastro

string <date-time>

opcional

Data e hora em que o estabelecimento foi cadastrado.

Exemplo:

2023-06-06T13:29:19.203407

idExterno

string

opcional

Identificador externo do estabelecimento.

Exemplo:

a2b2c3t4e5f6

nomeFantasia

string

opcional

Nome fantasia do estabelecimento.

Exemplo:

RPE

razaoSocial

string

opcional

A razão social.

Exemplo:

RETAIL PAYMENT ECOSSYSTEM

cnpj

string

opcional

O CNPJ do estabelecimento.

Exemplo:

22023603000141

inscricaoEstadual

string

opcional

Inscrição estadual do estabelecimento.

Exemplo:

129864802855

endereco

object (EnderecoResponse)

opcional

Informações do endereço.

integer <int64>

opcional

O identificador do endereço.

Exemplo:

rua

string

opcional

Logradouro do estabelecimento.

<= 256 Caracteres

Exemplo:

Rua das Matas

bairro

string

opcional

O bairro.

<= 256 Caracteres

Exemplo:

Bessa

localidade

string

opcional

A cidade.

<= 256 Caracteres

Exemplo:

João Pessoa

string

opcional

A Unidade Federativa (ou estado).

>= 2 Caracteres<= 2 Caracteres

Exemplo:

complemento

string

opcional

Complemento do endereço, se houver.

<= 256 Caracteres

Exemplo:

CORE

numero

string

opcional

Número do endereço do estabelecimento.

<= 64 Caracteres

Exemplo:

123

cep

string

opcional

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

Exemplo:

99999999

Padrão de combinação:

[0-9]{8}

telefone

object (TelefoneResponse)

opcional

Informações do telefone.

integer <int64>

opcional

O identificador do telefone.

Exemplo:

area

string

opcional

O código de área (DDD).

Exemplo:

numero

string

opcional

O número de telefone.

Exemplo:

999999999

Padrão de combinação:

[\d]{8}[\d]?

telefoneAdicional

object (TelefoneResponse)

opcional

Informações do telefone.

string

opcional

Email para contato com o estabelecimento.

Exemplo:

[email protected]

naturezaEstabelecimento

enum<string>

opcional

Natureza do estabelecimento.

Valores permitidos:

PROPRIOCREDENCIADO

numeroEstabelecimento

integer <int64>

opcional

Identificador do estabelecimento.

Exemplo:

123456

observacao

string

opcional

Observação sobre o estabelecimento.

Exemplo:

Modelo de response: cadastro de lojas.

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🟠409409

🔴500Erro do servidor