Crea un BR Code estático
Usa Crear BR Code estático cuando necesites un BR Code reutilizable. El recurso devuelto contiene el payload de pago codificado. Conserva su identificador y usa Obtener BR Code estático o Listar BR Codes estáticos para recuperarlo más adelante. Un BR Code estático no es un registro de liquidación de un cobro. Usa un cobro cuando necesites seguir el ciclo de vida de un cargo.Decodifica un código QR
Decodificar código QR lee un payload EMV. En un cobro inmediato,amountChangeAllowed es true cuando el receptor permite que el pagador cambie el monto: el monto es entonces solo una sugerencia. hasRecurrence es true cuando el código QR también ofrece una recurrencia de Pix Automático, y recurrenceLocation trae su ubicación. Un código QR solo de recurrencia se decodifica como STATIC, sin clave y sin monto, y no se puede pagar. Para autorizar la recurrencia, envía el mismo payload a Crear solicitud de autorización desde un código QR. El campo opcional paymentDate fija el precio de un cobro con fecha de vencimiento para ese día, y budgetMs limita el tiempo que puede tardar la lectura del receptor.
Crea un cobro inmediato
- Llama a Crear cobro inmediato con un valor de idempotencia nuevo.
- Guarda el identificador del cobro, el payload del BR Code, la ubicación y el vencimiento que devuelve la API.
- Léelo mediante Obtener cobro inmediato o Listar cobros inmediatos.
- Con
MOCK_TEST_ENDPOINTS_ENABLED=true, el proveedor mock puede simular un pago. Su callback registra el pago solo cuando su importe coincide con el importe del cobro inmediato. Un callback idéntico es una repetición segura. Un callback con datos de pago en conflicto no es una repetición segura. - Si el cargo debe terminar sin pago, usa Cancelar cobro inmediato. Cancelar un cobro ya cancelado devuelve el resultado terminal existente.
Crea un cobro con fecha de vencimiento
Un cobro con fecha de vencimiento requiere el calendario de vencimientos y los datos del deudor. También puede incluir modificadores de valor, como multa, intereses, bonificación o descuento.- Llama a Crear cobro con fecha de vencimiento. El plugin valida la clave Pix antes de crear el cobro.
- Guarda el identificador y el payload de pago. Léelo con Obtener cobro con fecha de vencimiento o encuéntralo mediante Listar cobros con fecha de vencimiento.
- Aplica solo el contrato documentado de revisión de vencimiento cuando deba cambiar un modificador de valor permitido. Usa JSON Merge Patch. No envíes un cuerpo de reemplazo completo de forma predeterminada.
- Cancela mediante Cancelar cobro con fecha de vencimiento cuando el cobro ya no deba poder pagarse.