Pix

Sobre o Pix

Entenda como utilizar o Pix na API BaaS da Nuvende

O módulo Pix da API BaaS permite realizar pagamentos instantâneos (cash-out) e gerenciar chaves Pix para recebimentos. O Pix é o sistema de pagamentos instantâneos do Banco Central do Brasil, permitindo transferências 24 horas por dia, 7 dias por semana.

Visão Geral

Através do módulo Pix você pode:

  • Realizar pagamentos Pix instantâneos (cash-out)
  • Pagar usando chave Pix (CPF, CNPJ, email, telefone, chave aleatória)
  • Pagar usando QR Code estático
  • Pagar usando QR Code dinâmico
  • Criar e gerenciar chaves Pix
  • Consultar informações de chaves Pix
  • Devolver um Pix recebido na conta

Tipos de Pagamento Pix

Cash-out por Chave Pix

Pagamentos realizados utilizando uma chave Pix do beneficiário. As chaves podem ser:

  • CPF: Documento de pessoa física
  • CNPJ: Documento de pessoa jurídica
  • Email: Endereço de e-mail válido
  • Telefone: Número de celular com DDD
  • Chave Aleatória (EVP): UUID gerado pelo sistema

Cash-out por QR Code Estático

Pagamentos realizados utilizando um QR Code estático, onde o valor é definido no momento do pagamento.

Cash-out por QR Code Dinâmico

Pagamentos realizados utilizando um QR Code dinâmico (payload), onde o valor e outras informações são definidos pelo recebedor.

Dados da conta

A maioria dos endpoints para Cash-out irá solicitador os dados do portador da chave Pix, seja ela CPF, EVP e afins. Para obter os dados do portador utilize o endpoint de Consulta de dados da chave


Gerenciamento de Chaves Pix

Você pode criar e gerenciar chaves Pix para receber pagamentos:

  • Criar Chave: Cadastrar uma nova chave Pix
  • Consultar Chave: Verificar informações de uma chave Pix
  • Excluir Chave: Remover uma chave Pix cadastrada

Autenticação

Todas as rotas Pix requerem:

  • Token JWT no header Authorization (autenticação auth:api)
  • Assinatura HMAC no header X-Signature (middleware hmac-signature)

Próximos Passos

Explore as funcionalidades do Pix:

  1. Cash-out por Chaves Pix
  2. Cash-out por QR Code Dinâmico
  3. Gerenciamento de Chaves

2025 © Nuvende - CNPJ 38.297.374/0001-93