X-Account-Id.
Entradas y claves
Una entrada es una clave Pix registrada en una de tus cuentas. El plugin resuelve la cuenta subyacente y los datos del titular desde CRM, por lo que creas entradas por tipo de clave en lugar de proporcionar los detalles de la cuenta directamente. Tipos de clave admitidos:
| Tipo | Origen del valor |
|---|---|
CPF | Derivado automáticamente del documento del titular en CRM (no envíes key) |
CNPJ | Derivado automáticamente del documento del titular en CRM (no envíes key) |
EMAIL | Proporcionado en la solicitud (email válido, ≤ 77 caracteres) |
PHONE | Proporcionado en la solicitud (^\+[1-9]\d{1,14}$) |
EVP | UUID aleatorio generado por el sistema (no envíes key) |
/v1/dict/entries). La creación/eliminación de entradas valida contra los reclamos activos y la consistencia entre la clave y el documento del titular (por ejemplo, una clave CPF debe coincidir con el CPF del titular).
El plugin no valida las claves con la Receita Federal ni realiza verificaciones de titularidad MFA: asume que el cliente las completó antes de la llamada. Consulta la guía de integración para conocer los requisitos previos.
GET /v1/dict/keys/{key}) resuelven una clave con fines de pago, devolviendo el propietario actual y la cuenta para que puedas iniciar un pago. Usa el header opcional X-EndToEnd-Id para el seguimiento del pago, y POST /v1/dict/keys/check para verificar la existencia de forma masiva. El plugin devuelve los datos tal como los recibe de BTG; enmascarar los campos sensibles antes de mostrarlos es responsabilidad del cliente.
Referencia: Create entry · List · Retrieve · Update · Delete · Retrieve a key · Check keys
Reclamos: portabilidad y titularidad
Un reclamo transfiere una clave Pix entre instituciones. Hay dos tipos:
- PORTABILITY — mueve una clave a otro banco para el mismo titular. Permitido para
CPF,CNPJ,PHONEyEMAIL. - OWNERSHIP — reclama una clave de una persona diferente. Permitido solo para
PHONE.
X-Account-Id; claimerParticipant y donorParticipant los establece BTG automáticamente.
Ciclo de vida del reclamo
| Estado | Significado |
|---|---|
OPEN | Reclamo creado; a la espera del reconocimiento del donante |
WAITING_RESOLUTION | El donante reconoció; periodo de resolución en curso (D+7) |
CONFIRMED | El donante confirmó; la clave queda bloqueada hasta su finalización |
COMPLETED | Transferencia de clave finalizada |
CANCELLED | Cancelado por el donante o el reclamante |
OPEN, WAITING_RESOLUTION o CONFIRMED), la clave queda bloqueada: se impiden nuevas entradas y eliminaciones. Durante OPEN/WAITING_RESOLUTION el donante todavía puede actualizar los datos de la cuenta y las consultas de clave devuelven los datos del donante; una vez en CONFIRMED, las consultas devuelven “key not found” hasta que el reclamo pase a COMPLETED o CANCELLED.
- PORTABILITY puede completarse inmediatamente después de la confirmación.
- OWNERSHIP tiene una ventana de finalización:
resolutionPeriodEndes D+7 ycompletionPeriodEndes D+30.
Operaciones de reclamo
| Operación | Rol | Endpoint |
|---|---|---|
| Create | Reclamante | POST /v1/dict/claims |
| Acknowledge | Donante | POST /v1/dict/claims/{id}/acknowledge |
| Confirm | Donante | POST /v1/dict/claims/{id}/confirm |
| Complete | Reclamante | POST /v1/dict/claims/{id}/complete |
| Cancel | Donante o reclamante | POST /v1/dict/claims/{id}/cancel |
Reconciliación (VSync)
La reconciliación mantiene tus datos locales de DICT consistentes con los registros autoritativos de BACEN. Se basa en dos conceptos:
- CID (Content Identifier) — un hash HMAC-SHA256 de 256 bits de los atributos de una entrada (tipo de clave, clave, propietario, participante, agencia, cuenta, etc.).
- VSync — un único checksum formado mediante XOR de cada CID de un tipo de clave. Como XOR es conmutativo, comparar tu VSync con el de BTG/BACEN revela si tu conjunto de entradas está sincronizado sin intercambiar cada registro.
- API manual / administrativa — los operadores activan verificaciones bajo demanda, descargan archivos CID e investigan inconsistencias. Usa Start full reconciliation y List reconciliation jobs.
- VSync worker — un proceso automatizado en segundo plano que compara periódicamente las entradas internas con DICT y reconcilia las divergencias sin intervención del usuario.
Marcadores de fraude (MED)
DICT también expone las herramientas de prevención de fraude MED (Mecanismo Especial de Devolução) de BACEN. Los marcadores de fraude señalan una clave o cuenta como asociada con fraude; puedes crearlos y cancelarlos, y los infraction reports y refund requests relacionados impulsan el flujo de disputa y recuperación. Referencia: Create a fraud marker · Cancel a fraud marker · List fraud markers · Create an infraction report Para los flujos completos de disputa y recuperación de fondos, consulta Operaciones de reembolso y MED 2.0 — Recuperación de fondos.
Próximos pasos
- Códigos QR — Generación de códigos QR en claves registradas
- Webhooks — Notificaciones de reclamos, infracciones y reembolsos
- Integración — Reconciliación de DICT y configuración del worker

