Documentação de módulo
Consulta de Pix
Veja abaixo a estrutura de resposta JSON retornada por este módulo. Os campos podem variar conforme a disponibilidade e atualizações do serviço.
RESPOSTA JSON / EXEMPLO
{
"q": [
{
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXXX XXXXX XX XXXXX XXXXX",
"tipo": "CHAVE_ALEATORIA",
"chave": "92f9d0bd-14xxxxxxxxx46ac1f201",
"status": "ATIVO",
"participante": "60701190",
"banco": "ITAÚ UNIBANCO S.A.",
"agencia": "6596",
"conta": "00178530",
"tipoConta": "CONTA_CORRENTE",
"criadoEm": "06/11/2024 11:14:54",
"inativadoEm": null
},
{
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXXX XXXXX XX XXXXX XXXXX",
"tipo": "TELEFONE",
"chave": "+5592995xxxxxx",
"status": "ATIVO",
"participante": "00360305",
"banco": "CAIXA ECONOMICA FEDERAL",
"agencia": "2971",
"conta": "12880000008064440635",
"tipoConta": "CONTA_POUPANCA",
"criadoEm": "28/04/2021 22:25:17",
"inativadoEm": null
},
{
"cpf": "xxxxxxxxxxx",
"nome": "",
"tipo": null,
"chave": "393ee8a6-37xxxxxxxxx1b24d1818f32",
"status": "INATIVO",
"participante": null,
"banco": null,
"agencia": null,
"conta": null,
"tipoConta": null,
"criadoEm": null,
"inativadoEm": "27/07/2021 11:40:59"
},
{
"cpf": "xxxxxxxxxxx",
"nome": "",
"tipo": null,
"chave": "22b5e2d0-9exxxxxxxxxb5b8f95057a7",
"status": "INATIVO",
"participante": null,
"banco": null,
"agencia": null,
"conta": null,
"tipoConta": null,
"criadoEm": null,
"inativadoEm": "22/05/2025 09:32:07"
},
{
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXXX XXXXX XX XXXXX XXXXX",
"tipo": "EMAIL",
"chave": "xxxxxxx@xxxxx.xxx",
"status": "ATIVO",
"participante": "18236120",
"banco": "NU PAGAMENTOS - IP",
"agencia": "1",
"conta": "6942254935",
"tipoConta": "CONTA_PAGAMENTO",
"criadoEm": "01/03/2024 12:41:39",
"inativadoEm": null
},
{
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXXX XXXXX XX XXXXX XXXXX",
"tipo": "CHAVE_ALEATORIA",
"chave": "75e749e2-a9xxxxxxxxx70fdc15c719",
"status": "ATIVO",
"participante": "60746948",
"banco": "BCO BRADESCO S.A.",
"agencia": "3707",
"conta": "165433",
"tipoConta": "CONTA_CORRENTE",
"criadoEm": "26/02/2022 22:00:33",
"inativadoEm": "01/06/2025 19:17:01"
},
{
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXXX XXXXX XX XXXXX XXXXX",
"tipo": "CHAVE_ALEATORIA",
"chave": "b5c3f1f8-bexxxxxxxxx0136202bcff",
"status": "ATIVO",
"participante": "18236120",
"banco": "NU PAGAMENTOS - IP",
"agencia": "1",
"conta": "6942254935",
"tipoConta": "CONTA_PAGAMENTO",
"criadoEm": "01/03/2024 12:41:43",
"inativadoEm": null
},
{
"cpf": "xxxxxxxxxxx",
"nome": "XXXXXXX XXXXX XX XXXXX XXXXX",
"tipo": "CPF",
"chave": "xxxxxxxxxxx",
"status": "ATIVO",
"participante": "60746948",
"banco": "BCO BRADESCO S.A.",
"agencia": "3707",
"conta": "165433",
"tipoConta": "CONTA_CORRENTE",
"criadoEm": "26/02/2022 22:00:33",
"inativadoEm": "26/05/2025 23:05:35"
}
]
}