Documentação de API's 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. Banking as a Service - BaaS (Gestão de contas)
  • 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
  • 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
        • Gerar QR Code dinâmico para venda única
        • 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
    • Webhooks
      • Notificação de recebimento Pix
  1. Banking as a Service - BaaS (Gestão de contas)

Cartão pré-pago

O módulo de Cartão pré-Pago da Pinbank oferece aos seus clientes uma ferramenta poderosa para controle de gastos e inclusão financeira. Atrelado diretamente ao saldo da Conta Digital, o cartão permite que o usuário realize compras em estabelecimentos físicos e online utilizando a rede de aceitação da bandeira.
Seja para uso corporativo (gestão de despesas e frotas) ou para o consumidor final (mesada digital, viagens), este produto permite o gerenciamento em tempo real de limites, senhas e bloqueios de segurança, tudo via API.

Fluxo#

A jornada do usuário com o cartão pré-pago compreende as seguintes fases:
1.
Emissão: O usuário solicita um cartão físico ou gera um cartão virtual para uso imediato em e-commerce.
2.
Ativação: Após o recebimento do cartão físico, o usuário realiza a ativação segura para liberar o uso.
3.
Gestão de Limites: O administrador ou o próprio usuário define o teto de gastos para garantir o controle do orçamento.
4.
Uso e Monitoramento: Cada transação é registrada e pode ser consultada instantaneamente no extrato do cartão.
5.
Segurança e Manutenção: Em caso de perda ou necessidade de troca de senha, o usuário tem autonomia para realizar bloqueios e redefinições de credenciais.

Vantagens e diferenciais#

Cartão virtual instantâneo: Possibilita compras online logo após a abertura da conta, sem esperar pelo envio do plástico.
Trava de e-commerce: Camada adicional de segurança que permite habilitar ou desabilitar compras online conforme o desejo do usuário.
Controle de saldo: Por ser pré-pago, o risco de endividamento é zero, pois o gasto é limitado ao saldo ou limite pré-estabelecido.
Autonomia total: Redução de custos com suporte, permitindo que o usuário gerencie senhas e bloqueios pelo próprio App.

Jornada de integração#

Utilize os endpoints abaixo para gerenciar o ciclo de vida dos cartões:
Emissão e ativação
Solicitar emissão de cartão pré-pago: Inicia o processo de fabricação e envio do cartão físico para o endereço do cliente.
Solicitar cartão pré-pago virtual: Gera uma versão digital do cartão para compras online imediatas.
Confirmar ativação de cartão pré-pago: Finaliza o processo de desbloqueio do cartão físico para início do uso.
Gestão de limites e consulta
Listar cartões pré-pagos do cliente: Retorna todos os cartões (físicos e virtuais) vinculados ao CPF/CNPJ.
Consultar limite do cartão pré-pago: Verifica o teto de gastos configurado para o cartão.
Ajustar limite do cartão pré-pago: Define novos valores máximos de transação conforme a necessidade do usuário.
Listar transações do cartão pré-pago: Exibe o histórico detalhado de compras e utilizações do cartão.
Segurança e configurações
Bloquear uso do cartão pré-pago: Realiza o bloqueio temporário ou definitivo em caso de perda ou roubo.
Gerenciar trava de compras online (E-commerce): Ativa ou desativa a permissão para transações em lojas online.
Atualizar senha do cartão pré-pago: Permite a troca da senha atual por uma nova.
Redefinir senha do cartão pré-pago: Fluxo de recuperação de senha caso o usuário a tenha esquecido.
Modificado em 2026-06-16 00:04:16
Página anterior
Pagamentos e transferências
Próxima página
Pix (Cash-out)
Built with