Saltar al contenido principal

Crear un Pix

POST 
/v2/charge/pix

Este endpoint se utiliza para la generación de un cobro Pix.

La creación del Pix es síncrona, pero el registro en la institución financiera se realiza en segundo plano. Por lo tanto, la respuesta de la solicitud no contendrá el campo qrcode.

Para recibir el qrcode es necesario suscribirse a un webhook para recibir el payload completo del Pix cuando el registro sea confirmado.

Requisito previo​

Para emitir un cobro Pix es necesario tener registrada en su cuenta una Cuenta Pix. Todo Pix pertenece a una Cuenta Pix que representa la institución de pagos y la clave que se utilizará para la emisión del Pix. La creación de la Cuenta Pix necesita hacerse a través de la interfaz web del sistema o mediante el endpoint POST /api/v2/charge/pix_accounts.

Eventos de Webhook​

Al registrar un Pix el sistema crea un comando para registrar el PIX en la institución financiera y el evento pix.register.requested es disparado. Después de que el registro del Pix sea confirmado en la institución el evento pix.register.confirmed es disparado.

El evento pix.db.created también es disparado en esta operación.

Request​

Responses​

Pix creado con datos de cliente