Itaú Pix
Manage your Itaú Pix payments.
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 75 actions:
| Action | Purpose | Parameters |
|---|---|---|
| pix_recebimentos/put_cob_by_txid | API para emitir um QR Code imediato. | txid (string) x-itau-correlationID (string) data: { . calendario (object) . devedor . loc (object) . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos/patch_cob_by_txid | API para alterar ou cancelar um QR Code imediato. | txid (string) x-itau-correlationID (string) data: { . calendario (object) . devedor . loc (object) . status (string) . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos/get_cob_by_txid | API para consultar um QR Code imediato específico através do identificador do QR Code txid. | txid (string) revisao (string) |
| pix_recebimentos/post_cob | API para emitir um QR Code imediato em que o Itaú é responsável por criar o identificador do QR Code txid. | x-itau-correlationID (string) data: { . calendario (object) . devedor . loc (object) . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos/get_cob | API para consultar uma listagem de QR Codes imediatos. | inicio (string) required fim (string) required cpf (string) cnpj (string) locationPresente (boolean) status (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-correlationID (string) |
| pix_recebimentos/get_cob_by_txid_qrcode | API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API GET /cob/txid. | txid (string) x-correlationID (string) |
| pix_recebimentos/put_cobv_by_txid | API para emitir um QR Code com vencimento. | txid (string) x-itau-correlationID (string) data: { . calendario (object) . devedor . loc (object) . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos/patch_cobv_by_txid | API para alterar ou cancelar um QR Code com vencimento. | txid (string) x-itau-correlationID (string) data: { . calendario (object) . devedor . loc (object) . status (string) . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos/get_cobv_by_txid | API para consultar um QR Code com vencimento específico através do identificador do QR Code txid. | txid (string) revisao (string) |
| pix_recebimentos/get_cobv | API para consultar uma listagem de QR Codes com vencimento. | inicio (string) required fim (string) required cpf (string) cnpj (string) locationPresente (boolean) status (string) loteCobVId (integer) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-correlationID (string) |
| pix_recebimentos/get_cobv_by_txid_qrcode | API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API GET /cobv/txid. | txid (string) x-correlationID (string) |
| pix_recebimentos/put_lotecobv_by_id | API para emitir ou alterar um lote de QR Codes com vencimento. Para o caso de uso de alteração de QR Code, o array a ser atribuído na requisição e deve ser composto pelas exatas requisições de criação de QR Code com vencimento que constaram no array atribuído na requisição originária. Não se pode utilizar esta API para alterar um lote de QR Code com vencimento agregando ou removendo um QR Code já existente dentro do conjunto de QR Codes criados na requisição originária do lote. Em outras pala | id (string) x-itau-correlationID (string) data: { . descricao (string) . cobsv (array) } (object) required |
| pix_recebimentos/patch_lotecobv_by_id | API para revisar um QR Code com vencimento específico dentro de um lote de QR Codes com vencimento. A diferença desta API para a API PUT correlato é que esta API admite um array cobsv com menos solicitações de criação ou alteração de QR Code do que o array atribuído na requisição originária do lote. Não se pode, entretanto, utilizar essa API para agregar ou remover solicitações de alteração ou criação de QR Codes conforme constam na requisição originária do lote. | id (string) x-itau-correlationID (string) data: { . descricao (string) . cobsv (array) } (object) required |
| pix_recebimentos/get_lotecobv_by_id | API para consultar um lote de QR Codes com vencimento. | id (string) x-itau-correlationID (string) |
| pix_recebimentos/get_lotecobv | API para consultar uma listagem de lotes de QR Codes com vencimento. | x-itau-correlationID (string) inicio (string) required fim (string) required paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix_recebimentos/post_loc | API para criar uma location. | x-itau-correlationID (string) data: { . tipoCob (string) } (object) required |
| pix_recebimentos/get_loc | API para consultar uma listagem de locations cadastradas. | inicio (string) required fim (string) required txIdPresente (boolean) tipoCob (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-correlationID (string) |
| pix_recebimentos/get_loc_by_id | API para consultar uma location específica através do identificador da location. | id (string) |
| pix_recebimentos/delete_loc_by_id_txid | API para desvincular um QR Code de uma location. | id (string) x-itau-correlationID (string) |
| pix_recebimentos/get_pix_by_e2eid | API para consultar um Pix recebido, seja QR Code ou transferência Pix, através do identificador do pagamento e2eid. | e2eid (string) |
| pix_recebimentos/get_pix | API para consultar uma listagem de Pix recebidos, seja QR Code ou transferência Pix. | inicio (string) required fim (string) required txid (string) txidPresente (boolean) devolucaoPresente (boolean) cpf (string) cnpj (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-correlationID (string) |
| pix_recebimentos/put_pix_by_e2eid_devolucao_by_id | API para solicitar uma devolução através do identificador de pagamento e2eid e do identificador da devolução id. A configuração de timeout dessa api não pode ser inferior a 30 segundos. | e2eid (string) id (string) x-itau-correlationID (string) data: { . valor (string) . natureza (string) . descricao (string) } (object) required |
| pix_recebimentos/get_pix_by_e2eid_devolucao_by_id | API para consultar uma devolução através do identificador de pagamento e2eid e do identificador da devolução id. | e2eid (string) id (string) |
| pix_recebimentos/put_webhook_by_chave | API para configurar o serviço de notificações via webhook dos QR Codes recebidos e das transferências Pix recebidas via chave Pix para uma chave Pix. Observação: Transferências Pix recebidas com inserção manual agência e conta não serão notificadas. | chave (string) data: { . webhookUrl (string) } (object) required |
| pix_recebimentos/get_webhook_by_chave | API para consultar o serviço de notificações via webhook de uma chave Pix específica. | chave (string) |
| pix_recebimentos/delete_webhook_by_chave | API para excluir uma o serviço de notificação de recebimento de chave Pix via webhook. | chave (string) |
| pix_recebimentos/get_webhook | API para consultar a listagem dos serviço de notificações via webhook cadastrados. | inicio (string) fim (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/post_decodificacoes_qrcode | Operação responsável por recuperar os dados do QR Code escaneado através dos dados EMV. | x-itau-correlationID (string) data: { . ispb_decodificador (string) . numero_documento_decodificador (string) . url (string) . qrcode_emv (string) . pix_link (string) . codigo_municipio (string) . data_prevista_pagamento (string) . agencia (string) . conta (string) } (object) required |
| pix_recebimentos_conciliacoes_v2/post_leituras_qrcodes_pix | Operação responsável por recuperar os dados do QR Code escaneado através dos dados EMV. | x-itau-correlationID (string) estatisticas (boolean) data: { . numero_documento_pagador (string) . qrcode_emv (string) . codigo_municipio (string) . data_prevista_pagamento (string) . e2e (string) } (object) required |
| pix_recebimentos_conciliacoes_v2/post_cobrancas_imediata_pix | Operação responsável por emitir um novo QR Code imediato. | x-itau-correlationID (string) data: { . calendario (object) . devedor . loc (object) . txid (string) . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos_conciliacoes_v2/patch_cobrancas_imediata_pix_by_id_cobranca_imediata_pix | Operação responsável por alterar um QR Code imediato. | id_cobranca_imediata_pix (string) x-itau-correlationID (string) data: { . calendario (object) . txid (string) . loc (object) . status (string) . devedor . valor (object) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos_conciliacoes_v2/get_cobrancas_imediata_pix_by_id_cobranca_imediata_pix_qrcode | API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API ... | id_cobranca_imediata_pix (string) x-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/post_cobrancas_vencimento_pix | Operação responsável por emitir um novo QR Code com vencimento. | x-itau-correlationID (string) data: { . calendario (object) . devedor (object) . recebedor (object) . valor (object) . loc (object) . txid (string) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos_conciliacoes_v2/patch_cobrancas_vencimento_pix_by_id_cobranca_vencimento_pix | Operação responsável por alterar um QR Code com vencimento. | id_cobranca_vencimento_pix (string) x-itau-correlationID (string) data: { . calendario (object) . devedor (object) . recebedor (object) . valor (object) . loc (object) . status (string) . txid (string) . chave (string) . solicitacaoPagador (string) . infoAdicionais (array) } (object) required |
| pix_recebimentos_conciliacoes_v2/get_cobrancas_vencimento_pix_by_id_cobranca_vencimento_pix_qrcode | API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API ... | id_cobranca_vencimento_pix (string) x-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/post_cobrancas_estatico_pix | Operação responsável por emitir um QR Code estático. | x-itau-correlationID (string) data: { . txid (string) . valor (string) . simulacao (boolean) . chave (string) . mensagem (string) . prestador_servico_saque (string) } (object) required |
| pix_recebimentos_conciliacoes_v2/patch_cobrancas_estatico_pix_by_id_cobranca_estatico_pix | Operação responsável por revisar um QR Code estático. | id_cobranca_estatico_pix (string) x-itau-correlationID (string) data: { . txid (string) . valor (string) . status (string) . chave (string) . mensagem (string) . simulacao (boolean) } (object) required |
| pix_recebimentos_conciliacoes_v2/get_cobrancas_estatico_pix_by_id_cobranca_estatico_pix_qrcode | API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API ... | id_cobranca_estatico_pix (string) x-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/get_lancamentos_pix | Operação responsável por resgatar os lançamentos de Pix na visão pagadora/emissora, contemplando tanto pagamentos quanto devoluções Pix. | id_conta (string) data_criacao_lancamento (string) data_lancamento (string) txid (string) e2eid (string) visao (string) tipo_lancamento (string) tipo_operacao (string) tipo (string) id_documento (string) valor_documento_pagador_efetivo (string) documento (string) chaves (string) devolvido (string) page (integer) page_size (integer) view (string) order_by (string) order (string) sub_tipo_pix (string) sub_categoria (string) canal_operacao (string) operacao_credito (boolean) x-itau-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/get_lancamentos_pix_by_id_lancamento_pix | Operação responsável por recuperar um lançamento PIX especifico | id_lancamento_pix (string) |
| pix_recebimentos_conciliacoes_v2/delete_estabelecimento_saque_troco_pix | API responsável por efetuar a remoção de um ou mais pontos de atendimento do Saque e Troco Pix. | ponto_atendimento_id (string) required x-itau-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/get_estabelecimento_saque_troco_pix | API responsável por recuperar os dados dos pontos de atendimento do agente de saque. É possivel consultar um ponto de atendimento especifico atraves de seu respectivo ID. Caso o ID não seja informado na busca serão retornados todos os pontos de atendimento do agente em questão. | ponto_atendimento_id (string) page (integer) page-size (integer) x-itau-correlationID (string) |
| pix_recebimentos_conciliacoes_v2/post_estabelecimento_saque_troco_pix | O Saque e Troco Pix permite a disponibilização do serviço de saque de dinheiro nos estabelecimento comerciais. No troco o valor do QR Code é superior ao valor da compra e o estabelecimento devolve ao cliente o valor excedente em espécie. No saque será repassado o valor total do QR Code ao cliente sacador. Essa API é responsável por efetuar o cadastro de um ou mais pontos de atendimento para esse serviço. No momento do cadastro de um ponto de atendimento, serão validados os campos obrigatórios be | x-correlationID (string) data: { . agencia (string) . conta (string) . pontos_atendimento (array) } (object) required |
| pix_recebimentos_conciliacoes_v2/patch_estabelecimento_saque_troco_pix_by_ponto_atendimento_id | Atualiza pontos de atendimento de um agente de saque | ponto_atendimento_id (string) data: { . id_ponto_atendimento (string) . nome (string) . latitude (string) . longitude (string) . logradouro (string) . bairro (string) . cidade (string) . estado (string) . cep (string) . produtos . observacoes (string) . horarios_funcionamento (array) } (object) required |
| pix_recebimentos_conciliacoes_v2/post_boletos_pix | API responsável por efetuar a emissão de um boleto + Pix. Obs: Por regras internas não é permitido o uso de caracter especial, tais como os exemplos: “ “ , “ : “ , “ ” , “ ” , “ and ” , “ ; ” , “ ' “ , “ ' “ , “ “ , “ “ , “ “ , “ “ , “ “ , “ / “ , “ | “ , “ “ , “ ü ” , “ http “ , “ javascript “ , “ alert “ | x-itau-correlationID (string) data: { . etapa_processo_boleto (string) . codigo_canal_operacao (string) . beneficiario (object) . dado_boleto (object) . dados_qrcode } (object) required |
| pix_recebimentos_conciliacoes_v2/post_boletos_pix_indireto | EM CONSTRUÇÃO Emissão de bolecode para participantes indiretos do PIX | x-itau-correlationID (string) data: { . etapa_processo_boleto (string) . beneficiario . dado_boleto . dados_qrcode } (object) required |
| pixautomatico_v1/post_locrec | Criar location do payload | Content-Type (string) required |
| pixautomatico_v1/get_locrec | Endpoint para consultar locations cadastradas | inicio (string) required fim (string) required idRecPresente (boolean) convenio (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-itau-correlationID (string) required |
| pixautomatico_v1/get_locrec_by_id | Recupera a location do payload | id (string) x-itau-correlationID (string) required |
| pixautomatico_v1/delete_locrec_by_id_id_rec | Endpoint utilizado para desvincular uma recorrência de uma location. | id (string) |
| pixautomatico_v1/get_token_rec_by_rec_url_access_token | Endpoint location que serve um payload que representa uma recorrência. No momento em que o usuário pagador efetua a leitura de um QR Code composto gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível nesse linkhttps://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados. | recUrlAccessToken (string) x-itau-correlationID (string) required |
| pixautomatico_v1/put_webhookrec | Endpoint opcional para configuração do serviço de notificações acerca de recorrências. Somente recorrências associadas ao usuário recebedor serão notificadas Para que o usuário recebedor possa receber notificações acerca do status de uma cobrança, é necessário que o usuário recebedor crie e proveja sua própria API de recebimento de notificações, de acordo com as especificações do Bacen e conforme a aba 'Callback' abaixo, para acionamento. Este endpoint, PUT /webhookcobr, deve ser chamado para ca | x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/get_webhookrec | Endpoint para cancelamento do webhook. Caso o parceiro queira parar de receber notificações sobre recorrência, pode utilizar este endpoint. O parceiro pode reativar o recebimento de notificações a qualquer momento por meio do enpoint PUT. | x-itau-correlationID (string) required |
| pixautomatico_v1/delete_webhookrec | Endpoint para cancelamento do webhook. Caso o parceiro queira parar de receber notificações sobre recorrência, pode utilizar este endpoint. O parceiro pode reativar o recebimento de notificações a qualquer momento por meio do enpoint PUT. | x-itau-correlationID (string) required |
| pixautomatico_v1/put_webhookcobr | Endpoint opcional para configuração do serviço de notificações acerca de recorrências. Somente recorrências associadas ao usuário recebedor serão notificadas Para que o usuário recebedor possa receber notificações acerca do status de uma cobrança, é necessário que o usuário recebedor crie e proveja sua própria API de recebimento de notificações, de acordo com as especificações do Bacen e conforme a aba 'Callback' abaixo, para acionamento. Este endpoint, PUT /webhookcobr, deve ser chamado para ca | x-itau-correlationID (string) required Content-Type (string) required data: { . webhookUrl (string) } (object) required |
| pixautomatico_v1/get_webhookcobr | Endpoint para recuperação de informações sobre o Webhook. Neste endpoint, obtenha informações sobre qual URL foi cadastrada pelo parceiro para recebimento de notificações e data de criação. | x-itau-correlationID (string) required |
| pixautomatico_v1/delete_webhookcobr | Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. | x-itau-correlationID (string) required |
| pixautomatico_v1/get_rec_by_id_rec | Consultar recorrência. | idRec (string) txid (string) x-itau-correlationID (string) required |
| pixautomatico_v1/patch_rec_by_id_rec | Revisar recorrência. | idRec (string) x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/get_rec | Consultar lista de recorrências. | inicio (string) required fim (string) required cpf (string) cnpj (string) convenio (string) locationPresente (boolean) status (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-itau-correlationID (string) required |
| pixautomatico_v1/post_rec | Criar recorrência | x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/post_solicrec | Criar solicitação de confirmação de recorrência. | x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/get_solicrec_by_id_solic_rec | Consultar solicitação. | idSolicRec (string) x-itau-correlationID (string) required |
| pixautomatico_v1/patch_solicrec_by_id_solic_rec | Revisar solicitação de confirmação de recorrência. | idSolicRec (string) x-itau-correlationID (string) required Content-Type (string) required data: { . status (string) } (object) required |
| pixautomatico_v1/put_cobr_by_txid | Endpoint para criar uma cobrança recorrente. | txid (string) x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/patch_cobr_by_txid | Endpoint para revisar uma cobrança recorrente. | txid (string) x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/get_cobr_by_txid | Endpoint para consultar uma cobrança recorrente através de um determinado txid. | txid (string) x-itau-correlationID (string) required |
| pixautomatico_v1/post_cobr | Endpoint para criar uma cobrança recorrente, neste caso, o txid deve ser definido pelo PSP. | x-itau-correlationID (string) required Content-Type (string) required data (object) required |
| pixautomatico_v1/get_cobr | Endpoint para consultar cobranças recorrentes através de parâmetros como início, fim, idRec, cpf, cnpj, status e convênio. | inicio (string) required fim (string) required idRec (string) cpf (string) cnpj (string) convenio (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) x-itau-correlationID (string) required |
| pixautomatico_v1/post_cobr_by_txid_retentativa_by_data | Endpoint para solicitar retentativa de uma cobrança recorrente. | txid (string) data (string) x-itau-correlationID (string) required Content-Type (string) required |
| qrcode_pix_automatico_v1/post_cobrancas | Endpoint para emitir um QR Code imediato ou QR Code de vencimento de Pix Automático. | x-itau-correlationID (string) data (object) required |
| qrcode_pix_automatico_v1/patch_cobrancas_by_cobranca_id | Endpoint para Cancelar um QR Code imediato ou QR Code de vencimento de Pix Automático. | cobrancaId (string) x-itau-correlationID (string) data: { . status (string) . recorrencia (object) } (object) required |
| sispag/post_transferencias | API responsável por inserir transferências de Pix e pagamentos de Pix QR Code na plataforma SISPAG do Banco Itaú. | x-itau-flowID (string) x-itau-correlationID (string) data: { . pix_link (string) . emv (string) . url (string) . chave (string) . ispb (string) . tipo_identificacao_conta (string) . agencia_recebedor (string) . conta_recebedor (string) . tipo_de_identificacao_do_recebedor (string) . identificacao_recebedor (string) . status_pagamento (string) . cod_pagamento (string) . numero_lote (string) . numero_lancamento (string) . tipo_pagamento (string) . data_pagamento (string) . valor_pagamento (number) . referencia_empresa (string) . identificacao_comprovante (string) . informacoes_entre_usuarios (string) . pagador . recebedor . motivo_recusa (array) } (object) required |
| sispag/get_pagamentos_sispag | Detalhe da consulta de pagamentos e transferências | agencia_operacao (string) required conta_operacao (string) required cnpj_empresa (string) required numero_lote (string) valor_minimo (number) valor_maximo (number) referencia_empresa (string) nome_beneficiario (string) data_inicial (string) data_final (string) tipo_lista (string) required modalidade_fornecedores (boolean) modalidade_impostos (boolean) modalidade_salario (boolean) status (string) tipo_pagamento (string) order_by (string) order (string) page (number) page_size (number) x-itau-flowID (string) x-itau-correlationID (string) |
| sispag/get_pagamentos_sispag_by_id_pagamento_sispag | Operação responsável por recuperar o detalhamento do pagamento | id_pagamento_sispag (string) |