Pix
Explore 3 endpoints de Pix, com finalidade, método e rota derivados do contrato publicado.
Endpoints relacionados
Abra um endpoint para consultar parâmetros, exemplos e respostas.
Quando usar cada endpoint
Compare a finalidade de cada operação antes de iniciar a integração.
| Endpoint | Finalidade |
|---|---|
POST/payment/pix/qrcode | Cria uma cobrança Pix na carteira informada. Exige credencial com permissão de Pix. 202 significa que o QR Code foi emitido (data.payload.qrCode) e a transação está em awaiting_payment; o pagamento só está confirmado quando a transação chega a completed — acompanhe pelo webhook ou pela consulta por externalId. |
POST/payment/pix/dict | Mostra o titular de uma chave Pix antes do envio, para você confirmar para quem o dinheiro vai. Não movimenta saldo. Exige credencial com permissão de Pix. O accountId é o accPixOut da carteira de origem (GET /resource/wallets/{walletId}). |
POST/payment/pix/send | Debita a carteira e envia um Pix para a chave informada. Exige credencial com permissão de Pix. 202 significa que o envio foi aceito e está em processing — não que o dinheiro chegou. O resultado final (completed ou failed) chega pelo webhook ou pela consulta por externalId. Em timeout, consulte antes de reenviar. |
Finalidades, métodos e rotas vêm do contrato OpenAPI publicado.
Fluxo da categoria
A ordem das chamadas, quem executa cada passo e o que vem depois. Clique numa chamada para ver o fluxo dela.
Receber
- Você
Mostre o Pix copia e cola
data.payload.qrCode, como texto ou imagem
- Pagador
Paga pelo app do banco
- Chamada
/resource/transactions/external-id/{externalId}Confirme o status antes de liberar o pedido
Enviar
- Você
Aprove o titular
Confira nome e documento antes de pagar