Tote
InícioIntegraSaiba mais
InícioIntegraSaiba mais
  1. Manuais
  • 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. Manuais

Respostas e status

Utilizamos códigos de resposta HTTP para indicar se a requisição da API foi bem sucedida ou possui algum erro.

Status code e signficados#

HTTP status codeMensagemSignificado
200OKSolicitação bem sucedida.
201CreatedUm novo recurso foi criado no servidor.
204No ContentSolicitação bem sucedida que retorna uma resposta sem conteúdo, sendo a informação armazenada em cache.
400Bad RequestA solicitação não pode ser processada devido a um erro de escrita ou nos dados de entrada.
401UnauthorizedOcorreu falha na autenticação e o usuário não possui autorização para acessar essas informações.
403ForbiddenO usuário está autenticado mas as credenciais de autenticação não são suficientes para acessar o recurso solicitado.
404Not FoundNenhuma informação associada aos dados de entrada foi encontrada.
409ConflictO servidor não pode concluir a solicitação devido a um conflito com o recurso de destino.
412Precondition failedA solicitação não pode ser concluída porque alguns prerequisitos não foram cumpridos.
422Unprocessable EntityO servidor não consegue processar a requisição apesar das informações estarem corretas.
500Internal Server ErrorProblemas com os nossos servidores. Ocorrem em baixa frequência.
504Gateway timeoutO servidor, agindo como gateway ou proxy, não conseguiu uma resposta de outro servidor dentro do tempo determinado para completar a requisição.
CORSCross-Origin Resource SharingMecanismo que permite uma página acessar o recursos de outro domínio. Erro de CORS indica que o servidor não autorizou a página a acessar estes recursos porque alguma informação de cabeçalho não está compatível com as configurações.

Códigos de resposta#

Códigos de resposta 2xx#

Códigos de resposta 2xx significam sucesso na requisição.

200 OK#

O código 200 aponta uma solicitação bem sucedida.
{
  "mensagem": "Segue o valor da fatura de jan 2023: R$124,33",
  "numeroCelular": "+5583900000000",
  "resposta": "Requisição recebida. O SMS será processado em instantes."
}

201 Created#

O código 201 significa que um novo recurso foi criado no servidor. Abaixo, exemplo de pessoa dependente cadastrada no banco de dados de um emissor.

{
  "idGrauParentesco": 5,
  "idDependente": 9999,
  "telefone": "83999999999",
  "cpf": "99999999999",
  "idClienteTitularAssociado": 999999,
  "nome": "PORTADOR DA FICCAO",
  "nomeSocial": "string",
  "dataNascimento": "1990-02-16",
  "sexo": "M",
  "nomeMae": "MAE DO PORTADOR",
  "status": "A"
}

204 No content#

O código 204, apesar de não retornar nenhum texto ou resposta, indica que a requisição foi processada com sucesso. Abaixo, exemplo de sucesso na vipagem de um portador.
204.png
Figura 1. Exemplo de response de sucesso com código 204 No Content

Códigos de resposta 4xx#

Códigos de resposta 4xx são causados por problemas nos dados informados durante a requisição.

400 Bad Request#

O erro 400 indica que a solicitação enviada pelo cliente ao servidor contém algum tipo de erro ou está malformada, o que impede o servidor de processá-la.
{
    "timestamp": "2024-08-08T13:47:43.358454549",
    "statusCode": 400,
    "message": "ARGUMENTO_INVALIDO",
    "path": "/api/v1/broker/sms",
    "fieldErrors": [
        {
            "objectName": "smsRequest",
            "field": "numeroCelular",
            "message": "campo deve possuir o tamanho entre 11 e 11"
        }
    ]
}
{
  "timestamp": "2024-08-01T09:42:09.508611519",
  "statusCode": 400,
  "message": "Cartão não encontrado para o codigo informado.",
  "path": "/api/v1/cartoes/segunda-via"
}
Erro 400 ao utilizar ambientes#
O erro 400 também ocorre quando a cURL não está de acordo com o ambiente. Se uma cURL do ambiente de homologação (-hml) for aplicada no ambiente de Sandbox (-sb) o endpoint retornará um 400.
As cURLs do Tote são para o ambiente de Sandbox (-sb). Não é recomendado utilizá-las no ambiente de homologação (-hml)!
erro-sb-curl.png
Figura 2. Erro 400 por utilizar cURL do ambiente de homologação num ambiente de Sandbox.

401 Unauthorized#

O erro 401 indica que a solicitação feita pelo cliente não foi autorizada porque as credenciais de autenticação não são válidas para acessar o recurso solicitado.
{
    "timestamp": "2024-08-08T11:11:16.061-03:00",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/v1/portuno/accounts"
}
Problemas na autenticação? Leia o artigo de autenticação para mais informações.

403 Forbidden#

O erro 403 indica que o cliente não tem permissão para acessar o recurso solicitado porque as credenciais de autenticação são inválidas ou expiraram.
{
    "timestamp": "2024-08-08T11:11:16.061-03:00",
    "status": 403,
    "error": "Forbidden",
    "path": "/api/v1/portuno/accounts"
}
Problemas na autenticação? Leia o artigo de autenticação para mais informações.

404 Not Found#

O erro 404 indica que o servidor não conseguiu encontrar o recurso solicitado pelo cliente.
{
  "timestamp": "2024-07-08T16:21:34.774500834",
  "statusCode": 404,
  "message": "Recurso não encontrado (Account).",
  "path": "/api/v1/recompensas/portador/201/anuidade/adesao"
}

409 Conflict#

O erro 409 indica que houve algum tipo de conflito durante a requisição. Abaixo, um exemplo onde um mesmo número de CNPJ está sendo informado para duas lojas diferentes.
{
  "timestamp": "2024-07-04T16:54:59.388429838",
  "status": 409,
  "message": "Atributo repetido. O CNPJ informado é utilizado por outra loja.",
  "path": "/api/v1/lojas"
}

422 Unprocessable Entity#

O erro 422 significa que as informações na requisição estão corretas porém o servidor não consegue completar a solicitação.

{
  "timestamp": "025-07-08T16:21:34.774500834",
  "status": 422,
  "error": "Unprocessable Entity",
  "path": "/api/v1/seguros/termos/portador/2001/adesao/1"
}

Códigos de resposta 5xx#

Códigos de resposta 5xx apontam erros no servidor:

500 Internal Server Error#

O erro 500 indica que ocorreu um problema inesperado no servidor, impedindo de processar a solicitação.
{
  "timestamp": "2024-07-08T19:16:19.626+00:00",
  "status": 500,
  "error": "Internal Server Error",
  "path": "/api/v1/recompensas/portador//anuidade/cancelamento"
}
Leia cuidadosamente a mensagem de erro fornecida pela API. Ela contém informações úteis sobre o que deu errado e como resolver o problema. Preste atenção em palavras-chave e detalhes específicos mencionados na mensagem.

Soluções de erros#

Status codeURL do erroDescrição do erroSolução
400/api/v1/faturamentos/parcelamento/2002/antecipacaoNúmero do id não está cadastrado (2002).Cheque qual id foi cadastrada para esse serviço.
400-Sem corpo de respostaProvável timeout, cheque sua conexão e as informações do endpoint.
400/api/v1/faturamentos/parcelamento/x/antecipacao/totalTipo do id inválido. Geralmente acompanhado da mensagem: "O tipo do campo deve ser: Long"Cheque qual o tipo da id cadastrada para esse serviço.
401-"Unauthorized"Sem autorização para usar a plataforma porque as credenciais são inválidas para o serviço em questão.Verifique as informações de autenticação
401/api/v1/cartoes/vipagem/2001/reemissaEndpoint escrito erradoRevise a escrita do path do enpoint e tente novamente.
403"Forbidden"Sem autorização para usar a plataforma porque as credenciais são inválidas, não foram informadas ou expiraram.Verifique as informações de autenticação
404/api/v1/faturamentos/faturas/antecipacao/simulacaoNão foi possível encontrar a resposta porque o campo idParcelamentoFatura não está preenchido.Revise a escrita do endpoint e verifique qual id foi cadastrada para esse serviço.
409api/v1/lojas/9/acordos-formas-pagamentosAtributo repetidoNúmero do id já foi cadastrado para outro cliente.
412/api/v1/seguros/adesaoPrerequisito não cumpridoNúmero de CPF não corresponde ao portador cadastrado.
500"Network Error occurred."Erro interno do servidorVerifique a conexão com a internet, cheque se o serviço está disponível na plataforma. Se todas as informações acima estiverem corretas, é um possível problema de CORS. Contate nosso time.
504"Gateway timeout"Tempo limite do gateway atingidoEspere um pouco e tente novamente. Se o erro persistir, contate nosso time.
-CORSCross-Origin Resource SharingFaça a limpeza do cache do seu navegador (cada navegador possui suas próprias instruções de como fazer isto) e tente novamente.

Materiais relacionados#

Visão geral da plataforma
Glossário
Testando APIs
Precisa de mais ajuda? Entre em contato com o nosso suporte.

Clique no botão abaixo para nos contar o que achou da nova plataforma. Você será redirecionado para um formulário rápido.
Enviar feedback
Página anterior
Como se autenticar
Próxima página
Nossas APIs