Esse endpoint é utilizado para a geração de uma cobrança Pix.
A criação do Pix é sincrona, porém o registro na instituição financeira é realizada em segundo plano. Sendo assim, o retorno da requisição não irá conter o campo qrcode.
Para receber o qrcode é necessário assinar um webhook para receber o payload completo do Pix quando o registro for confirmado.
Pré-requisito
Para emitir uma cobrança Pix é necessário ter cadastrado em sua conta uma Conta Pix. Todo Pix pertence a uma Conta Pix que representa a instituição de pagamento e a chave que será usada para a emissão do Pix.
A criação da Conta Pix precisa ser feita pela interface web do sistema.
Eventos de Webhook
Ao cadastrar um Pix o sistema cria um comando para registrar o PIX na instituição financeira e o evento pix.register.started é disparado. Após o registro do Pix ser confirmado na instituição o evento pix.register.confirmed é disparado.
O evento pix.db.created também é disparado nesta operação.