Documentação de APIs Pinbank
Início
Primeiros Passos
Primeiros Passos
  • Guia
  • Obtendo suas Credenciais
  • Gerando o Access Token
  • Autorizando as Requisições
  • Consumindo uma API
Gateway de Pagamentos
Gateway de Pagamentos
  • Introdução
  • Cartão
  • Boleto
  • Pix
Início
Primeiros Passos
Primeiros Passos
  • Guia
  • Obtendo suas Credenciais
  • Gerando o Access Token
  • Autorizando as Requisições
  • Consumindo uma API
Gateway de Pagamentos
Gateway de Pagamentos
  • Introdução
  • Cartão
  • Boleto
  • Pix
Pinbank
LinkedIn
Instagram
Youtube
  1. Webhooks
  • Bem-vindo à documentação de APIs da Pinbank!
    • Primeiros passos
    • 1 - Obtendo suas credenciais
    • 2 - Gerando o token de acesso
    • 3 - Autorizando as requisições
    • 4 - Consumindo uma API
  • Autenticação e segurança
  • Gateway de pagamentos
    • Cartão
    • Boleto
    • Pix
    • Pix automático
    • Link de pagamento
  • Banking as a Service - BaaS (Gestão de contas)
    • Onboarding e KYC
    • Gestão de saldo e extrato
    • Pagamentos e transferências
    • Cartão pré-pago
  • Pix (Cash-out)
    • Pagamentos e transferências
    • Pagamentos com Pix automático
  • Webhooks
    • Introdução
    • Configurando o webhook
    • Estrutura da entrega (envelope)
    • Autenticidade da mensagem
    • Política de Reenvio
    • Eventos
    • Códigos de Erro
    • Checklist de Integração
  • Especificações técnicas
    • Autenticação
      • Gerar token de acesso
    • Cartão
      • Processar pagamento avulso (Dados diretos)
      • Cancelar transação
      • Gerar extrato consolidado de vendas (POS/e-commerce)
      • Processar pagamento com split de valores
      • Cancelar transação com split de valores
      • Processar pagamento com cartão tokenizado salvo
      • Cadastrar cartão (tokenizado) para compras futuras
      • Remover cartão tokenizado
      • Recuperar dados sensíveis do cartão
      • Listar cartões tokenizados do cliente
      • Processar pagamento recorrente com split
      • Confirmar ativação de cartão (PIN/Protocolo)
    • Boleto
      • RegistrarBoletoDda
      • Gerar boleto de cobrança
      • Emitir boleto com split de valores
      • Consultar o status de um boleto
      • Consultar boletos em lote
      • Obter métricas e indicadores de cobrança
      • Cancelar cobrança via boleto
    • Link de pagamento
      • Gerar um link de pagamento
    • Conta digital
      • Recuperar termos de uso para aceite formal
      • Iniciar onboarding de Mini EC
      • Iniciar onboarding de cliente (PF)
      • Iniciar onboarding de empresa (PJ)
      • Consultar dados da conta
      • Listar novos clientes ativados por período
      • Fazer upload de documentos de identificação
      • Verificar inventário e pendências de documentos
      • Substituir documento reprovado ou expirado
      • Consultar status dos documentos
      • Gerar boleto de recarga de conta
      • Consultar saldo disponível na conta
      • Consultar extrato da conta
      • Consultar comprovante detalhado de transação
    • Cartão pré-pago
      • Solicitar emissão de cartão pré-pago
      • Confirmar ativação de cartão pré-pago
      • Consultar limite do cartão pré-pago
      • Ajustar limite do cartão pré-pago
      • Listar cartões pré-pagos do cliente
      • Listar transações do cartão pré-pago
      • Bloquear uso do cartão pré-pago
      • Solicitar cartão pré-pago virtual
      • Redefinir senha do cartão pré-pago
      • Atualizar senha do cartão pré-pago
      • Gerenciar trava de compras online (E-commerce)
    • Pix
      • Cash-in
        • Solicitar estorno parcial ou integral de um Pix
        • Verificar status do estorno de um Pix (Assíncrono)
        • Gerar QR Code dinâmico ou composto com recorrência
        • Consultar status e dados de um QR Code dinâmico
        • Invalidar QR Code dinâmico de cobrança Pix pendente
        • Decodificar QR Code ou Chave Pix
      • Cash-out
        • Confirmar liquidação de um Pix
        • Consultar Pix por lote ou identificador
        • Cadastrar agendamento de um Pix
        • Cadastrar novo favorecido para Pix
        • Consultar a lista de favorecidos para Pix
        • Remover favorecido para Pix
      • Pix automático (Cash-in)
        • Propor adesão ao Pix Automático (Push)
        • Listar contratos de Pix Automático
        • Lançar parcela de Pix Automático
        • Consultar um contrato de Pix Automático
        • Cancelar um agendamento de pagamento de parcela do Pix Automático
        • Cancelar um contrato de Pix Automático
        • Projetar data do próximo débito recorrente
        • Calcular último pagamento
      • Pix automático (Cash-out)
        • Cadastrar recorrência via QR Code
        • Atualizar status de uma recorrência
        • Listar recorrências cadastradas e/ou canceladas
        • Consultar dados de uma recorrência
        • Editar uma recorrência cadastrada
        • Cancelar uma recorrência cadastrada
        • Listar pagamentos agendados, pagos ou cancelados
        • Consultar um agendamento
        • Cancelar um agendamento de pagamento da recorrência
    • Pagamentos e transferências (TED)
      • Transferir saldo internamente (P2P)
      • Solicitar retirada de fundos via TED
      • Rastrear liquidação ou devolução de TED
      • Registrar TED para aprovação posterior
      • Listar TEDs por status ou referência
      • Cancelar TED
      • Autorizar TED pré-cadastrada
      • Validar linha digitável de boleto (CIP)
      • Liquidar boleto ou conta de consumo
      • Liquidar impostos e taxas governamentais
      • Listar pagamentos agendados
      • Cadastrar novo favorecido para TED
      • Consultar a lista de favorecidos para TED
      • Remover favorecido para TED
  1. Webhooks

Códigos de Erro

Abaixo seguem os códigos de erro de referência para diversos domínios de integração do Pinbank.
As mensagens abaixo são explicativas, para facilitar o entendimento humano do erro. Elas não refletem necessariamente o texto literal retornado pelo sistema. Para lógica de integração (tratamento condicional, retries, etc.), utilize sempre o código, não o texto da mensagem.

Conta Digital (Gestão de Contas)#

DomínioEventoDescrição
Conta DigitalContaDigital.CadastroPfResultado do cadastro de pessoa física/jurídica — cobre sucesso e erro.
Conta DigitalContaDigital.ValidacaoClienteResultado da validação de disponibilidade de um dado (CPF, e-mail, celular) — dispara em toda tentativa, sucesso ou falha.
Conta DigitalContaDigital.AlteracaoStatusStatus da conta foi alterado.
CódigoMensagem (pt-BR)
1Sem resultado.
2Erro de Sistema.
3Erro de validação.
4Tamanho do Apelido inválido.
5Apelido já cadastrado.
5Usuário ou Senha inválido.
6Usuário bloqueado.
10Atualizar ramo de atividade.
13Número de celular inválido.
17Email inválido.
18Senha muito fraca.
19Código de verificação expirado.
20Arquivo inválido.
21Documento já cadastrado.
23Documento não encontrado.
24Este documento não pode ser alterado.
27Erro ao buscar dados do CEP.
28Número de celular inválido.
29Erro ao enviar SMS.
33Documentação da conta do cliente não aprovada.
40Data de nascimento inválida.
41Número de celular não informado.
41CPF / CNPJ inválido.
42Número de Celular inválido.
43Erro ao consultar serviço de verificação de documentos.
52Termo não encontrado
53O tipo não é um arquivo
54Celular, ddd e ddi é obrigatório para envio do Token
55Email e obrigatório para envio do Token
58Conta não aprovada.
62Conta inexistente, favor verificar dado informado.
64Não localizamos a documentação em seu cadastro. Envie os documentos pendentes pelo canal digital, na área de dados cadastrais.
65Existem documentos não aprovados em seu cadastro. Remova o documento reprovado e envie um novo pelo canal digital, na área de dados cadastrais.
66Sua documentação está em análise. O resultado será enviado por e-mail.
84IdentificadorFace não encontrado.
85Não foi possível concluir o cadastro. Dados incompletos.
86O serviço de verificação facial está temporariamente indisponível. Tente novamente mais tarde.
87Não foi possível validar seu rosto no momento. Tente novamente mais tarde.
88Perfil não aprovado.
89Nome inválido.
422Documento com restrição de cadastro no BCProtege+

PIX#

DomínioEventoDescrição
PixPix.CreditoRecebidoUm Pix foi recebido e confirmado na conta digital de um cliente.
PixPix.TransferenciaRealizadaResultado do processamento de uma transferência Pix enviada por um cliente — cobre sucesso e falha.
PixPix.DevolucaoEnviadaConfirmação do Bacen sobre uma devolução Pix enviada por um cliente (cliente = pagador da devolução).
PixPix.DevolucaoRecebidaDevolução Pix processada e creditada na conta de um cliente (cliente = recebedor da devolução).

QR Code#

CódigoMensagem (pt-BR)
1Erro de Sistema.
2Erro de validação.
4Usuário bloqueado.
5Usuário não encontrado.
6CodigoCanal não encontrado.
7Documentação da conta do cliente não aprovada.
8Sem resultado.

Pagamento#

CódigoMensagem (pt-BR)
1Código Cliente null ou vazio.
1Erro de Sistema.
2Código Canal null ou vazio.
2Erro de validação.
3Apelido não informado.
4Usuário bloqueado.
4Tamanho do Apelido inválido.
5Código do banco não informado.
5Usuário não encontrado.
6CodigoCanal não encontrado.
6Código do banco inválido.
7Documentação da conta do cliente não aprovada.
7Agência não informada.
8Sem resultado.
8Agência inválida.
9O dígito da agência é requerido para o banco selecionado.
9Pix QrCode pendente.
10Dígito da agência inválido.
10Pix QrCode erro.
11Conta Corrente não informado.
11Pinbank QrCode id não encontrado.
12Dígito da conta corrente não informado.
12NsuOrigem não informado.
13Dígito da conta corrente inválido.
13QrCode cancelado timeout.
14Tipo da Conta não informado.
14Erro ao buscar informações do QrCode.
15Autorização negada.
15Tipo Pessoa não informado.
16Nome do Favorecido não informado.
16Limite máximo não definido.
17CPF / CNPJ do favorecido não informado.
17Nenhuma chave ativa encontrada. Por favor cadastre uma chave para realizar esta operação.
18Código do banco inválido.
18CPF / CNPJ do favorecido inválido.
19CPF / CNPJ do favorecido inválido para o Tipo Pessoa informado.
19Operação cancelada TimeOut.
20Apelido já cadastrado.
20URL de webhook não cadastrada. Favor contactar seu agente comercial.
21Favorecido já cadastrado.
21Operação não permitida. Por favor, realize o login novamente.
22Lista de favorecidos não informada.
22Propriedade Token null ou vazio.
23Favorecido inválido
23Token inválido.
24Operação pendente.
25Valor do PIX não informado
26O agendamento máximo permitido é de até 12 meses.
27Limites pix em analise, por favor aguarde.
28Para pix agendados só é permitida a aprovação até as [hour]h
29Status do Pix inválido ou não reconhecido.
30Não é permitido solicitar agendamentos para o dia seguinte após as 23:30h.
31Retorno de PIX não permitido
32Identificador de referência não encontrado
33Valor devolução PIX não disponível
34Chave pix do destinatário não localizada.
35Data limite para devolução Pix finalizada
36Valor não permitido para devolução.
37A sua conta ainda não tem chave pix cadastrastrada. Cadastre sua chave antes.
38Devolução não permitida para Pix origem Boleto.
39Você ainda não tem nenhum contato favorito cadastrado.
40Horário noturno Pix inicial inválido.
41Horário noturno Pix já configurado.
42Já existe uma solicitação de alteração do horário noturno em andamento.
43Não existe nenhuma solicitação de alteração de horário noturno no momento.
44Limite pix diurno em analise, por favor aguarde.
45Limite pix noturno em analise, por favor aguarde.
46Limite pix domingos e feriados em analise, por favor aguarde.
47Pagamento duplicado identificado em curto intervalo de tempo. Aguarde antes de tentar novamente.
48Devolução não permitida
49Operacao não permitida para outra titularidade.
50Transação de dupla aprovação não encontrada.
51Operação de dupla aprovação inválida.
52Horario de limite inválido.
53Horário máximo para esta operação ultrapassado.
54Categoria Limite Pix não encontrada
55Tarifas limites PIX não encontrada
56END2END não encontrado
57Chave PIX inválida
58Texto Qrcode não permitido para o tipo de pagamento do agendamento
59Dados bancarios não permitido para o tipo de pagamento do agendamento
60Chave não permitida para o tipo de pagamento do agendamento
70Erro ao buscar chave pix.
77Autorização negada. Verifique o saldo disponível.
78MiniEc não permitido.
79CPF / CNPJ inválido.
80Key Owner Name é obrigatório.
81Descrição da Recorrencia não informada.
82Quantidade de Parcelas da Recorrencia não informada.
83Periodicidade da Recorrencia não informada.
84key Owner CpfCnpj inválido.
85Data da primeira parcela inválida. Deve ser informada uma data futura válida para a primeira parcela.
86É permitido até 30 repetições de agendamento recorrente.
87Ocorreu um erro ao gerar o Pix Automático.
1001Sua solicitação foi recebida e aguarda aprovação Master

Pix Automático#

CódigoMensagem (pt-BR)
23PisoValorMaximo cannot be filled in fixed value authorizations.
24Se o devedor for igual ao pagador, os campos do devedor não devem ser preenchidos.
25Recorrência não encontrada.
26A data de vencimento deve ter no mínimo 2 dias de antecedência em relação à data atual.
27Período indisponível: já há um agendamento cadastrado.
28Como a recorrência foi criada com valor fixo, não é permitido informar valores individuais nos agendamentos.
29Agendamento já cancelado, pago ou inativo.
30O identificador do consentimento (RecurringConsentId) é inválido. Deve ser um URN válido (RFC8141).

Consulta de Chave#

CódigoMensagem (pt-BR)
0Sucesso.
1Erro de Sistema.
2Erro de validação.
3Bad request.
4Usuário bloqueado.
5Usuário não encontrado.
6CodigoCanal não encontrado.
7Documentação da conta do cliente não aprovada.
8Sem resultado.
9Agência ou número de conta não encontrado.
10Erro ao enviar SMS.
11Código Cliente null ou vazio.
12Código Canal null ou vazio.
13CPF / CNPJ não informado.
14Esta chave já está cadastrada em sua conta.
15Registro da chave Pix negado.
16Identificador de pagamento não encontrado no agente emissor ou data de pesquisa inválida. Verifique a data no comprovante de pagamento.
17Não foi possível localizar um ID de QrCode para este End-to-end (NuOp)
18Tipo de chave não permitido.
19Termo não encontrado
20Chave PIX enviada não consta no cadastro
21Já existe vínculo para essa chave mas ela é possuída por outra pessoa. Indica-se que seja feita uma reivindicação de posse.
22Já existe vínculo para essa chave com o mesmo dono, mas ela encontra-se associada a outro participante. Indica-se que seja feita uma reivindicação de portabilidade.
23Chave em processo de Reivindicação.
24Reivindicação não encontrada para essa chave.
25Esta chave não está em processo de reivindicação.
26Erro ao cancelar a reivindicação da chave.
27Confirmação não permitida.
28Erro ao solicitar a reivindicação
29Operação não permitida: o prazo para cancelamento já expirou.
30Este e-mail já está associado a outro CPF/CNPJ e não é permitida a reivindicação de posse de chave Pix do tipo e-mail.
31Erro ao consultar dados do CPF em serviço externo.
32Erro ao consultar dados do CNPJ em serviço externo.
Modificado em 2026-09-30 13:37:53
Página anterior
Eventos
Próxima página
Checklist de Integração
Built with