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. Pix (Cash-out)
  • 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. Pix (Cash-out)

Pagamentos com Pix automático

O módulo de Pix automático para o pagador permite que os usuários de contas digitais Pinbank gerenciem suas autorizações de pagamentos recorrentes. Esta funcionalidade automatiza a saída de recursos para o pagamento de contas frequentes, como mensalidades e assinaturas, garantindo que os compromissos financeiros sejam honrados sem a necessidade de intervenção manual a cada vencimento. Para mais detalhes sobre as definições normativas, consulte a página oficial do Banco Central - Pix Automático e o guia para Pagadores.
Para o usuário pagador, o Pix Automático oferece conveniência e controle, permitindo aceitar novas solicitações, editar limites de valor para os débitos e cancelar autorizações a qualquer momento.

Fluxo#

A jornada do pagador dentro do Pix Automático segue as etapas de gestão e controle:
1.
Adesão via QR Code: O usuário pode iniciar uma nova recorrência realizando a leitura de um QR Code de autorização fornecido por um recebedor.
2.
Gestão de solicitações: Caso o recebedor envie uma proposta de recorrência direta, o pagador deve aceitar ou recusar a solicitação no seu ambiente logado.
3.
Configuração de limites: O pagador tem a liberdade de editar a recorrência para definir um valor máximo (piso) permitido para os débitos automáticos.
4.
Monitoramento de agendamentos: O sistema gera agendamentos automáticos baseados na periodicidade acordada. O usuário pode listar e consultar cada parcela individualmente.
5.
Cancelamento: A qualquer momento, o pagador pode interromper o fluxo de pagamentos futuros cancelando a recorrência ou um agendamento específico.

Vantagens e diferenciais#

Automação financeira: Elimina o risco de esquecimento e atrasos em contas recorrentes.
Controle total: O usuário decide o limite de valor e pode revogar a autorização instantaneamente.
Transparência: Histórico detalhado de todas as recorrências ativas, pendentes e canceladas.
Segurança: Fluxo de aprovação integrado que exige a validação do usuário para novas adesões.

Jornada de integração#

Utilize os endpoints abaixo para gerenciar o fluxo de saída recorrente do pagador:
Gestão de autorizações (Recorrências)
Cadastrar recorrência via QR Code: Inicia uma nova autorização de Pix Automático a partir da leitura de um QR Code.
Atualizar status de uma recorrência: Permite ao pagador dar o consentimento (aprovar) ou rejeitar uma proposta de pagamento recorrente enviada por um recebedor.
Listar recorrências cadastradas e/ou canceladas: Retorna todas as autorizações vinculadas ao usuário, permitindo filtrar por status (Aceitos ou Pendentes).
Consultar dados de uma recorrência: Obtém os detalhes completos de uma autorização específica, incluindo periodicidade, valores e dados do recebedor.
Editar uma recorrência cadastrada: Permite ao pagador alterar configurações da autorização, como definir um valor máximo permitido para os débitos.
Cancelar uma recorrência cadastrada: Revoga permanentemente a autorização de débito automático para um contrato.
Gestão de pagamentos (Agendamentos)
Listar pagamentos agendados, pagos ou cancelados: Exibe a lista de pagamentos programados, realizados ou cancelados vinculados às recorrências do usuário.
Consultar um agendamento: Detalha uma parcela específica de pagamento, informando o status da efetivação e valores.
Cancelar um agendamento de pagamento da recorrência: Interrompe o pagamento de uma parcela agendada específica sem cancelar a recorrência principal.
Modificado em 2026-06-16 00:04:16
Página anterior
Pagamentos e transferências
Próxima página
Introdução
Built with