JD Pagamentos Instantâneos
Integre com JDPI para autenticação, gestão de chaves PIX (DICT), iniciação, efetivação e devolução de pagamentos instantâneos (SPI), QR Codes e gestão de participantes.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 91 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_jdpi_spi_api_v2_teste_conectividade | O Sistema Cliente deve consumir essa API para realizar testes de conectividade, que tem o objetivo de assegurar que a infraestrutura do PSP está apta para: Após validar a Requisição, o JDPI irá gerar e enviar ao SPI a mensagem pibr.001 e receber a mensagem pibr.002, que será retornada ao Sistema Cliente. | data: { . conteudo (string) } (object) required |
| post_jdpi_connect_token | O Sistema Cliente deve consumir essa API para requisitar um Token de Acesso ao JDPI. Após validar a Requisição, o JDPI irá gerar um Token de Acesso, que é retornado ao Este Token de Acesso é utilizado para autenticar as requisições que os Sistemas Clientes enviam às APIs do JDPI. Tal Token deve ser informado no parâmetro “Authorization”, no cabeçalho de todas as requisições realizadas pelo Sistema Cliente ao JDPI exceto a API “Consumir URI do QRCode Dinâmico”. Com o objetivo de otimizar a utiliz | No parameters |
| post_jdpi_dict_api_v2_incluir | O Sistema Cliente deve consumir essa API para incluir uma Chave de Endereçamento. Antes de consumir esta API, o Sistema Cliente deve assegurar que o Cliente final que está requisitando esta inclusão de Chave: O Sistema Cliente deve assegurar também que, caso a Chave de Endereçamento a ser incluída seja do tipo: Por questões de segurança, o JDPI não interage diretamente com o App Mobile ou Internet Bank mas sim com o BackEnd de tais sistemas. Em função disso, o JDPI não tem como assegurar que o C | data: { . tpChave (integer) . chave (string) . ispb (string) . nrAgencia (string) . tpConta (integer) . nrConta (string) . dtHrAberturaConta (string) . tpPessoa (integer) . cpfCnpj (string) . nome (string) . nomeFantasia (string) . motivo (integer) } (object) required |
| put_jdpi_dict_api_v2_by_chave | O Sistema Cliente deve consumir essa API para alterar uma Chave de Endereçamento. Não se trata de alterar o Valor da chave, mas sim de alterar a conta vinculada à chave e/ou o nome do cliente, ou seja, o valor da chave se mantém inalterado, porém a chave deixa de estar associada à conta e/ou nome de cliente original e passa a estar associada a uma nova Conta Transacional e/ou novo nome de cliente, no mesmo PSP. Antes de consumir esta API, o Sistema Cliente deve assegurar que o Cliente final que | chave (string) data: { . chave (string) . ispb (string) . nrAgenciaNova (string) . tpContaNova (integer) . nrContaNova (string) . dtHrAberturaConta (string) . nomeNovo (string) . nomeFantasiaNovo (string) . motivo (integer) } (object) required |
| get_jdpi_dict_api_v2_by_chave | O Sistema Cliente deve consumir essa API para Consultar os dados associados a uma Chave de Endereçamento, tais como Nome do Titular, CPF/CNPJ do Titular, ISPB do PSP, Número da Agência, Tipo de Conta e Número da Conta. Após validar os dados da consulta, o JDPI consulta a sua base local, para identificar se a Conta Recebedora também é uma conta do PSP Pagador. Em caso negativo, o JDPI envia a Consulta ao DICT e repassa ao Sistema Cliente os dados retornados pelo DICT. de uma Chave de Endereçament | chave (string) includeStatistics (boolean) |
| post_jdpi_dict_api_v2_by_chave_excluir | O Sistema Cliente deve consumir essa API para excluir uma Chave de Endereçamento. Antes de consumir esta API, o Sistema Cliente deve assegurar que o Cliente que requisitou a exclusão da Chave: Após validar a requisição, o JDPI a enviará ao DICT. Em caso de sucesso, o JDPI excluirá a Chave de Endereçamento em sua base local. da chave pelo Cliente Recebedor. | chave (string) data: { . chave (string) . ispb (string) . motivo (integer) } (object) required |
| post_jdpi_dict_api_v2_encerrar_conta | O Sistema Cliente deve consumir essa API para registrar o encerramento de uma Conta Transacional. Após validar os dados, o JDPI identificará todas as Chaves de Endereçamento associadas à Conta encerrada e enviará ao DICT as exclusões de chave que se fizerem necessárias. Para cada exclusão processada com sucesso, o JDPI excluirá de sua base local a chave correspondente. Cliente Recebedor ou utilização da conta em processos de fraude. | data: { . ispb (string) . nrAgencia (string) . tpConta (integer) . nrConta (string) } (object) required |
| post_jdpi_dict_api_v2_excluir_titular | O Sistema Gestor de Contas Transacionais deve consumir essa API sempre que encerrar o vínculo de titularidade entre um Cliente e uma Conta Transacional, ou o Cliente não possuiu mais poderes para operar a conta. Após validar os dados, o JDPI identificará todas as Chaves de Endereçamento associadas à Conta e ao Titular em questão e enviará ao DICT as exclusões de chave que se fizerem necessárias. Para cada exclusão processada com sucesso, o JDPI excluirá de sua base local a chave correspondente. | data: { . ispb (string) . nrAgencia (string) . tpConta (integer) . nrConta (string) . tpPessoa (integer) . cpfCnpj (string) } (object) required |
| post_jdpi_dict_api_v2_listar_chave | O Sistema Cliente deve consumir essa API para listar as Chaves de Endereçamento associadas a uma Conta Transacional e a um Cliente do PSP. Antes de consumir esta API, o Sistema Cliente deve assegurar que o Cliente final que requisitou a consulta: Após validar os dados da consulta, o JDPI identificará em sua base de dados local o conjunto de chaves associadas ao Cliente e a Conta e o repassará ao Sistema Cliente. | data: { . ispb (string) . nrAgencia (string) . tpConta (integer) . nrConta (string) . tpPessoa (integer) . cpfCnpj (string) } (object) required |
| post_jdpi_dict_api_v2_reivindicacao_incluir | O Sistema Cliente deve consumir essa API para iniciar um processo de Reivindicação de uma Chave de Endereçamento. Se, ao tentar incluir uma Chave de Endereçamento, retornar um erro, informando que a chave já existe no DICT, o cliente pode solicitar uma Reivindicação de Chave de Endereçamento. Caso a chave existente esteja associada ao mesmo CPF/CNPJ do cliente em questão, será uma Reivindicação do tipo Portabilidade. Do contrário, será do tipo Reivindicação de Posse. Não se pode reivindicar uma | data: { . tpReivindicacao (integer) . tpChave (integer) . chave (string) . ispb (string) . nrAgencia (string) . tpConta (integer) . nrConta (string) . dtHrAberturaConta (string) . tpPessoa (integer) . cpfCnpj (string) . nome (string) . nomeFantasia (string) } (object) required |
| post_jdpi_dict_api_v2_reivindicacao_listar_pendentes | O Sistema Cliente deve consumir essa API sempre que um Cliente necessitar conhecer a lista de Reivindicações de Chaves de Endereçamento, nas quais ele atua como Cliente Doador ou Cliente Reivindicador. O Regulamento do Pix estabelece prazos para os clientes envolvidos se pronunciarem sobre a Reivindicação de Chave. Por questões de segurança, o JDPI não interage diretamente com os canais de acesso utilizados pelo cliente, tais como App Mobile e Internet Bank. Estes canais se comunicam com um módu | data: { . ispb (string) . tpPessoaLogada (integer) . cpfCnpjLogado (string) . nrAgenciaLogada (string) . tpContaLogada (integer) . nrContaLogada (string) . pagina (integer) . tamanhoPagina (integer) } (object) required |
| post_jdpi_dict_api_v2_reivindicacao_by_id_reivindicacao_confirmar | O Sistema Cliente deve consumir essa API quando, no processo de Reivindicação de uma Chave de Endereçamento, o Cliente Doador desejar registrar a Confirmação de uma Reivindicação, ou seja, o Cliente Doador registra que está disposto em ceder ao Cliente Reivindicador a chave reivindicada. Após validar os dados, o JDPI enviará a Requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Reivindicação para “Confirmada”. Confirmação de uma Reivindicação de Chave de E | idReivindicacao (string) data: { . idReivindicacao (string) . ispb (string) . motivo (integer) } (object) required |
| post_jdpi_dict_api_v2_reivindicacao_by_id_reivindicacao_cancelar | O Sistema Cliente deve consumir essa API quando, no processo de Reivindicação de uma Chave de Endereçamento, o Cliente Doador ou o Cliente Reivindicador desejarem cancelar a Reivindicação. Após validar os dados, o JDPI enviará a Requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Reivindicação para “Cancelada”. Reivindicador para registrar o Cancelamento de uma Reivindicação de Chave de Endereçamento ou fraude, envolvendo a Reivindicação. | idReivindicacao (string) data: { . idReivindicacao (string) . ispb (string) . ehReivindicador (boolean) . motivo (integer) } (object) required |
| post_jdpi_dict_api_v2_reivindicacao_by_id_reivindicacao_concluir | O Sistema Cliente deve consumir essa API quando, no processo de Reivindicação de uma Chave de Endereçamento, quando o Cliente Reivindicador desejar registrar a Conclusão de uma Reivindicação, ou seja, o Cliente Reivindicador conclui o processo e que a Chave de Endereçamento em disputa já pode ser associada à sua Conta. Após validar os dados, o JDPI enviará a Requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Reivindicação para “Concluída”. Obs.: No caso d | idReivindicacao (string) data: { . idReivindicacao (string) . ispb (string) } (object) required |
| post_jdpi_dict_api_v2_reivindicacao_listar | O Sistema Cliente deve consumir essa API sempre que um Cliente necessitar conhecer a lista de Reivindicações de Chaves de Endereçamento, nas quais ele atua como: Reinvidicação de uma Chave que está atualmente de posse do Cliente em questão. O Regulamento do Pix estabelece prazos para os clientes envolvidos se pronunciarem sobre uma Reivindicação de Chave de Endereçamento. Por questões de segurança, o JDPI não interage diretamente com os canais de acesso utilizados pelo cliente final, tais como A | data: { . ispb (string) . tpPessoaLogada (integer) . cpfCnpjLogado (string) . nrAgenciaLogada (string) . tpContaLogada (integer) . nrContaLogada (string) . ehDoador (boolean) . ehReivindicador (boolean) . stReivindicacao (integer) . tpReivindicacao (integer) . nrLimite (integer) } (object) required |
| get_jdpi_dict_api_v2_reivindicacao | O Sistema Cliente deve consumir essa API para consultar uma Reivindicação de Chave de Endereçamento, na qual ele atua como: Reinvidicação de uma Chave que está atualmente de posse do Cliente em questão. Por questões de segurança, o JDPI não interage diretamente com os canais de acesso utilizados pelo cliente final, tais como App Mobile e Internet Bank. Estes canais se comunicam, através de uma forte camada de segurança, com um módulo chamado identificar o Usuário/Conta que está logado no App Mob | No parameters |
| get_jdpi_dict_api_v2_relato_infracao_listar_pendentes | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer a lista de Notificações de Infração, tanto aquelas relatadas pelo PSP quanto as recebidas de outros PSPs. O Regulamento do Pix estabelece prazos para os PSPs envolvidos se pronunciarem sobre uma Notificação de Infração. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a lista de Notificações de Infração que estejam em processamento ou tiveram sua situação alterada nos últimos 7 dias, on | No parameters |
| get_jdpi_dict_api_v2_relato_infracao_consultar | O Sistema Cliente deve consumir essa API para consultar uma Notificação de Infração, no qual ele atua como: notificação, podendo ser o criador ou a contraparte da notificação – ou notificação, podendo ser o criador ou a contraparte da notificação. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a Notificação de Infração onde o PSP atua como debitado ou creditado. Esta notificação é repassada ao Sistema Cliente, juntamente com sua situação atual. detalhes d | No parameters |
| post_jdpi_dict_api_v2_relato_infracao_cancelar | O Sistema Cliente deve consumir essa API quando, no processo de Notificação de Infração de uma transação, o PSP Criador da notificação desejar cancelar a Notificação de Infração. A Notificação de Infração pode ser cancelada a qualquer momento, mesmo depois que a notificação estiver com situação de “Analisado”. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Notificação de Infração para “Cancelado”. Notificação de | data: { . idRelatoInfracao (string) . ispb (string) } (object) required |
| post_jdpi_dict_api_v2_relato_infracao_analisar | O Sistema Cliente deve consumir essa API quando, no processo de Notificação de Infração de uma transação, quando o PSP da Contraparte desejar registrar o resultado da análise da infração, ou seja, a Notificação de Infração será fechada. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Notificação de Infração para “Analisado”. de Infração recebida ou Notificação de Infração recebida. | data: { . idRelatoInfracao (string) . ispb (string) . tpFraude (integer) . resultadoAnalise (integer) . detalhesAnalise (string) } (object) required |
| get_jdpi_dict_api_v2_relato_infracao_listar | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer a lista de Notificações de Infração, tanto aquelas criadas pelo próprio PSP, quanto as recebidas de outros PSPs. O Regulamento do Pix estabelece prazos para os PSPs envolvidos se pronunciarem sobre uma Notificação de Infração. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a lista de Notificações de Infração onde o PSP atua como criador ou contraparte da notificação. Essa lista é repa | No parameters |
| post_jdpi_dict_api_v2_reivindicacao_listar_paginacao | O Sistema Cliente deve consumir essa API sempre que um Cliente necessitar conhecer a lista de Reivindicações de Chaves de Endereçamento utilizando paginação, nas quais ele atua como: Reinvidicação de uma Chave que está atualmente de posse do Cliente em questão. O Regulamento do Pix estabelece prazos para os clientes envolvidos se pronunciarem sobre uma Reivindicação de Chave de Endereçamento. Por questões de segurança, o JDPI não interage diretamente com os canais de acesso utilizados pelo clien | data: { . ispb (string) . tpPessoaLogada (integer) . cpfCnpjLogado (string) . nrAgenciaLogada (string) . tpContaLogada (integer) . nrContaLogada (string) . ehDoador (boolean) . ehReivindicador (boolean) . stReivindicacao (integer) . tpReivindicacao (integer) . pagina (integer) . tamanhoPagina (integer) } (object) required |
| post_jdpi_dict_api_v2_verificar | O Sistema Cliente deve consumir essa API para verificar se cada Chave de Endereçamento contida no conjunto informado, possui vínculo existente registrado no DICT. Após validar os dados da requisição, o JDPI irá enviar a verificação de existência de chave de endereçamento ao DICT contendo todo o conjunto de chaves informados na requisição e repassa ao Sistema Cliente os dados retornados pelo DICT. usuário final. | data: { . ispb (string) . verificarChaves (array) } (object) required |
| post_jdpi_dict_api_v2_devolucao_incluir | O Sistema Cliente deve consumir essa API para incluir uma Solicitação de Devolução. Antes de consumir esta API, o Sistema Cliente deve assegurar que a transação a ser reportada na Solicitação de Devolução, tenha sido realizada nos últimos 90 dias corridos. O processo de Solicitação de Devolução segue os seguintes passos: Recebedor envolvido na transação, com isso disponibilizando para o mesmo a listagem da Solicitação de Devolução; a análise/conclusão da Solicitação de Devolução. Prazos dos ANS’ | data: { . ispb (string) . endToEndId (string) . motivo (integer) . valorDevolucao (number) . detalhes (string) } (object) required |
| get_jdpi_dict_api_v2_devolucao_listar_pendentes | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer a lista de Solicitações de Devolução, tanto aquelas solicitações criadas pelo PSP quanto as recebidas de outros PSPs. O Regulamento do Pix estabelece prazos para os PSPs envolvidos se pronunciarem sobre uma Solicitação de Devolução. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a lista de Solicitações de Devolução que estejam em processamento ou tiveram sua situação alterada nos últi | No parameters |
| get_jdpi_dict_api_v2_devolucao_consultar | O Sistema Cliente deve consumir essa API para consultar uma Solicitação de Devolução, na qual ele atua como solicitante ou contestado. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a Solicitação de Devolução onde o PSP atua como solicitante ou contestado. Esta Solicitação de Devolução é repassada ao Sistema Cliente, juntamente com sua situação atual. detalhes de uma Solicitação de Devolução associada a ele ou detalhes de uma Solicitação de Devolução asso | No parameters |
| post_jdpi_dict_api_v2_devolucao_cancelar | O Sistema Cliente deve consumir essa API quando, no processo de Solicitação de Devolução de uma transação, o PSP do usuário Pagador desejar cancelar a Solicitação de Devolução, desde que a mesma não possua situação “Analisada”. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Solicitação de Devolução para “Cancelada”. necessidade de cancelamento da Solicitação de Devolução criada anteriormente ou solicitação de ca | data: { . idSolDevolucao (string) . ispb (string) } (object) required |
| post_jdpi_dict_api_v2_devolucao_analisar | O Sistema Cliente deve consumir essa API no processo de Solicitação de Devolução de uma transação, quando o PSP do Recebedor PSP Contestado desejar registrar o resultado da análise da solicitação, ou seja, a Solicitação de Devolução será fechada. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Solicitação de Devolução para “Analisada”. de Devolução recebida ou Solicitação de Devolução recebida. | data: { . idSolDevolucao (string) . ispb (string) . resultadoAnalise (integer) . detalhesAnalise (string) . endToEndIdDevolucao (string) } (object) required |
| get_jdpi_dict_api_v2_devolucao_listar | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer a lista de Solicitações de Devolução, tanto aquelas solicitações criadas pelo PSP quanto as recebidas de outros PSPs. O Regulamento do Pix estabelece prazos para os PSPs envolvidos se pronunciarem sobre uma Solicitação de Devolução. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a lista de Solicitações de Devolução onde o PSP atua como solicitante ou contestado da solicitação de devol | No parameters |
| get_jdpi_dict_api_v2_estatisticas_by_cpfcnpj | O Sistema Cliente deve consumir essa API para consultar informações vinculadas a um CPF ou CNPJ específico, para fins de segurança do Pix. Está API tem o propósito de alimentar os mecanismos de análise de fraude dos participantes, inclusive em processos que não estejam diretamente relacionados ao Pix. Após validar os dados da consulta, o JDPI envia a Consulta ao DICT e repassa ao Sistema Cliente os dados retornados pelo DICT. indícios de fraudes; nova conta. | cpfcnpj (string) |
| get_jdpi_dict_api_v2_politicas_listar | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer a lista de políticas de limitação de requisições ao DICT, bem como a quantidade de fichas disponíveis para cada política de limitação. Uma política de limitação tem associado a ela um escopo, que pode ser o usuário final ou o PSP. Cada política possui uma taxa de reposição de 'fichas', um tamanho de 'balde' e uma regra de contagem. Após validar os dados da consulta, o JDPI envia a consulta ao DICT e repassa ao Sistema Client | No parameters |
| get_jdpi_dict_api_v2_politicas_by_nome_politica | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer o estado atual do balde do PSP para uma determinada política de limitação de requisições ao DICT. Uma política de limitação tem associado a ela um escopo, que pode ser o usuário final ou o PSP. Cada política possui uma taxa de reposição de 'fichas', um tamanho de 'balde' e uma regra de contagem. Após validar os dados da consulta, o JDPI envia a consulta ao DICT e repassa ao Sistema Cliente os dados retornados pelo DICT. disp | nomePolitica (string) |
| get_jdpi_dict_api_v2_estatisticas_chave_by_chave | O Sistema Cliente deve consumir essa API para consultar informações vinculadas a uma chave Pix específica, para fins de segurança do Pix. Está API tem o propósito de alimentar os mecanismos de análise de fraude dos participantes, inclusive em processos que não estejam diretamente relacionados ao Pix. Após validar os dados da consulta, o JDPI envia a Consulta ao DICT e repassa ao Sistema Cliente os dados retornados pelo DICT. indícios de fraudes. | chave (string) |
| post_jdpi_dict_api_v2_marcacao_fraude_incluir | O Sistema Cliente deve consumir essa API quando PSP do usuário Pagador ou Recebedor desejar incluir uma Marcação de Fraude transacional. Antes de consumir esta API, o Sistema Cliente deve assegurar que houve uma confirmação de transação Pix fraudulenta, onde o CPF ou CNPJ relacionado a mesma e que será indicado na marcação faz parte da base de clientes do PSP. Sempre que identificada uma transação fraudulenta que possua chave Pix, a mesma deve ser indicada na requisição desta API, para também re | data: { . ispb (string) . tpPessoa (integer) . cpfCnpj (string) . chave (string) . tpFraude (integer) } (object) required |
| get_jdpi_dict_api_v2_marcacao_fraude_by_id_marcacao_fraude | O Sistema Cliente deve consumir essa API para Consultar os detalhes de uma Marcação de Fraude. Após validar os dados da consulta, o JDPI envia a consulta ao DICT e repassa ao Sistema Cliente os dados retornados pelo DICT. Está consulta realiza uma requisição direta ao DICT, por tal motivo está sujeita as políticas de limitação do DICT. de uma Marcação de Fraude previamente enviada, diretamente no DICT. | idMarcacaoFraude (string) |
| post_jdpi_dict_api_v2_marcacao_fraude_by_id_marcacao_fraude_cancelar | O Sistema Cliente deve consumir essa API quando desejar cancelar a Marcação de Fraude. O cancelamento da Marcação de Fraude pode ser realizado a qualquer momento pelo PSP que a criou ou no caso da marcação criada no fechamento de uma notificação de infração, apenas o PSP que fechou a notificação pode realizar o cancelamento. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Marcação de Fraude para “Cancelada”. O DI | idMarcacaoFraude (string) data: { . idMarcacaoFraude (string) . ispb (string) } (object) required |
| get_jdpi_dict_api_v2_marcacao_fraude_listar | O Sistema Cliente deve consumir essa API para listar os detalhes das Marcações de Fraude para um determinado cliente. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a lista de Marcações de Fraude de acordo com a requisição. Essa lista é repassada ao de uma Marcação de Fraude previamente enviada, diretamente no DICT. | No parameters |
| get_jdpi_dict_api_v2_relato_infracao_consultar_dict | O Sistema Cliente deve consumir essa API para consultar diretamente no DICT uma Notificação de Infração, no qual ele atua como: notificação, podendo ser o criador ou a contraparte da notificação – ou notificação, podendo ser o criador ou a contraparte da notificação. Após validar os dados da consulta, o JDPI enviará ao DICT uma requisição de consulta para identificar a Notificação de Infração onde o PSP atua como debitado ou creditado. Esta notificação é repassada ao Sistema Cliente, juntamente | No parameters |
| get_jdpi_dict_api_v2_devolucao_consultar_dict | O Sistema Cliente deve consumir essa API para consultar diretamente no DICT uma Solicitação de Devolução, na qual ele atua como solicitante ou contestado. Após validar os dados da consulta, o JDPI enviará ao DICT uma requisição de consulta para identificar a Solicitação de Devolução onde o PSP atua como solicitante ou contestado. Esta Solicitação de Devolução é repassada ao Sistema Cliente, juntamente com sua situação atual. mediante necessidade de consultar os detalhes de uma Solicitação de Dev | No parameters |
| get_jdpi_dict_api_v2_by_chave_local | O Sistema Cliente deve consumir essa API para Consultar localmente na base de dados do PSP, os dados associados a uma Chave de Endereçamento, tais como Nome do Titular, CPF/CNPJ do Titular, ISPB do PSP, Número da Agência, Tipo de Conta e Número da Conta. Após validar os dados da consulta, o JDPI consulta a sua base local para identificar os dados associados a chave. O retorno da consulta é repassado ao Sistema Cliente. de uma chave de endereçamento local. | chave (string) |
| post_jdpi_dict_api_v2_recuperacao_valores_incluir | O Sistema Cliente do PSP pagador da transação reportada como fraude denominado PSP Recuperador deve consumir essa API da forma mais tempestiva possível, para criar uma Recuperação de Valores. A Recuperação de Valores permite devolver à vítima recursos desviados em fraudes e golpes. Esse processo envolve o rastreamento de transações, bloqueio de saldos, análise das transações pelos recebedores e devolução dos recursos bloqueados à conta da vítima. Tal processo não se limita apenas a conta de dest | data: { . ispb (string) . idTransacaoRaiz (string) . tpSituacao (integer) . contatoCriador (object) . grafoRastreamento (object) } (object) required |
| get_jdpi_dict_api_v2_recuperacao_valores_consultar | O Sistema Cliente deve consumir essa API para consultar os detalhes de uma Recuperação de Valores. Após validar os dados da consulta, o JDPI com base no parâmetro 'consultaDict', consultará sua base de dados local ou enviará uma requisição de consulta diretamente ao DICT, para obter os dados da Recuperação de Valores. Os dados da Recuperação de Valores são repassados ao Sistema Cliente, juntamente com sua situação atual. mediante necessidade de consultar os detalhes de uma Recuperação de Valores | No parameters |
| post_jdpi_dict_api_v2_recuperacao_valores_by_id_rec_valores_cancelar | O Sistema Cliente do PSP criador da Recuperação de Valores deve consumir essa API quando desejar cancelar a Recuperação de Valores. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará a situação da Recuperação de Valores para “Cancelada”. O DICT por sua vez, cancelará todas as Notificações de Infração vinculadas a Recuperação de Valores em questão, independente da situação, e todas as Solicitações de Devolução vinculadas a ela que | idRecValores (string) data: { . idRecValores (string) . ispb (string) } (object) required |
| get_jdpi_dict_api_v2_recuperacao_valores_grafo_consultar | O Sistema Cliente deve consumir essa API para consultar os detalhes de um Grafo de Rastreamento. Após validar os dados da consulta, o JDPI com base no parâmetro 'consultaDict', consultará sua base de dados local ou enviará uma requisição de consulta diretamente ao DICT, para obter os dados do Grafo de Rastreamento. Os dados do grafo são repassados ao Sistema Cliente. detalhes do Grafo de Rastreamento de uma Recuperação de Valores. | No parameters |
| post_jdpi_dict_api_v2_recuperacao_valores_by_id_rec_valores_devolver | O Sistema Cliente do PSP criador da Recuperação de Valores deve consumir essa API quando desejar solicitar a devolução das transações associadas a Recuperação de Valores. A solicitação de devolução deve ser criada para Recuperação de Valores desde que a mesma esteja na situação “Analisada”. O PSP Recuperador tem até 72 horas após o encerramento da etapa de “Análise” ou seja, conclusão de todas as Notificações de Infração vinculadas a Recuperação de Valores para iniciar a etapa de devolução. Após | idRecValores (string) data: { . idRecValores (string) . ispb (string) } (object) required |
| get_jdpi_dict_api_v2_marcacao_fraude_listar_dict | O Sistema Cliente deve consumir essa API para listar os detalhes das Marcações de Fraude para uma determinada pessoa ou chave de endereçamento. Após validar os dados da consulta, o JDPI envia a consulta ao DICT e repassa ao Sistema Cliente os dados retornados pelo DICT. Está consulta realiza uma requisição direta ao DICT, por tal motivo está sujeita as políticas de limitação do DICT. no DICT, as marcações de fraude para determinado cliente ou chave. | ispb (string) tpPessoa (integer) required cpfCnpj (string) required chave (string) stMarcacaoFraude (integer) dtHrModificacaoInicio (string) dtHrModificacaoFim (string) limite (integer) |
| put_jdpi_dict_api_v2_recuperacao_valores_by_id_rec_valores | O Sistema Cliente do PSP criador da Recuperação de Valores deve consumir essa API quando, desejar alterar ou complementar dados específicos da Recuperação de Valores. A Recuperação de Valores somente poderá ser atualizada caso esteja nas situações “Criada”, “Rastreada” ou “Aguardando Análise”. Após validar os dados, o JDPI enviará a requisição ao DICT. Em caso de sucesso, o JDPI, em sua base local, atualizará os dados alterados. A situação da Recuperação de Valores não será alterada. os dados da | idRecValores (string) data: { . idRecValores (string) . ispb (string) . tpSituacaoNovo (integer) . contatoCriadorNovo (object) } (object) required |
| post_jdpi_qrcode_api_v1_estatico_gerar | O Sistema Cliente deve consumir essa API para requisitar a geração de um QRCode Estático. Após validar a Requisição, o JDPI codifica a Chave de Endereçamento e os demais dados em um QRCode Estático, que é retornado ao Sistema Cliente. É de responsabilidade do Sistema Cliente armazenar adequadamente o QR Code gerado, bem como implementar e gerenciar mecanismos de segurança para garantir o acesso seguro a essa informação. | data: { . formato (integer) . chave (string) . codigoCategoria (string) . valor (number) . nomeRecebedor (string) . cidade (string) . cep (string) . idConciliacaoRecebedor (string) . dadosAdicionais (string) } (object) required |
| post_jdpi_qrcode_api_v1_dinamico_gerar | O Sistema Cliente deve consumir essa API para requisitar a geração de um QRCode Dinâmico de Pagamento Imediato. Após validar a Requisição, o JDPI armazena os dados do pagamento e cria um endpoint e um token, para a consulta a esses dados. Logo após, codifica a URI desse endpoint, o token e os demais dados do pagamento, em um QRCode Dinâmico, que é por fim, retornado ao Sistema Cliente. Posteriormente, o PSP Pagador, consumindo a API Decodificar QRCode descrita no item 8.3.3 vai decodificar esse | data: { . formato (integer) . ispbCertificadoJws (string) . chave (string) . codigoCategoria (string) . nomeRecebedor (string) . solicitacaoPagador (string) . cnpjPagador (string) . nomePagador (string) . cidade (string) . cep (string) . valorOriginal (number) . expiracaoQR (string) . idConciliacaoRecebedor (string) . dadosAdicionais (array) . reutilizavel (boolean) . urlPayloadJson (string) . urlJwk (string) } (object) required |
| put_jdpi_qrcode_api_v1_dinamico_by_id_documento | O Sistema Cliente deve consumir essa API para requisitar a Atualização Alteração de um QRCode Dinâmico de Pagamento Imediato, gerado previamente. Após validar a Requisição, o JDPI armazena os dados do pagamento e cria um endpoint e um token, para a consulta a esses dados. Também realiza um cálculo para identificar o número de revisão deste QRCode. Logo após, codifica a URI desse endpoint, o token e os demais dados do pagamento, em um QRCode Dinâmico, que é por fim, retornado ao Posteriormente, o | idDocumento (string) data: { . idDocumento (string) . formato (integer) . ispbCertificadoJws (string) . chave (string) . codigoCategoria (string) . nomeRecebedor (string) . solicitacaoPagador (string) . cnpjPagador (string) . nomePagador (string) . cidade (string) . cep (string) . valorOriginal (number) . expiracaoQR (string) . idConciliacaoRecebedor (string) . dadosAdicionais (array) . reutilizavel (boolean) . urlPayloadJson (string) . urlJwk (string) . status (integer) } (object) required |
| get_jdpi_certificates_download | O Sistema Cliente deve consumir essa API uma vez a cada 24 horas, para realizar o download da Lista de Certificados para validação do QRCode Dinâmico URI. Após validar os dados, o JDPI irá consultar sua base local, para buscar os últimos certificados do QRCode Dinâmico baixados do BACEN e retornar os mesmos ao Sistema Cliente em formato de arquivo “.zip”. O arquivo “.zip” retornado não é incremental, logo para toda requisição realizada a está API, será retornado o download de todos os certificad | Etag (string) required |
| post_jdpi_qrcode_api_v1_dinamico_cobv_gerar | O Sistema Cliente deve consumir essa API para requisitar a geração de um QRCode Dinâmico de Pagamento com Vencimento. Após validar a Requisição, o JDPI armazena os dados do pagamento e cria um endpoint e um token, para a consulta a esses dados. Logo após, codifica a URI desse endpoint, o token e os demais dados do pagamento, em um QRCode Dinâmico, que é por fim, retornado ao Sistema Cliente. Posteriormente, o PSP Pagador, consumindo a API Decodificar QRCode descrita no item 8.3.3 vai decodificar | data: { . formato (integer) . chave (string) . codigoCategoria (string) . cpfRecebedor (string) . nomeRecebedor (string) . logradouroRecebedor (string) . cidade (string) . uf (string) . cep (string) . solicitacaoPagador (string) . cnpjPagador (string) . nomePagador (string) . valorOriginal (number) . abatimento (number) . desconto (number) . juros (number) . multa (number) . valorFinal (number) . dtVenc (string) . diasAposVenc (integer) . idConciliacaoRecebedor (string) . dadosAdicionais (array) . reutilizavel (boolean) . urlPayloadJson (string) } (object) required |
| put_jdpi_qrcode_api_v1_dinamico_cobv_by_id_documento | O Sistema Cliente deve consumir essa API para requisitar a Atualização Alteração de um QRCode Dinâmico de Pagamento com Vencimento, gerado previamente. Após validar a Requisição, o JDPI armazena os dados do pagamento e cria um endpoint e um token, para a consulta a esses dados. Também realiza um cálculo para identificar o número de revisão deste QRCode. Logo após, codifica a URI desse endpoint, o token e os demais dados do pagamento, em um QRCode Dinâmico, que é por fim, retornado ao Posteriorme | idDocumento (string) data: { . idDocumento (string) . formato (integer) . chave (string) . codigoCategoria (string) . cpfRecebedor (string) . nomeRecebedor (string) . logradouroRecebedor (string) . cidade (string) . uf (string) . cep (string) . solicitacaoPagador (string) . cnpjPagador (string) . nomePagador (string) . valorOriginal (number) . abatimento (number) . desconto (number) . juros (number) . multa (number) . valorFinal (number) . dtVenc (string) . diasAposVenc (integer) . idConciliacaoRecebedor (string) . dadosAdicionais (array) . reutilizavel (boolean) . urlPayloadJson (string) . status (integer) } (object) required |
| post_jdpi_qrcode_api_v1_dinamico_cobv_jws | O Sistema Cliente deve consumir essa API para requisitar a geração do JWS de um QRCode Dinâmico de Pagamento com Vencimento CobV. Antes de consumir esta API, o Sistema Cliente deve realizar o cálculo do valor da cobrança, informando os parâmetros utilizados para o cálculo e o valor final na requisição desta API. O JDPI não é responsável por realizar o cálculo do valor da cobrança. Após validar a Requisição, o JDPI irá localizar em sua base de dados o QRCode Dinâmico CobV associado ao identificad | data: { . idDocumento (string) . ispbCertificadoJws (string) . valorOriginal (number) . abatimento (number) . desconto (number) . juros (number) . multa (number) . valorFinal (number) . urlJwk (string) } (object) required |
| get_jdpi_qrcode_api_v1_jwk_by_ispb | O Sistema Cliente deve consumir essa API para geração da estrutura do JWK do QRCode. Após validar a requisição, o JDPI irá buscar o certificado de QRCode em sua base, extrair o JWK padrão RSA ou EC, de acordo ao certificado e repassar a estrutura obtida ao CNAB240 de url para pagamento do FGTS Digital. | ispb (string) |
| get_jdpi_qrcode_api_v1_listar | O Sistema Cliente deve consumir essa API sempre que necessitar conhecer a lista de QRCodes, já gerados pelo PSP no JDPI. Após validar os dados da consulta, o JDPI consultará sua base de dados para identificar a lista de QRCodes onde o PSP atua como criador. Essa lista é repassada ao Sistema Cliente. QRCodes associadas a ele. | No parameters |
| post_jdpi_spi_api_v2_op | O Sistema Cliente deve consumir essa API para requisitar a efetivação de uma Ordem de Pagamento previamente confirmada pelo Cliente Pagador. Antes de consumir esta API, o Sistema Cliente deve assegurar que o cliente final que requisitou a efetivação da Ordem de Pagamento: O Sistema Cliente também deve assegurar que a ordem de pagamento atende aos critérios relativos ao combate à Fraude, Lavagem de Dinheiro e combate ao terrorismo conforme definido pelo Banco Central. Por questões de segurança, o | data: { . idReqSistemaCliente (string) . dtHrRequisicaoPsp (string) . tpIniciacao (integer) . prioridadePagamento (integer) . tpPrioridadePagamento (integer) . finalidade (integer) . modalidadeAgente (integer) . ispbPss (string) . pagador (object) . recebedor (object) . valor (number) . vlrDetalhe (array) . chave (string) . endToEndId (string) . idConciliacaoRecebedor (string) . infEntreClientes (string) . tributos (object) . hash (object) } (object) required |
| get_jdpi_spi_api_v2_op_by_id_req_jd_pi_consultada | O Sistema Cliente deve consumir essa API para consultar a situação de uma requisição de inclusão de uma ordem de pagamento, previamente enviada ao JDPI Após validar a Requisição, o JDPI irá localizar em sua base dados a situação atual da requisição e repassá-la ao Sistema Cliente. O Manual de Tempos do PIX, publicado pelo BACEN, estabelece que o tempo máximo de processamento de uma requisição de pagamento, pelo SPI é de 40 segundos, para pagamentos prioritários que trafegam no CPM. O Banco Centr | idReqJdPiConsultada (string) |
| get_jdpi_spi_api_v2_conta_pi_extrato | O Sistema Cliente deve consumir essa API para consultar os lançamentos efetivados ou rejeitados no JDPI. Após receber a Requisição, o JDPI irá localizar em sua base dados os lançamentos efetivados ou rejeitados, referentes ao intervalo de data e hora informados na requisição e repassá-los ao Sistema Cliente. Serão listados todos os lançamentos que atendam aos filtros, possibilitando ao Sistema Gestor de Contas Transacionais a utilização dessa informação para conciliação. | No parameters |
| post_jdpi_spi_api_v2_conta_transacional_extrato | O Sistema Cliente deve consumir essa API para consultar o resumo do conjunto de transações de pagamentos instantâneos enviadas e recebidas, efetivados em uma Conta Transacional. Antes de consumir esta API, o Sistema Cliente deve assegurar que o cliente final que requisitou a efetivação da Ordem de Pagamento: Após validar os dados da consulta, o JDPI acessa suas bases de dados e retorna todos os Débitos e Créditos efetivados nas contas transacionais, incluindo os pagamentos intra PSP, efetivados | data: { . ispb (string) . tpPessoa (integer) . cpfCnpj (string) . nrAgencia (string) . tpConta (integer) . nrConta (string) . dtHrInicial (string) . dtHrFinal (string) . pagina (integer) . tamanhoPagina (integer) } (object) required |
| get_jdpi_spi_api_v2_conta_transacional_by_end_to_end_id | O Sistema Cliente deve consumir essa API para consultar o conjunto de informações de uma determinada transação de pagamento instantâneo enviada ou recebida, efetivada em uma Conta Transacional. Antes de consumir esta API, o Sistema Cliente deve assegurar que o cliente final que requisitou a efetivação da Ordem de Pagamento: Após validar os dados da consulta, o JDPI acessa suas bases de dados e retorna todas as informações do Débito ou Crédito efetivado na conta transacional. | endToEndId (string) |
| get_jdpi_spi_api_v2_credito_pagamento_by_end_to_end_id | O Sistema Cliente deve consumir essa API para consultar a situação de uma ordem de crédito, originada por uma mensagem pacs.008, previamente recebida do CPM ou CSM no JDPI. Após validar a Requisição, o JDPI irá localizar em sua base dados a situação atual da ordem de crédito a situação da ordem de crédito pode ser alterada ao longo do processamento e repassá-la ao Sistema Cliente. O Manual de Tempos do PIX, publicado pelo BACEN, estabelece que o tempo máximo de processamento de uma requisição de | endToEndId (string) |
| get_jdpi_spi_api_v2_lancamento_by_end_to_end_id | O Sistema Cliente deve consumir essa API em casos onde o mesmo não possui a situação final ou tem dúvidas sobre um lançamento de pagamento/devolução Débito ou Crédito, essa informação será consultada diretamente no SPI. Após validar a Requisição, o JDPI irá enviar ao SPI uma mensagem camt.060 para consultar as informações de um lançamento específico e o retorno será e repassado ao lançamento; | endToEndId (string) |
| post_jdpi_spi_api_v2_lancamento_by_end_to_end_id | O Sistema Cliente deve consumir essa API para requisitar o reenvio da transação de débito pagamento ou devolução ou confirmação da recepção do crédito pagamento ou devolução, quando já se passaram 45 segundos da transação original, sem retorno do SPI. Após validar a Requisição, o JDPI irá localizar a transação original em sua base de dados e caso ela ainda esteja pendente de retorno do SPI, irá reenviar a transação ao SPI, respeitando a regra de idempotência. Em caso de sucesso, o JDPI atualizar | endToEndId (string) data: { . endToEndId (string) . dtHrReqJdPi (string) } (object) required |
| get_jdpi_spi_api_v2_remuneracao_conta_pi_by_data_credito | O Sistema Cliente deve consumir essa API para consultar o conjunto de informações referentes à remuneração da Conta PI em uma determinada data. Após validar a Requisição, o JDPI irá enviar ao SPI uma mensagem camt.060 para consultar as informações de demonstrativo de remuneração da Conta PI ocorrido em uma determinada data. O retorno será repassado ao Sistema Cliente. | dataCredito (string) |
| get_jdpi_spi_api_v2_saldo_conta_pi_jdpi | O Sistema Cliente deve consumir essa API em casos onde o mesmo deseja obter o Saldo da Conta PI, previamente registrado no JDPI. Após validar os dados da requisição, o JDPI acessa suas bases de dados e retorna o Saldo atual da Conta PI no JDPI. para conciliação. | No parameters |
| get_jdpi_spi_api_v2_saldo_conta_pi_spi | O Sistema Cliente deve consumir essa API em casos onde o mesmo deseja obter o Saldo da Conta PI diretamente no SPI. Essa informação será consultada diretamente no SPI. Após validar a Requisição, o JDPI irá enviar ao SPI uma mensagem camt.060 para consultar o Saldo atual da Conta PI e o retorno será e repassado ao Sistema Cliente. para conciliação. | No parameters |
| get_jdpi_spi_api_v2_conta_transacional_by_end_to_end_id_situacao | O Sistema Cliente deve consumir essa API para consultar o conjunto de informações de uma determinada transação de pagamento instantâneo enviada ou recebida, na situação atual em que a transação se encontre efetivada ou não efetivada. Antes de consumir esta API, o Sistema Cliente deve assegurar que o cliente final que requisitou a efetivação da Ordem de Pagamento: Após validar os dados da consulta, o JDPI acessa suas bases de dados e retorna todas as informações do Débito ou Crédito efetivado na | endToEndId (string) |
| post_jdpi_spi_api_v2_credito_pagamento_validacao | O Sistema Cliente deve consumir essa API para registrar a validação da Conta Transacional Recebedora, realizada previamente de forma assíncrona, através da API “9.3.4. Validar Conta/Cliente/Ordem de Crédito - ASYNC”. Após validar a Requisição, o JDPI irá atualizar o lançamento de crédito com o resultado da validação e enviará o mesmo ao SPI. Para acompanhar a situação da efetivação do lançamento, deverá ser consumida a API “8.4.6. Consultar Situação de Ordem de Crédito”. Cabe ressaltar que a fun | data: { . idValidacaoSgct (string) . endToEndId (string) . resultado (integer) . dtHrValidacao (string) } (object) required |
| get_jdpi_spi_api_v2_credito_pagamento_qrcode_by_id_conciliacao_recebedor | IdConciliacaoRecebedor O Sistema Cliente deve consumir essa API para consultar a situação das ordens de crédito, originadas pela mensagem pacs.008, previamente recebidas do CPM ou CSM no JDPI, utilizando como filtro de pesquisa o identificador de conciliação do recebedor. Após validar a Requisição, o JDPI irá localizar em sua base dados a situação atual das ordem de crédito a situação da ordem de crédito pode ser alterada ao longo do processamento e repassá-la ao Sistema Cliente. O Manual de Tem | idConciliacaoRecebedor (string) |
| get_jdpi_spi_api_v2_conta_pi_extrato_aporte_retirada_remuneracao | PI O Sistema Cliente deve consumir essa API para consultar os lançamentos efetivados no JDPI, referentes a aportes, retiradas ou remuneração da Conta PI. Após receber a Requisição, o JDPI irá localizar em sua base dados os lançamentos efetivados referentes ao intervalo de data e hora informados na requisição e repassá-los ao Sistema Cliente. | No parameters |
| get_jdpi_spi_api_v2_rco_download | O Sistema Cliente deve consumir essa API para realizar o download do arquivo RCO do tipo “Demonstrativo” ou “Total”. Após validar a Requisição, o JDPI irá enviar ao SPI uma mensagem camt.060 solicitando o arquivo, ao receber o retorno do SPI o JDPI irá realizar o download do arquivo e disponibilizar o mesmo para download do Sistema Cliente em formato “.zip”. informações sobre ressarcimento de custos operacionais a pagar/receber do Pix. | No parameters |
| post_jdpi_spi_api_v2_op_interna | O Sistema Cliente deve consumir essa API para requisitar o envio ao SPI das transações liquidadas em seus próprios sistemas, como as realizadas entre usuários de um mesmo PSP ou de usuários de PSPs distintos que utilizam um mesmo PSP liquidante O objetivo do envio destas transações ao SPI é potencializar o mapeamento da dispersão de recursos no âmbito do MED 2.0. Antes de consumir esta API, o Sistema Cliente deve assegurar que o cliente final que requisitou a efetivação da Ordem de Pagamento da | data: { . idReqSistemaCliente (string) . endToEndId (string) . tpIniciacao (integer) . tpTransacao (integer) . dtHrLiquidacao (string) . valor (number) . chave (string) . pagador (object) . recebedor (object) } (object) required |
| get_jdpi_spi_api_v2_op_interna_by_id_req_jd_pi_consultada | O Sistema Cliente deve consumir essa API para consultar a situação de uma requisição enviada ao SPI, referente a uma transação liquidada em seus próprios sistemas. Após validar a requisição, o JDPI irá localizar em sua base dados a situação atual da requisição e repassá-la ao Sistema Cliente. O Manual de Tempos do Pix, publicado pelo BACEN, não estabelece um ANS específico do tempo dispendido pelo SPI para o retorno do registro das transações liquidadas internamente no PSP TRCK.002. Para esse ca | idReqJdPiConsultada (string) |
| post_jdpi_spi_api_v2_od | O Sistema Cliente deve consumir essa API para incluir uma Ordem de Devolução de uma Ordem de Pagamento, previamente autorizada pelo Cliente Recebedor do Pagamento original. Antes de consumir esta API, o Sistema Cliente deve assegurar que o cliente final que requisitou a efetivação da Ordem de Devolução: O Sistema Cliente também deve assegurar que a ordem de devolução atende aos critérios relativos ao combate à Fraude, Lavagem de Dinheiro e combate ao terrorismo, bem como o prazo da devolução 90 | data: { . idReqSistemaCliente (string) . endToEndIdOriginal (string) . valorDevolucao (number) . codigoDevolucao (string) . infEntreClientes (string) } (object) required |
| get_jdpi_spi_api_v2_od_by_id_req_jd_pi_consultada | O Sistema Cliente deve consumir essa API para consultar a situação da requisição de uma ordem de devolução, previamente enviada ao JDPI. Após validar a Requisição, o JDPI irá localizar em sua base dados a situação atual da requisição e repassá-la ao Sistema Cliente. O Manual de Tempos do PIX, publicado pelo BACEN, estabelece que o tempo máximo de processamento de uma requisição de pagamento, pelo SPI é de 40 segundos. Caso a presente API retorne situação “stJdPi = 0” e já tenha se passado mais d | idReqJdPiConsultada (string) |
| get_jdpi_spi_api_v2_od_motivos | O Sistema Cliente deve consumir essa API para consultar a lista dos motivos de devolução para um crédito recebido de uma ordem de pagamento, previamente enviada ao JDPI. Após validar a Requisição, o JDPI irá localizar em sua base dados a lista dos motivos de devolução e repassá-la ao Sistema Cliente. | No parameters |
| get_jdpi_spi_api_v2_credito_devolucao_by_end_to_end_id | O Sistema Cliente deve consumir essa API para consultar a situação de um crédito de uma ordem de devolução, originado por uma mensagem pacs.004, previamente recebida no JDPI. Após validar a Requisição, o JDPI irá localizar em sua base dados a situação atual do crédito da ordem de devolução a situação da ordem de crédito de devolução pode ser alterada ao longo do processamento e repassá-la ao Sistema Cliente. O Manual de Tempos do PIX, publicado pelo BACEN, estabelece que o tempo máximo de proces | endToEndId (string) |
| get_jdpi_spi_api_v1_gestao_psps_listar | O Sistema Cliente deve consumir essa API para obter a lista atualizada dos participantes do SPI, adquirida através das mensagens camt.014 e/ou reda.041. Após validar a requisição, o JDPI irá localizar em sua base dados a lista atualizada dos participantes do SPI e repassá-la ao Sistema Cliente ordenada pelo ISPB. | No parameters |
| get_jdpi_spi_api_v1_gestao_psps_consultar | O Sistema Cliente deve consumir essa API para obter os dados atualizados de um participante específico do SPI, adquirido através das mensagens camt.014 e/ou reda.041. Após validar a requisição, o JDPI irá localizar em sua base dados o registro do participante do SPI consultado e repassá-la ao Sistema Cliente. | No parameters |
| get_jdpi_spi_api_v1_gestao_psps_saldo_subconta_by_ispb_psp_indireto | O Sistema Cliente deve consumir essa API em casos onde o mesmo deseja obter o Saldo de uma SubConta PI Limite do PSP Indireto, previamente registrada no JDPI. Essa informação será consultada no JDPI. Após validar os dados da requisição, o JDPI irá acessar sua base de dados e retornar o Saldo atual da SubConta PI ao Sistema Cliente. O Saldo atual da SubConta PI é composto por todas as transações de débito e crédito efetivadas até o momento da consulta, para um determinado PSP Indireto indicado na | ispbPspIndireto (string) |
| put_jdpi_spi_api_v1_gestao_psps_saldo_subconta_by_ispb_psp_indireto | O Sistema Cliente deve consumir essa API em casos onde o mesmo deseja alterar o limite da SubConta PI Limite do PSP Indireto, previamente registrada no JDPI. Após validar os dados da requisição, o JDPI irá acessar sua base de dados e atualizar o limite da SubConta PI do PSP Indireto, e informará o resultado ao Sistema Cliente. disponível da SubConta PI para o PSP Indireto. | ispbPspIndireto (string) data: { . ispbPspIndireto (string) . novoLimitePspIndireto (number) } (object) required |
| get_jdpi_spi_api_v1_gestao_psps_responsaveis_listar | O Sistema Cliente deve consumir essa API para obter a lista atualizada do primeiro contato dos responsáveis pela gestão da Conta PI, adquirida através de download no SPI. Após validar a requisição, o JDPI irá realizar o download do arquivo de contatos no SPI e irá repassar o conteúdo do mesmo no retorno da requisição ao Sistema Cliente, ordenado pelo ISPB. operacionais e negociais. | No parameters |
| post_by_sistema_gestor_spb_conta_api_v1_aporte_rbcl | O JDPI consumirá esta API, disponibilizada pelo Sistema Gestor de SPB, para registrar uma requisição de Aporte crédito em conta PI a partir de conta de Reserva Bancária RB ou conta de Liquidação CL. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB representa o host do Sistema Gestor do SPB. | sistemaGestorSPB (string) data: { . ispbIF (string) . numCtrlIF (string) . ispbPSPI (string) . valor (number) . dtMovimento (string) } (object) required |
| post_by_sistema_gestor_spb_conta_api_v1_aporte_ccme | O JDPI consumirá esta API, disponibilizada pelo Sistema Gestor de SPB, para registrar uma requisição de Aporte crédito em conta PI a partir de conta Correspondente a Moeda Eletrônica CCME. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB representa o host do Sistema Gestor do SPB. | sistemaGestorSPB (string) data: { . ispbIEME (string) . numCtrlIEME (string) . valor (number) . dtMovimento (string) } (object) required |
| post_by_sistema_gestor_spb_conta_api_v1_saque_rbcl | O JDPI consumirá esta API, disponibilizada pelo Sistema Gestor de SPB, para registrar uma requisição de Saque débito em conta PI, para crédito em conta de Reserva Bancária RB ou conta de Liquidação CL. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB representa o host do Sistema Gestor do SPB. | sistemaGestorSPB (string) data: { . ispbPSPI (string) . numCtrlPSPI (string) . ispbIFCreditada (string) . finalidadeLPI (integer) . numCtrlSTROr (string) . valor (number) . dtMovimento (string) } (object) required |
| post_by_sistema_gestor_spb_conta_api_v1_saque_ccme | O JDPI consumirá essa API, disponibilizada pelo Sistema Gestor de SPB, para registrar uma requisição de Saque débito em conta PI, para crédito em conta Correspondente a Moeda Eletrônica CCME. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB representa o host do Sistema Gestor do SPB. | sistemaGestorSPB (string) data: { . ispbPSPI (string) . numCtrlPSPI (string) . valor (number) . dtMovimento (string) } (object) required |
| get_by_sistema_gestor_spb_conta_api_v1_consultarsitreq | O JDPI consumirá essa API, disponibilizada pelo Sistema Gestor de SPB, para consultar a Situação em que se encontra uma Requisição, referente a uma ação sobre Aporte, Saque ou Configuração de Aporte automático, que foi previamente enviada ao Sistema Gestor de Contas Transacionais. Após validar os dados, o Sistema Gestor de SPB identificará a Situação atual da Requisição e informará ao JDPI. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB repre | sistemaGestorSPB (string) |
| post_by_sistema_gestor_spb_conta_api_v1_consultar_saldo_rbcl | O JDPI consumirá esta API, disponibilizada pelo Sistema Gestor de SPB, para registrar uma requisição de Consulta de Saldo em Conta de Reservas Bancárias RB ou Conta de Liquidação CL. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB representa o host do Sistema Gestor do SPB. | sistemaGestorSPB (string) data: { . ispbIfLDL (string) . numCtrlIfLDL (string) . dtMovimento (string) } (object) required |
| get_by_sistema_gestor_spb_conta_api_v1_listar_aporte_retirada | O JDPI consumirá essa API, disponibilizada pelo Sistema Gestor de SPB, para listar todas as operações de Aportes e Retiradas realizadas nas últimas 24 horas no Sistema Gestor de SPB. Devem ser retornadas operações liquidadas ou não liquidadas. Após validar os dados, o Sistema Gestor de SPB retornará a lista de aportes e retiradas com situação atual de cada operação e informará ao JDPI. Exemplo de Sistema Servidor que deve disponibilizar essa API: No caminho original, SistemaGestorSPB representa | sistemaGestorSPB (string) |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |