Tote
InícioIntegraSaiba mais
InícioIntegraSaiba mais
  1. APIs
  • Visão geral
  • O QUE HÁ DE NOVO
    • Release Notes
      • Horizon
  • GUIAS
    • Manuais
      • Diretrizes Básicas
      • Como se autenticar
      • Respostas e status
      • Nossas APIs
      • Webhook
      • FAQ
  • REFERÊNCIA DAS APIS
    • APIs
      • Autenticação
        • Gerar token de acesso
      • Agenda lojista
        • Agenda
          • Cadastrar recebimento em agenda
          • Cadastrar agenda manual
          • Listar agenda por loja
          • Consultar agenda específica
          • Listar transações pelo ID da agenda ou loja
        • Configurações de Agendas
          • Cadastrar configuração
          • Listar configurações da agenda
          • Alterar configuração de uma loja
        • Modalidade
          • Cadastrar modalidades
          • Listar modalidades
          • Listar modalidade por lançamento
          • Alterar tipo de modalidade
        • Lançamentos
          • Listar lançamentos por loja
          • Cadastrar lançamentos
          • Cadastrar lançamento de ajuste
        • Tipo de ajuste
          • Cadastrar um tipo de ajuste
          • Listar tipo de ajuste
      • Acheron
        • Pagamento
          • Cadastrar um pagamento
          • Cancelar um pagamento
          • Criar intenção de pagamento
          • Confirmar intenção de pagamento
          • Cancelar intenção de pagamento
          • Listar intenções de pagamento
          • Criar pagamento via PIX
        • Venda
          • Criar venda com cartão
          • Cancelar venda com cartão
          • Criar venda com portador
          • Cancelar venda com portador
          • Estornar uma venda
        • E-Commerce
          • Criar venda e-commerce
          • Confirmar pagamento e-commerce
          • Listar pagamento e-commerce
          • Cancelar venda e-commerce
          • Gerar token de e-commerce
        • VTEX
          • Criar venda VTEX
          • Confirmar venda VTEX
          • Estornar venda VTEX
          • Cancelar venda VTEX
          • Listar manifesto do provedor de pagamento
        • Simulação
          • Criar simulação
        • Pré-autorização
          • Listar pré-autorização
          • Cancelar valor reservado
          • Listar valor reservado
        • BNPL
          • Confirmar estorno de venda
          • Estornar venda
          • Simular venda
          • Confirmar venda
          • Sensibilizar venda
      • Banking
        • Conciliação bancária
          • Gerar saldo para um emissor
          • Gerar extrato para um emissor
          • Gerar arquivos de conciliação
        • Contas
          • Listar contas digitais
        • Pix
          • Transferir pix
          • Listar status do pix
          • Listar transferências Pix
          • Listar informações de chave
      • Biometria
        • Biometria
        • Handshake fortface
          • Iniciar o processo de autenticação biométrica SDK
          • Iniciar o processo de autenticação biométrica Backoffice
        • Biometria
          • Identificar um rosto
          • Cadastrar uma face utilizando o SDK Fortface
          • Cadastrar uma face através do Backoffice da Fortface
      • Broker
        • Enviar mensagem SMS
      • Cartões
        • Portadores
          • Buscar cartão pelo titular
          • Cadastrar portador adicional
          • Listar cartões do adicional
          • Gerar cartão adicional
        • CVV Virtual
          • Ativar CVV Virtual do titular
          • Inativar CVV Virtual
          • Atualizar data de expiração do CVV
        • Senha
          • Cadastrar senha
          • Alterar senha
          • Autenticar senha do cartão
          • Gerar senha e enviar por SMS
        • Bloqueios e Desbloqueios
          • Bloquear um cartão temporariamente
          • Bloquear permanentemente
          • Listar histórico de bloqueios
          • Listar tipos de bloqueio
          • Desbloquear cartão
        • Cartões
          • Solicitar segunda via
          • Trocar cartão pendente
          • Buscar cartão criptografado
          • Listar histórico de cancelamento
          • Listar tipos de cancelamento
          • Gerar um cartão virtual
          • Listar cartão virtual
          • Buscar cartão pelo id
          • Buscar cartão pelo número
          • Buscar cartão pelo CPF
          • Buscar cartão bandeirado
          • Token Merci
          • Trocar cartão do portador
          • Cadastrar Pessoa Jurídica
          • Solicitar troca do cartão
          • Listar BIN
        • No Name
          • Listar lotes de cartão
          • Criar lote de cartões
          • Destruir cartão
          • Vincular cartão ao titular
          • Vincular cartão adicional
          • Destruir lote de cartões
          • Embossar cartões por lote
          • Listar cartões
        • Vipagem
          • Listar cartões bandeirados
          • Emitir segunda via
      • Embossing
        • Cartões
          • Embossing de cartão
          • Bloquear cartão por falha
          • Listar cartões pendentes
        • Impressoras
          • Inativar impressora
          • Ativar impressora
      • Empréstimo
        • Empréstimo Pix Card
          • Enviar arquivo
          • Alterar dados bancários
          • Transferir via Pix
          • Cadastrar pessoa física
          • Simular empréstimo
          • Confirmar empréstimo
          • Aprovar crédito
          • Criar contrato
          • Consultar pessoa
        • Empréstimo FGTS
          • Simular saldo
          • Obter saldo
          • Cadastrar pessoa física
          • Cadastrar operação
          • Submeter para aprovação
          • Consultar informações
          • Listar produto
          • Consultar pessoa
          • Listar operações
          • Acompanhar operação
          • Listar estado civil
          • Listar bancos
      • Faturamentos
        • Parcelamento de fatura
          • Antecipar uma parcela do parcelamento
          • Antecipar todo o parcelamento
          • Buscar parcelamento pendente
          • Buscar parcelamento ativo
          • Simular antecipação
          • Parcelar faturas
        • Ciclos de fatura
          • Consultar ciclos de vencimento
          • Alterar o ciclo de vencimento
        • Consulta de faturas
          • Consultar lançamentos futuros
          • Consultar faturas por período
          • Consultar faturas futuras
          • Consultar última fatura fechada
          • Consultar fatura detalhada
          • Consultar fatura atual
          • Visualizar saldo detalhado
        • Faturas digitais
          • Receber fatura em PDF
          • Aderir à fatura digital
          • Cancelar fatura digital
          • Aderir à fatura por SMS
          • Cancelar fatura por SMS
      • Financiamentos
        • Parcelamento total
          • Simular parcelamento devedor total
        • Parcelamento manual
          • Simular parcelamento manual
      • Gestão de contas
        • Cadastrar cartão físico para titular
      • Lançamentos
        • Ajustes
          • Lançar um ajuste financeiro
          • Listar um ajuste financeiro
          • Lançar ajustes a débito
          • Lançar ajustes a crédito
          • Listar tipos de ajustes
          • Listar faturas ajustadas
          • Lançar um ajuste na fatura
        • Vendas
          • Antecipar venda total
          • Antecipar venda avulsa
        • Pagamentos
        • Antecipação
          • Listar compras passíveis de antecipação
        • Baixas bancárias
          • Estornar lançamento de baixa bancária
          • Lançar baixa báncaria
          • Lançar baixa bancária de pagamento
          • Estornar pagamento de baixa bancária
      • Loja
        • Formas de Pagamentos
          • Listar formas de pagamento
          • Cadastrar forma de pagamento
          • Atualizar forma de pagamento
          • Consultar parcelas de uma loja
        • Tarifas
          • Listar tarifas
          • Cadastrar tarifa
          • Associar tarifa a uma loja
          • Cancelar tarifas com a loja
          • Listar tarifas por loja
          • Consultar uma tarifa
          • Alterar cadastro de uma tarifa
        • Lojas
          • Cadastrar uma loja
          • Consultar uma loja
          • Consultar loja por id externo
          • Listar loja pelo CNPJ
          • Listar lojas
          • Alterar uma loja
      • Pacote SMS
        • Contratar um pacote SMS
        • Cancelar um pacote SMS
        • Consultar pacotes do portador
        • Habilitar celular para adesão do pacote
        • Habilitar celular para receber bônus
        • Consultar pacotes disponíveis
        • Consultar pacotes contratados
      • Parâmetros
        • Listar parâmetros cadastrados
        • Listar parâmetros exibíveis
      • Pix
        • Pix Imediato
          • Listar chaves Pix Imediato
          • Gerar Pix Imediato
          • Listar uma chave Pix Imediato
      • Pix Card
        • PixCard
          • Transferir via Pix
          • Consultar CPF
          • Cadastrar cliente
          • Simular operação
          • Confirmar operação
          • Cadastrar documento do portador
        • Assinatura
          • Listar as assinaturas
          • Cadastrar assinatura
          • Verificar assinaturas para cobrança
          • Listar assinaturas válidas
          • Listar planos
          • Alterar assinatura pelo CPF
        • Conta Digital
          • Listar termos obrigatórios
          • Cadastrar termo obrigatório
          • Cadastrar documento do portador
          • Criar uma conta digital
          • Criar uma conta alias
          • Listar contas pelo identificador
          • Listar informações do portador
        • Transferência
          • Agendar transferência
          • Efetuar transferência
          • Listar status de transferência
          • Listar devoluções
          • Listar transferências
          • Listar agendamentos de transferências
        • Relatórios
          • Listar operações
          • Listar relatórios de assinaturas
          • Listar adesões
        • QR Code
          • Criar QR Code estático
          • Decodificar QR Code
        • Chaves
          • Confirmar reivindicações
          • Fazer reivindicação
          • Cadastrar chave
          • Deletar chave
          • Listar chaves
          • Consultar chaves pelo identificador
          • Listar reivindicações
        • Limites
          • Criar limite de horário
          • Associar conta a grupo de serviço
          • Listar destinos confiáveis
          • Alterar limite do destino confiável
          • Listar limites de horários
          • Listar requisições
          • Remover destino confiável
      • Portadores
        • Gestão de portadores
          • Listar status do portador pelo CPF
          • Listar portadores
          • Alterar dados do portador
          • Alterar status de ativo problemático
          • Listar informações do portador
          • Alterar o limite do portador
          • Bloquear um portador
          • Desbloquear um portador
          • Listar adicionais pelo CPF
          • Listar portadores em lote
          • Listar contas pelo CPF (simplificado)
          • Listar contas pelo CNPJ
          • Alterar produto do portador
          • Listar contas pelo documento
          • Listar contas pelo RG
          • Listar contas pelo nome
          • Alterar vipagem
          • Consultar ciclo do portador
          • Listar contas pelo CPF (completo)
        • Gestão de dependentes
          • Listar dependentes pelo titular
          • Cadastrar dependentes
        • Gestão de telefones
          • Listar telefones
          • Cadastrar telefone
          • Deletar telefone
          • Receber SMS
        • Visualização de histórico
          • Listar histórico do portador
          • Listar ocorrências
          • Listar inadimplências pelo portador
          • Listar o histórico de limites
        • Gestão de senhas
          • Enviar senha por SMS
          • Alterar senha do portador
        • Cadastro de contas
          • Cadastrar uma conta PJ
          • Cadastrar uma conta PF
        • Informações da base de dados
          • Listar tipos de bloqueio
          • Listar escolaridades
          • Listar ocupações
        • BNPL
          • Consultar informações do portador
      • Portuno
        • Conta
          • Listar conta
          • Criar uma conta
          • Trocar o segredo da conta
        • Integração
          • Listar integrações
          • Alterar tempo de expiração de uma integração
      • Produtos
        • Produtos
          • Consultar produtos
          • Consultar um produto
        • Serviços financeiros
          • Listar serviços financeiros
      • Regulatório
        • Listar informações
      • Recompensa
        • Aderir à anuidade bonificada
        • Cancelar anuidade bonificada
        • Listar anuidades do produto
        • Listar anuidade do portador
        • Listar anuidades
        • Listar as anuidades
        • Cadastrar anuidades
      • Serviços Bancários
        • Registrar um boleto online
        • Listar pagamentos
        • Listar boleto completo
        • Listar contas habilitadas
      • Seguros
        • Seguros
          • Cancelar adesão do titular
          • Aderir seguro para o titular
          • Aderir seguro para dependente
          • Cancelar adesão do dependente
          • Listar seguros de dependentes
          • Listar seguros disponíveis
          • Cancelar um seguro
          • Listar seguros do portador
          • Listar campos de adesão ao seguro
          • Listar campos de adesão do portador
          • Listar seguros cancelados
        • Bilhetes de Seguro
          • Listar bilhetes de um portador
          • Listar o modelo de operação
          • Listar um bilhete de adesão
        • Cobranças e Pagamentos
          • Fazer estímulo de cobrança
        • Termos da Adesão
          • Listar termos de adesão
          • Listar modelos do código de operação
          • Listar termos de um seguro
      • SMS Notice
        • Processamento
          • Listar os eventos
          • Criar um evento
          • Alterar um evento
          • Listar as variáveis
          • Criar variáveis
          • Listar as transações
          • Criar mensagem para fila
        • Serviços
          • Criar um serviço de SMS
          • Listar serviços cadastrados
          • Alterar um serviço de SMS
          • Listar um serviço específico
        • Pacote de SMS
          • Listar os pacotes de sms
          • Cadastrar pacote SMS
          • Listar um pacote específico
          • Alterar um pacote específico
          • Aderir a um pacote SMS
          • Cancelar uma adesão
          • Listar adesões de um portador
          • Alterar o telefone do pacote
  1. APIs

Loja

A documentação deste serviço está em construção. Fique de olho nas nossas atualizações!
A API Loja faz parte do Agenda Lojista e permite o gerenciamento de estabelecimentos comerciais, incluindo a configuração de formas de pagamento, tarifas e consultas de parcelas.
Com essa API, é possível:
Cadastrar e gerenciar lojas.
Definir e associar tarifas às lojas.
Configurar formas de pagamento.
Consultar parcelas e acordos de pagamento.
Para utilizar os recursos da API, é necessário seguir uma jornada específica de cadastro e associação de dados, garantindo que todas as informações estejam devidamente registradas antes de realizar determinadas operações.

Exemplo de jornada#

Loja
Figura 1. Fluxo da API Loja
O fluxo básico de uso da API pode seguir esta sequência:
1.
Cadastrar uma loja: o primeiro passo é criar uma loja no sistema.
2.
Criar uma tarifa (opcional): caso a loja utilize tarifas, elas podem ser cadastradas separadamente.
3.
Associar a tarifa à loja: se houver tarifas cadastradas, elas podem ser vinculadas à loja.
4.
Gerenciar formas de pagamento: com a loja configurada, podem ser definidas as formas de pagamento aceitas.
5.
Consultar parcelas e acordos: a API permite acessar detalhes sobre parcelas e acordos de pagamento vinculados às lojas.
Esse fluxo garante que todas as operações sejam realizadas de maneira estruturada e eficiente, evitando inconsistências nos dados.

Endpoints#

Formas de pagamento
TipoEndpointDescrição
GET/api/v1/lojas/{id}/acordos-formas-pagamentosListar formas de pagamento
POST/api/v1/lojas/{id}/acordos-formas-pagamentosCadastrar forma de pagamento de uma loja
PATCH/api/v1/lojas/{id}/acordos-formas-pagamentosAtualizar forma de pagamento de uma loja
GET/api/v1/lojas/{id}/acordos-formas-pagamentos/quantidade-parcelas/{quantidadeParcelas}Consultar parcelas de uma loja
Lojas
TipoEndpointDescrição
POST/api/v1/lojasCadastrar 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/cnpjListar loja pelo CNPJ
GET/api/v1/lojas/cardsListar lojas
PATCH/api/v1/lojas/{idLoja}Alterar uma loja
Tarifas
TipoEndpointDescrição
GET/api/v1/lojas/{idLoja}/tarifas Listar tarifas por loja
POST/api/v1/lojas/{idLoja}/tarifasAssociar tarifa a uma loja
DELETE/api/v1/lojas/{idLoja}/tarifasCancelar tarifas com a loja
GET/api/v1/lojas/tarifasListar tarifas
POST/api/v1/lojas/tarifasCadastrar tarifa
GET/api/v1/lojas/tarifas/{id}Consultar uma tarifa
PATCH/api/v1/lojas/tarifas/{id}Alterar cadastro de uma tarifa

Casos de uso#

A seguir, detalhamos os principais casos de uso na jornada do Loja, explicando como cada operação é realizada através dos endpoints disponíveis.
Cadastrar uma loja
Serviço exclusivo para processadora Dock.
Use este o endpoint para cadastrar uma loja
Para cada nova requisição no Tote, é necessário alterar o idExterno, cnpj e inscricaoEstadual.
Exemplo de request body :
{
  "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": "rpe@rpe.tech",
  "observacao": "Modelo de response: cadastro de lojas.",
  "numeroEstabelecimento": 123456,
  "naturezaEstabelecimento": "PROPRIO"
}
Exemplo de response:
[
  {
    "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": "rpe@rpe.tech",
    "naturezaEstabelecimento": "PROPRIO",
    "numeroEstabelecimento": 123456,
    "observacao": "Modelo de response: cadastro de lojas."
  }
]
Criar uma tarifa
Serviço exclusivo para processadora Dock.
Use este endpoint para cadastrar uma nova tarifa.
Para criar uma nova tarifa, é necessário alterar o campo valor para fins de teste.
Exemplo de request body :
{
  "descricao": "Cadastro de teste para tarifa.",
  "valor": 30.59,
  "status": "ATIVO",
  "tipoCobranca": "DIA",
  "diaCobranca": 2,
  "utilizaValorIntervalado": true,
  "valorMinimo": 49.99,
  "valorMaximo": 200.99
}
Exemplo de response:
{
  "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.
Use este endpoint para associar tarifa a uma loja.
Para cada nova requisição no Tote, é necessário alterar o idExterno, cnpj e inscricaoEstadual.

Exemplo de requisição:#

Use Path parameter idLoja: 32 associar uma tarifa nesta loja.
Use o Query parameter 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
Use este endpoint para consultar uma loja.

Exemplo de requisição:#

Use Path parameter 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.

Serviços relacionados#

API Loja

Materiais relacionados#

Como testar endpoints através do Tote
Diretrizes básicas do Horizon
Respostas e possíveis erros
Página anterior
Estornar pagamento de baixa bancária
Próxima página
Listar formas de pagamento