POST /pix/send.
Quando usar
Como funciona o Enviar Pix
O envio nasce com statusCOMPLETE e o valor sai do saldo na hora. Quando o banco confirma, sai o webhook transfer.completed. Se o banco recusar, o envio passa para FAILED, o valor volta para o seu saldo e sai o transfer.failed.
Regras do Enviar Pix
- Mesmo saldo e mesmos limites do saque: o valor sai do saldo disponível (um saldo só por envio, se a conta recebe cartão), conta no limite diário e no limite noturno, das 20h às 8h, e respeita o intervalo de 30 segundos junto com os saques. As regras estão em Saques.
- Destino: qualquer chave Pix de outra pessoa ou empresa. Para mandar para uma conta no CPF ou CNPJ da sua própria empresa, use o saque.
- Taxa: sai do valor enviado. O destinatário recebe
amountmenosplatformFee. Para entregar um valor exato pela API, some a taxa aoamount. No dashboard, você digita quanto o destinatário recebe, e a tela soma a taxa. Os valores estão na página de preços e em Perfil → Taxas. - Valor mínimo na API: R$ 1,00 (
100). - Ativação: o Enviar Pix vem ativo nas contas. Se estiver desativado na sua, a API responde
Função não habilitada; fale com o suporte. - Ambiente: só existe em produção.
Tipos de chave Pix
Com
BR_CODE, o Pix vai para a chave que está dentro do código, com o amount que você enviar: o valor gravado no código não é usado. Só o Pix Copia e Cola estático funciona. O de cobrança (dinâmico) não traz a chave e é recusado.
Idempotência pelo externalId
Na API, o externalId é obrigatório e funciona como chave de idempotência. Se você repetir o POST com o mesmo externalId e o mesmo amount, por exemplo depois de um timeout, a API devolve o envio que já existe e não manda outro Pix. Com o mesmo externalId e outro amount, a API responde externalId já usado em outro envio com valor diferente.
Como enviar Pix pelo dashboard
1
Abra a tela de pagamentos
Vá em Financeiro → Pagamentos e clique em Novo pagamento no saldo de onde o dinheiro vai sair. A conta precisa ter a verificação em duas etapas (2FA) ativa.
2
Digite o valor
Em Valor do pagamento, digite quanto o destinatário vai receber. A tela mostra quanto você pode pagar agora, já com o saldo e os limites.
3
Informe o destinatário
Escolha o Tipo de chave Pix (CPF, CNPJ, e-mail, telefone, aleatória ou Pix Copia e Cola), preencha a chave e, se quiser, uma descrição de até 140 caracteres.
4
Confirme
Confira o resumo: quem recebe, O destinatário recebe, Taxa e Sai do seu saldo. Digite o código do autenticador (2FA) e clique em Realizar pagamento.
Como enviar Pix pela API
Chame Enviar Pix com uma chave de API que tenha a permissãoWITHDRAW:CREATE:
id (tran_...), o status, o amount, a taxa em platformFee e o link do comprovante em receiptUrl. A description não aceita emoji.
Para acompanhar, use Buscar Pix, pelo id ou pelo externalId, e Listar Pix, as duas com a permissão WITHDRAW:READ. Os erros de cada rota estão na página dela.
Notificações
Os eventos valem para os envios do dashboard e da API e trazem o mesmo
id e externalId da resposta. O formato está em Eventos de transferência. Para receber, configure um webhook.
Testar no Modo Teste
O Enviar Pix não tem simulação: ele só funciona em produção. No Modo Teste, o botão Novo pagamento abre um aviso explicando como passar para produção.Perguntas frequentes
Posso pagar um sócio da empresa?
Posso pagar um sócio da empresa?
Sim. O sócio é outra pessoa, então use o Enviar Pix. O saque vai só para contas no CPF ou CNPJ da própria conta.
Como faço o destinatário receber um valor exato?
Como faço o destinatário receber um valor exato?
No dashboard, digite o valor que ele deve receber: a tela soma a taxa. Na API, some a taxa ao
amount, porque ela sai do valor enviado.O que acontece se eu repetir a requisição?
O que acontece se eu repetir a requisição?
Com o mesmo
externalId e o mesmo amount, a API devolve o envio que já existe e não manda outro Pix. Com outro valor, a API recusa.Posso pagar um QR Code de cobrança?
Posso pagar um QR Code de cobrança?
Não. O Enviar Pix aceita só o Pix Copia e Cola estático, que traz a chave do destinatário. Para um código de cobrança, peça a chave Pix ao destinatário.
Onde fica o comprovante?
Onde fica o comprovante?
No dashboard, no botão Baixar recibo do histórico. Na API, no
receiptUrl da resposta.