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
Bem-vindo à documentação de APIs da Pinbank!
Copiar Página
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
Bem-vindo à documentação de APIs da Pinbank!
Copiar Página
3 - Autorizando as requisições
1
Parâmetros para autorização da *request*
Para validar a autorização de uma request, a API valida alguns parâmetros que devem ser enviados no
Header
da
request
.
Parâmetros utilizados para autorização
#
•
Authorization
→ Campo
token_type
+ campo
access_token
ambos retornados no passo
"2.3 - Gerar token OAuth2"
.
•
UserName
→ Campo
UserName
recebido na credencial
•
RequestOrigin
→ Campo
RequestOrigin
recebido na credencial
•
Content-Type
→
application/json
Exemplo POSTMAN
#
Segurança: Criptografia das requisições e respostas
#
Para garantir a máxima segurança, o corpo (
payload
) de todas as chamadas para a nossa API (requisições e respostas) é criptografado. Este padrão se aplica a
todos os ambientes
.
Modificado em
2026-06-16 00:04:16
Página anterior
2 - Gerando o token de acesso
Próxima página
4 - Consumindo uma API