X-Account-Id.
Entradas y claves
Una entrada vincula una clave Pix a una de tus cuentas. El plugin resuelve los datos de la cuenta y del titular desde CRM. Creas entradas por tipo de clave en lugar de detalles de la cuenta. Tipos de clave admitidos:
/v1/dict/entries). La creación y la eliminación validan contra los reclamos activos y comprueban la clave frente al 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 completaste esas comprobaciones antes de llamarlo. Consulta la guía de integración para conocer los requisitos previos.
GET /v1/dict/keys/{key}) resuelven una clave con fines de pago. La respuesta devuelve el propietario actual y la cuenta, para que puedas iniciar un pago. La consulta requiere el header X-End-To-End-Id para el seguimiento del pago. Usa POST /v1/dict/keys/check para verificar la existencia de forma masiva. El plugin devuelve los datos tal como los recibe de BTG. Enmascara los campos sensibles antes de mostrarlos en tu lado.
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. BTG establece claimerParticipant y donorParticipant automáticamente.
Ciclo de vida del reclamo
Mientras un reclamo está activo (
OPEN, WAITING_RESOLUTION o CONFIRMED), el reclamo bloquea la clave. El plugin impide nuevas entradas y eliminaciones. Durante OPEN y WAITING_RESOLUTION, el donante todavía puede actualizar los datos de la cuenta, y las consultas de clave devuelven los datos del donante. Después de CONFIRMED, las consultas devuelven “key not found” hasta que el reclamo llega a COMPLETED o CANCELLED.
- PORTABILITY puede completarse inmediatamente después de la confirmación.
- OWNERSHIP añade una ventana de finalización. BTG devuelve
resolutionPeriodEnd(D+7) ycompletionPeriodEnden el reclamo.
Operaciones de reclamo
Los webhooks salientes CLAIM entregan los cambios de estado del reclamo a tu sistema. Consulta la guía de Webhooks.
Referencia: Create a claim · List · Retrieve · Acknowledge · Confirm · Complete · Cancel
Reconciliación (VSync)
La reconciliación mantiene tus datos locales de DICT consistentes con los registros autoritativos de BACEN. Usa 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 que aplica XOR a cada CID de un tipo de clave. Como XOR es conmutativo, comparas tu VSync con el de BTG/BACEN para revelar si tus entradas están sincronizadas 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. Puedes evaluar a una contraparte antes de liquidar un pago. Ambos endpoints consultan al proveedor directamente y no almacenan datos localmente. Trata cada llamada como una consulta nueva en tiempo real. Ambos endpoints requieren autenticación bearer.
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. Cubre 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 dos estadísticas en una sola llamada: a nivel de clave y a nivel de titular. Las estadísticas a nivel de clave se refieren a la clave como entidad, independientes de su titular actual. Las estadísticas a nivel de titular coinciden con las estadísticas de persona del titular actual de la clave.Usa las estadísticas de clave cuando pagues una clave específica. Usa las estadísticas de persona para una visión más amplia del riesgo de la contraparte. El plugin no persiste ninguno de los resultados. Cachea con responsabilidad en tu lado si reutilizas un 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 informa al PSP de la contraparte de que disputas una transacción como fraude. Solo puedes abrir un reporte dentro de los 90 días posteriores a la fecha de la transacción. El reporte sigue un ciclo de vida create → acknowledge → close/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 la recepción del reporte.
- Close — el PSP que responde envía su resultado de análisis (por ejemplo
TOTALLY_ACCEPTED) dentro de 7 días. El PSP del beneficiario cierra las infraccionesREFUND_REQUEST. El PSP del pagador cierra las infraccionesREFUND_CANCELLED. Tras el cierre, 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:
Close registra el resultado del análisis y finaliza la solicitud. Cancel retira una solicitud pendiente. Los webhooks salientes entregan los cambios de estado tanto de los infraction reports como de los refund requests. Consulta la guía de Webhooks.
Referencia: Create an infraction report · Acknowledge · Close · Cancel · Create a refund request
Para los flujos de 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

