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.
Estadísticas
El dominio Estadísticas expone los agregados de riesgo y uso de Pix de BACEN, permitiéndote evaluar a una contraparte antes de liquidar un pago. Ambos endpoints consultan al proveedor directamente y no almacenan datos localmente, así que trata cada llamada como una consulta nueva en tiempo real. Están etiquetados bajo la API MED y requieren autenticación bearer.
| Endpoint | Alcance | Úsalo para |
|---|---|---|
GET /v1/dict/statistics/persons/{tax_id} | Una persona (CPF o CNPJ) | Evaluar a un pagador/beneficiario en todas sus claves y cuentas |
GET /v1/dict/statistics/keys/{key} | Una única clave Pix | Evaluar una clave específica, junto con su titular actual |
Estadísticas de persona
Pasa el tax ID (CPF o CNPJ) en la ruta. La respuesta agrega datos de liquidación, marcadores de fraude, infraction reports e información de entradas a lo largo de tres ventanas móviles: d90 (últimos 90 días), m12 (últimos 12 meses) y m60 (últimos 60 meses).Estadísticas de clave
Pasa la clave Pix en la ruta. La respuesta devuelve tanto las estadísticas a nivel de clave (datos ligados a la clave como entidad, independientes de su titular actual) como las estadísticas a nivel de titular (equivalentes a las estadísticas de persona del titular actual de la clave) en una sola llamada.Usa las estadísticas de clave cuando estés a punto de pagar una clave específica, y las estadísticas de persona para una visión más amplia del riesgo de la contraparte. Como ninguna se persiste, cachea de forma responsable en tu lado si necesitas reutilizar el resultado dentro de un flujo de solicitud.
Marcadores de fraude y MED 1.0
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 (tipos de fraude:
APPLICATION_FRAUD, MULE_ACCOUNT, SCAMMER_ACCOUNT, OTHER). Los infraction reports y refund requests relacionados impulsan el flujo de disputa de MED 1.0.
Referencia: Create a fraud marker · Cancel a fraud marker · List fraud markers
Infraction reports
Un infraction report notifica al PSP de la contraparte que una transacción está en disputa por fraude. Solo puede abrirse dentro de los 90 días posteriores a la fecha de la transacción, y sigue un ciclo de vida create → acknowledge → close/cancel:| Paso | Rol | Endpoint |
|---|---|---|
| Create | Reportante (PSP del pagador) | POST /v1/dict/infraction-reports |
| Acknowledge | PSP de la contraparte | POST /v1/dict/infraction-reports/{id}/acknowledge |
| Close | PSP del beneficiario/pagador | POST /v1/dict/infraction-reports/{id}/close |
| Cancel | Reportante | POST /v1/dict/infraction-reports/{id}/cancel |
- Create — abre el reporte contra el end-to-end ID en disputa, p. ej.
reason: REFUND_REQUEST,situationType: SCAM. - Acknowledge — el PSP receptor confirma que recibió el reporte.
- Close — el PSP que responde envía su resultado de análisis (por ejemplo
TOTALLY_ACCEPTED) dentro de 7 días. Las infraccionesREFUND_REQUESTlas cierra el PSP del beneficiario; las infraccionesREFUND_CANCELLED, el PSP del pagador. Una vez cerrado, el reporte es inmutable. - Cancel — el reportante retira un reporte que abrió.
Refund requests
Un refund request es el mecanismo de MED 1.0 para pedir al PSP de la contraparte que devuelva los fondos en disputa. Refleja el mismo ciclo de vida create → acknowledge → close/cancel:| Paso | Endpoint |
|---|---|
| Create | POST /v1/dict/refund-requests |
| Retrieve / List | GET /v1/dict/refund-requests/{id} · GET /v1/dict/refund-requests |
| Close | POST /v1/dict/refund-requests/{id}/close |
| Cancel | POST /v1/dict/refund-requests/{id}/cancel |
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

