Loja
A documentação deste serviço está em construção. Fique de olho nas nossas atualizações!
Exemplo de jornada
Figura 1. Fluxo da API Loja
1.
2.
3.
4.
5.
Endpoints
Formas de pagamento
| Tipo | Endpoint | Descrição |
|---|---|---|
| GET | /api/v1/lojas/{id}/acordos-formas-pagamentos | Listar formas de pagamento |
| POST | /api/v1/lojas/{id}/acordos-formas-pagamentos | Cadastrar forma de pagamento de uma loja |
| PATCH | /api/v1/lojas/{id}/acordos-formas-pagamentos | Atualizar forma de pagamento de uma loja |
| GET | /api/v1/lojas/{id}/acordos-formas-pagamentos/quantidade-parcelas/{quantidadeParcelas} | Consultar parcelas de uma loja |
Lojas
| Tipo | Endpoint | Descrição |
|---|---|---|
| POST | /api/v1/lojas | Cadastrar uma loja |
| GET | /api/v1/lojas/{id} | Consultar uma loja cadastrada |
| GET | /api/v1/lojas/externo/{idExterno} | Consultar loja por ID externo |
| GET | /api/v1/lojas/cnpj | Listar loja pelo CNPJ |
| GET | /api/v1/lojas/cards | Listar lojas |
| PATCH | /api/v1/lojas/{idLoja} | Alterar uma loja |
Tarifas
| Tipo | Endpoint | Descrição |
|---|---|---|
| GET | /api/v1/lojas/{idLoja}/tarifas | Listar tarifas por loja |
| POST | /api/v1/lojas/{idLoja}/tarifas | Associar tarifa a uma loja |
| DELETE | /api/v1/lojas/{idLoja}/tarifas | Cancelar tarifas com a loja |
| GET | /api/v1/lojas/tarifas | Listar tarifas |
| POST | /api/v1/lojas/tarifas | Cadastrar tarifa |
| GET | /api/v1/lojas/tarifas/{id} | Consultar uma tarifa |
| PATCH | /api/v1/lojas/tarifas/{id} | Alterar cadastro de uma tarifa |
Casos de uso
Cadastrar uma loja
Serviço exclusivo para processadora Dock.
idExterno, cnpj e inscricaoEstadual.{
"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."
}
]Criar uma tarifa
Serviço exclusivo para processadora Dock.
valor para fins de teste.{
"descricao": "Cadastro de teste para tarifa.",
"valor": 30.59,
"status": "ATIVO",
"tipoCobranca": "DIA",
"diaCobranca": 2,
"utilizaValorIntervalado": true,
"valorMinimo": 49.99,
"valorMaximo": 200.99
}{
"id": 1,
"descricao": "Cadastro de teste para tarifa.",
"valor": 0,
"status": "ATIVO",
"tipoCobranca": "DIA",
"diaCobranca": 2,
"utilizaValorIntervalado": true,
"valorMinimo": 49.99,
"valorMaximo": 200.99
}Associar tarifa a uma loja
Serviço exclusivo para processadora Dock.
idExterno, cnpj e inscricaoEstadual.Exemplo de requisição:
idLoja: 32 associar uma tarifa nesta loja.idTarifa: para cada nova requisição, cadastre uma nova tarifa e insira aqui o idTarifa gerado no endpoint anterior.Exemplo de response:
{
"mensagem": "Operação realizada com sucesso."
}
Consultar uma loja
Exemplo de requisição:
id para listar uma loja.Exemplo de response:
{
"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
},
"unidadeNegocio": {
"id": 1,
"descricao": "ADMINISTRADORA"
},
"limiteParcelamento": 200.33,
"logradouro": "LOGRADOURO",
"numero": "1",
"complemento": "COMPLEMENTO",
"cep": "58000000",
"bairro": "CENTRO",
"cidade": "JOÃO PESSOA",
"estado": "PB",
"cnpj": "00000000000001",
"sigla": "SGL"
}
Os endpoints irão retornar os dados que podem ser acessados de acordo com suas credenciais de autenticação. Para mais informações, visite a página de autenticação.