ManualAPI_Recebimentos_Pix_Itaú_v1

Prévia do material em texto

Manual de API Recebimentos - Cash 
Management 
Sumário 
 Histórico de revisão 
 Sobre a solução 
o Chave Pix 
o QR Code 
o Conciliação 
 Como começar 
o Autenticação 
 Fluxo de autenticação – OAuth 2.0 
o Informações necessárias 
 Token 
 Intervalo para nova autenticação 
 Credenciais 
 Headers 
 x-itau-apikey 
 x-itau-flowID 
 x-itau-correlationID 
 Authorization 
 Padrão de erros 
 End Point Raiz 
 Exemplo de POST 
 API Pix 
o [POST] Emissão de QR Code dinâmico 
 Parâmetros de entrada 
 Exemplo de entrada 
 Códigos de status 
 Exemplo de saída 
o [POST] Emissão de QR Code estático 
 Parâmetros de entrada 
 Exemplo de entrada 
 Códigos de status 
 Exemplo de saída 
o [POST] Decodificação de QR Code (EMV) 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada: QR Code estático 
 Exemplo de saída: QR Code estático 
 Exemplo de entrada: QR Code dinâmico 
 Exemplo de saída: QR Code dinâmico 
o [POST] Decodificação de Pix Link 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada: QR Code estático 
 Exemplo de saída: QR Code estático 
 Exemplo de entrada: QR Code dinâmico 
 Exemplo de saída: QR Code dinâmico 
o [POST] Devolução APIREC 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada 
 Exemplo de saída 
o [PATCH] Cancelar Qr Code por documento 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada 
 Exemplo de saída 
o [PUT] Cancelar Qr Code APIREC (por identificador) 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada 
 Exemplo de saída 
o [PATCH] Alterar Qr Code dinâmico por documento (altera txid ativo) 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada 
 Exemplo de saída 
o [PUT] Alterar Qr Code dinâmico APIREC (por identificador) 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de entrada 
 Exemplo de saída 
o [GET] Consultar Lista Motivos da Devolução Pix 
 Parâmetros de entrada 
 Códigos de status 
 Exemplos de saída: basic 
 Exemplos de saída: full 
o [GET] Consultar lista de Histórico do Qr Code 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída 
o [GET] Consultar lista de lançamentos PIX 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída: Visão completa Emissor 
 Exemplo de saída: Visão resumida Emissor 
 Exemplo de saída: Visão completa Pagador 
 Exemplo de saída: Visão resumida Pagador 
o [GET] Consultar detalhe do Lançamento 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída 
o [GET] Consultar lista de Qr Codes / transferências 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída: Lista de PIX padrão visão completa 
 Exemplo de saída: Lista de PIX padrão visão resumida 
 Exemplo de saída: Lista de PIX dinâmico visão resumida 
 Exemplo de saída: Lista de PIX dinâmico visão completa 
 Exemplo de saída: Lista de PIX estático visão completa 
 Exemplo de saída: Lista de PIX com devolução visão completa 
o [GET] Consultar detalhe do QR Code / transferência 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída: Consulta de PIX estático 
 Exemplo de saída: Consulta de PIX dinâmico 
 Exemplo de saída: Consulta de devolução 
o [GET] Consultar Movimentação detalhada Pix 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída: Lista de movimentos 
o [GET] Consultar resumo posição consolidada 
 Parâmetros de entrada 
 Códigos de status 
 Exemplo de saída: Lista de data movimentos 
Histórico de revisão 
Data Versão Descrição das alterações 
01/09/2020 1 Autenticação JWKS e mTLS 
Sobre a solução 
Pix é mais uma forma de pagar, transferir e receber. 
Com Pix é possível receber pagamentos e transferências, 24 horas por dia, 365 dias no ano, 
inclusive aos finais de semana e feriados. O crédito cai na hora, inclusive entre diferentes 
instituições 
Chave Pix 
Com a chave Pix, sua empresa recebe transferências e pagamentos a partir de um único 
identificador como CNPJ, número de celular, e-mail ou chave aleatória. É muito mais 
facilidade para o dia a dia, uma vez que com apenas uma informação, sua empresa poderá 
realizar as transações, de forma rápida, conveniente e segura 
Para a emissão de QR Codes é necessário o cadastro de pelo menos uma chave Pix. 
QR Code 
Sua empresa pode gerar QR Codes e compartilhar com seus clientes a imagem ou link para 
facilitar o pagamento. 
Os Qr Codes podem ser lidos pelo smartphone do seu pagador e o link utilizado de 
qualquer dispositivo. Será possível utilizar dois tipos de QR Code: Dinâmico ou Estático. 
Com o QR Code estático será possível receber pagamentos sem precisar cadastrar um 
valor fixo a ele. O valor poderá ser preenchido pelo pagador no momento em que for 
realizado o pagamento. Já um QR Code dinâmico apresentará as informações específicas 
daquela transação, como valor e multa, sendo ideal para transações únicas. 
Conciliação 
Informação disponibilizada no melhor tempo e formato para atender as necessidades da 
sua empresa (imediato ou sob demanda). 
 
Como começar 
O objetivo desta documentação é orientar o desenvolvedor sobre como integrar com a 
solução de APIs para o PIX do Itaú. Apresentaremos no decorrer desse documento as 
informações necessárias para compreender o fluxo dos dados entre as APIs, dicas que 
auxiliarão no momento da implantação e exemplos. 
Autenticação 
Para começar a sua jornada de desenvolvimento é importante que o ambiente esteja 
preparado e configurado para realizar os testes e suportar o desenvolvimento da aplicação 
de maneira segura. Nosso modelo de comunicação atual requer a autenticação do parceiro 
através do fluxo OAuth 2.0. 
Fluxo de autenticação – OAuth 2.0 (Private KeyJWT e Mutual-TLS Client 
Authentication) 
Os fluxos de autenticação do oAuth 2.0 são baseados em obtenção de access_tokens que 
permitem a autenticação e autorização das APIs. O método previsto para as APIS do PIX do 
Itaú é o Private Key JWT Client Authentication (private_key_jwt) que consiste em 
autenticação no fluxo client_credentials baseada em chaves (privada e pública). 
Ambas as chaves são criadas pelo desenvolvedor que irá integrar com as APIs do Itaú. A 
chave privada, deve ser criada e armazenada de maneira segura dentro do ambiente da 
aplicação que consumirá as APIs e é utilizada para assinar todas as obtenções de 
access_tokens. A chave pública deve ser exposta em um terminal de configuração 
descoberta (well-known endpoint) em uma sessão específica conhecida como jwks_uri 
(JSON Web Key Sets – URI). A jwks_uri deve ser informada para o agente comercial Itaú no 
momento da contratação. Saiba mais em https://auth0.com/docs/tokens/json-web-
tokens/json-web-key-sets 
Para estabelecer conexão segura com os API Gateways do Itaú é necessário enviar um 
client certificate. Este certificado é usado para estabelecer o mTLS (OAuth 2.0 Mutual 
Transport Layer Security - https://tools.ietf.org/html/rfc8705): 
1. A partir de um client_id e token temporário para ativação, ambos fornecidos pelo 
agente comercial após a contratação, o desenvolvedor gera um arquivo CSR 
(Certificate Signing Request) baseado em um template e documentação será 
fornecida no nosso Portal do Desenvolvedor; 
2. O desenvolvedor solicita um certificado assinado pelo Itaú (CRT – Certificate File), 
através de uma API informando o CSR e token temporário de ativação; 
3. O desenvolvedor configura sua aplicação com o arquivo CRT, que será utilizado 
junto com o private_key_jwt para a obtenção de access_tokens e junto com o 
access_token para todas as chamadas de APIs. 
4. A renovação automática e revogação estão também documentadas no Portal do 
Desenvolvedor. 
Como conhecer e testar as APIs 
 
Após a contratação, seu agente comercial realizará o cadastro em nossos sistemas internos 
e enviará três informações importantes: uma credencial (client_id) que será cadastrada 
com suas informações previamentefornecidas (inclusive o jwks_uri, citado anteriormente), 
token temporário de ativação e um código de registro para Portal do Desenvolvedor Itaú, 
no qual dará acesso à toda a documentação detalhada e referências técnicas, além de um 
ambiente sandbox para testes simulados. Com esse código, você se cadastra e pode 
cadastrar outros desenvolvedores de sua organização. 
 
Um exemplo de como será essa jornada 
1. O primeiro passo é criar um ‘projeto’ dentro do nosso portal, definindo o nome do projeto 
e quais APIs farão parte dele e, por fim, clicando no botão "Criar Projeto" para finalizar a 
criação; 
2. Acesse a página da API e leia toda a documentação, com fluxos e exemplos. Isso, com 
certeza, vai ajudar você a diminuir o tempo e a dificuldade na construção; 
3. Dentro da documentação, além das informações referentes ao processo, você encontrará 
as especificações técnicas de cada API, métodos, parâmetros de entrada (requests) e de 
retorno (responses); 
4. Em seguida, você terá a possibilidade de selecionar a aplicação criada para seu projeto 
(passo 1), simular uma autorização (obtendo um access_token) e simulando uma chamada 
da API, após o preenchimento dos campos obrigatórias e opcionais; 
5. Se houver dúvidas ou problemas de acesso você poderá contar com o time comercial para 
melhor direcionar os pontos que necessitam de atuação ou melhoria em nossa 
documentação. Contamos sua colaboração nessa jornada! 
 
Para testar as APIs do sandbox diretamente de sua aplicação, basta obter um cliente_id 
de uma aplicação criada no Portal do Desenvolvedor e private_key_jwt global (que estará 
disponível nas informações adicionais da aplicação) e realizar as chamadas diretamente 
para as URIs de obtenção de access_tokens e de APIs do sandbox. As URIs estarão 
disponíveis no Portal. 
Intervalo para obtenção de access_tokens 
 O access_token é muito eficiente quando utilizado diversas vezes antes de expirar (tempo 
padrão de 5 minutos), portanto é importante que sua implementação de código preveja 
obter novo access_token somente quando estiver perto de expiração do access_token 
corrente. Isso evita fluxo desnecessário de autorização e garante mais performance para 
seu sistema ou aplicativo. 
Padrão de Erros 
Há um padrão de retorno para todos os erros na API. Esse padrão segue uma estrutura 
específica, podendo apenas variar os valores existentes nos campos. 
No exemplo a seguir, o campo id_transferencia não foi enviado no Body da requisição. 
{ 
 "codigo": "400", 
 "mensagem": "Erro na validação", 
 "campos": [ 
 { 
 "campo": "id_transferencia", 
 "mensagem": " Devolução não concluída. A devolução é limitada a transações 
realizadas nos últimos 90 dias", 
 "valor": " " 
 } 
 ] 
} 
End Point Raiz 
Após realizar a chamada ao autorizador, o parceiro deverá chamar a API de PIX desejada. A 
URL base da API está definida como 
https://apisp.dev.aws.cloud.ihf/cash_management/v1/nomeAPI, sendo “nomeAPI” a 
variável conforme a API a ser chamada. Todas as requisições devem usar o schema 
https por questões de segurança. 
Parâmetros comuns de cabeçalho 
Para consumo das APIs do Itaú, alguns parâmetros de cabeçalho são necessários: 
x-itau-apikey 
O x-itau-apikey é um parâmetro que será requerido em todas as chamadas das APIs que 
contemplam essa solução. A informação que deve ser usada nesse campo é o código 
gerado através da autenticação OAuth 2.0 para o client_id. Para saber como gerar o 
client_id ou como recuperar as informações de códigos já gerados basta acessar a etapa de 
‘autenticação’ desse tutorial. 
x-itau-flowID 
A implementação de um flowID permite identificar qual é a funcionalidade de negócio 
sendo executada na aplicação. Por exemplo, dentro de uma mesma aplicação, várias telas 
ou linhas de negócio diferentes podem acessar a mesma API. Quando é identificado que 
algumas chamadas a uma determinada API estão dando erro, através do flowID, podemos 
descobrir que as chamadas são de uma tela específica e com isso solucionar o problema 
mais rápido do que se não tivéssemos essa informação no log. Ter o flowID nos logs 
também permite extrair algum tipo de métrica através do log. Recomenda-se mandar um 
uuid version 4 nesse campo como: b47ec51b-b2a7-4a78-933c-f0b67667e7dc. 
x-itau-correlationID 
A implementação de um correlationID permite relacionar uma mesma chamada passando 
em diversas aplicações/sistemas diferentes, conseguindo fornecer um mapeamento de 
ponta-a-ponta. Por exemplo, uma aplicação client gera uma chamada à API, neste 
momento fornecendo o correlationID gerado pelo consumidor, o qual é repassado em 
todas as camadas/microserviços que a api precisa para realizar determinada 
funcionalidade. É importante lembrar que o header x-itau-correlationID deve sempre ser 
diferente a cada requisição. Recomenda-se mandar um uuid version 4 nesse campo como: 
a1e64241-7fdb-4d05-a7f6-c44febcdd8d9. 
Body: 
Campos de entrada descritos nas outras seções. 
APIs de Recebimentos Pix 
Os itens a seguir detalham as funcionalidades disponibilizadas nas API do Itaú para o Pix. 
Sua empresa pode desfrutar de todas as visões e opções criadas ou utilizar apenas os 
campos padronizados pelo Banco Central (APIREC).
 
Fonte: https://www.bcb.gov.br/ 
Emissão de Qr Code Dinâmico 
POST /cash_management/v1/documentos 
API responsável por efetuar a emissão de um QR Code Dinâmico. No momento da emissão 
do QR Code, serão validados os campos obrigatórios bem como os campos de domínios 
definidos no contrato da API. Além disso, também serão validadas as regras de negócio de 
acordo com o tipo de QR Code emitido, com base nos parâmetros enviadas no corpo da 
requisição. 
A seguir os objetos que serão utilizados na Emissão do QR Code. 
 
 
 
 
 
 
Comentado [ACMS1]: Não entendi essa frase 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâme
tro 
Tipo 
Dado 
Presenç
a 
Descrição Observação 
Reutilizável body boolean opcional 
Indicador se o QR 
Code pode ser 
reutilizável. 
Padrão de retorno é 
False 
tipo_reutilizacao body string opcional 
Indicador de tipo 
da Reutilização (Ex: 
manual ou 
automático). 
Enviar apenas se 
reutilizável for True 
Chave body string 
obrigató
rio 
Chave Pix do 
Sistema DICT - 
BACEN. 
- 
Txid body string opcional 
ID de identificação 
do documento 
entre os bancos e o 
cliente emissor. 
O campo Identificador 
(txid) é obrigatório e 
determina o 
identificador da 
transação, 
transactionID. O 
objetivo desse campo 
é ser um elemento que 
possibilite a 
conciliação de 
pagamentos. 
Ele deve ser único para 
cada agência e conta 
do Recebedor. 
O identificador pode 
ser informado pelo 
cliente ou gerado 
automaticamente pelo 
Itaú. 
No envio desse campo, 
será verificada sua 
unicidade. Caso ele 
não seja único para a 
ag/conta associada 
a chave Pix o registro 
será rejeitado. 
calendario.expiracao body dateti
me 
opcional 
Data e Hora de 
expiração do 
documento - yyyy-
MM-
dd'T'hh:mm:ss.z'Z'. 
Indica com 
granularidade de 
segundos a data e 
hora limite para 
pagamento do Qr 
Code. Não pode ser 
preenchido junto com 
calendário.vencimento 
calendario.vencimento body 
date-
only opcional 
Data de 
vencimento do 
documento - yyyy-
MM-dd. 
Não pode ser 
preenchido junto com 
calendário.expiracao. 
Comentado [ACMS2]: Data e hora de expiração do 
documento 
Comentado [ACMS3]: Junto com o campo 
calendário.vencimento 
Comentado [ACMS4]: o campo calendário.expiracao 
Parâmetro 
Tipo 
Parâme
tro 
Tipo 
Dado 
Presenç
a 
Descrição Observação 
calendario.recebivel_apos_ve
ncimento 
body boole
an 
opcional 
Trata-se de um 
campo booleano 
ou uma flag. 
Quando seu valor 
for true, significa 
que a cobrança 
pode ser paga 
após o vencimento. 
Quando esse 
campo não estiver 
presente, assume-
se o valor false, ou 
seja, a cobrança 
não pode ser paga 
após o vencimento. 
Essa semântica se 
aplica somente 
a calendario.venci
mento. 
Padrão de retorno é 
False 
calendario.multa body date-only opcionalData de referência 
para aplicação da 
multa no valor 
calculado da 
cobrança. 
Deve ser maior que a 
data de vencimento. 
calendario.desconto body date-only opcional 
Data de referência 
para aplicação de 
desconto no valor 
calculado da 
cobrança. 
Deve ser igual ou 
inferior a data de 
vencimento. 
calendario.juros body date-only opcional 
Data de referência 
para aplicação da 
juros no valor 
calculado da 
cobrança. 
Deve ser maior que a 
data de vencimento. 
info_adicionais body array opcional - 
info_adicionais.nome body string opcional 
Nome da chave da 
informação 
(Tamanho máximo 
= 50). 
Se for enviado, é 
necessário o envio do 
campo 
info_adicionais.valor 
info_adicionais.valor body string opcional 
Valor da 
informação 
(Tamanho máximo 
= 200). 
Se for enviado, é 
necessário o envio do 
campo 
info_adicionais.nome 
valor.original body 
numb
er 
obrigató
rio 
Valor 
nominal/cadastro 
do QR Code. 
- 
valor.juros body numb
er 
opcional Valor do juros ao 
mês por atraso de 
Só deverá ser 
preenchido quando a 
Parâmetro 
Tipo 
Parâme
tro 
Tipo 
Dado 
Presenç
a 
Descrição Observação 
pagamento do QR 
Code. 
data de vencimento 
estiver preenchida. 
valor.multa body numb
er 
opcional 
Valor da multa por 
atraso de 
pagamento do QR 
Code. 
Só deverá ser 
preenchido quando a 
data de vencimento 
estiver preenchida. 
valor.desconto body numb
er 
opcional 
Desconto aplicado 
a cobrança até a 
data determinada. 
Só deverá ser 
preenchido quando a 
data de vencimento 
estiver preenchida. 
valor.permite_alteracao body boolean opcional 
Indicador se valor 
da cobrança pode 
ser alterado 
durante o 
pagamento. 
Padrão de retorno é 
False. 
valor.porcentagem_juros body numb
er 
opcional 
Porcentagem de 
juros ao mês a ser 
aplicada no cálculo 
do valor de juros. 
Só deverá ser 
preenchido quando a 
data de vencimento 
estiver preenchida. 
valor.porcentagem_desconto body number opcional 
Porcentagem de 
desconto a ser 
aplicada no cálculo 
do valor de 
desconto. 
Só deverá ser 
preenchido quando a 
data de vencimento 
estiver preenchida. 
valor.porcentagem_multa body number opcional 
Porcentagem de 
multa ao mês a ser 
aplicada no cálculo 
do valor de juros. 
Só deverá ser 
preenchido quando a 
data de vencimento 
estiver preenchida. 
pagador.cpf body string opcional 
Número do 
Documento 
Cadastro de Pessoa 
Física. 
Apenas CPF. (não 
enviar 
o pagador.cnpj). 
pagador.cnpj body string opcional 
Número do 
Cadastro Nacional 
da Pessoa Jurídica. 
Apenas CNPJ(não 
enviar o pagador.cpf). 
pagador.nome body string opcional Nome do pagador 
do QR Code. 
- 
qrcode_pix.tipo body string obrigatório 
Tipo do QR Code. 
(Estático 
 ou Dinâmico ) 
Obrigatório que seja 
do tipo dinâmico 
qrcode_pix.participante_indi
reto.ispb body string opcional 
Uso exclusivo do 
participante 
indireto) 
Identificador do 
Sistema de 
Pagamentos Brasileiros 
do pagador do PIX. 
Comentado [ACMS5]: Retirar 
Comentado [ACMS6]: Não vale tirar isso? 
Parâmetro 
Tipo 
Parâme
tro 
Tipo 
Dado 
Presenç
a 
Descrição Observação 
qrcode_pix.recebedor.cnpj body string opcional 
Número do 
Cadastro Nacional 
da Pessoa Jurídica. 
Apenas CNPJ (não 
enviar junto 
o qrcode_pix.recebed
or.cnpj. 
qrcode_pix.recebedor.cpf body string opcional 
Número do 
Documento 
Cadastro de Pessoa 
Física. 
Apenas CPF (não 
enviar junto 
o qrcode_pix.recebed
or.cpf. 
Códigos de status 
Código Descrição 
200 Documento recuperado com sucesso. 
201 Documento criado com sucesso. 
400 Erros de validação ou os campos informados. Verifique na resposta da API os 
campos informados. 
404 Chave não encontrada. 
406 Não encontra nenhum conteúdo seguindo os parâmetros fornecidos na 
entrada. 
422 Dados informados estão fora do escopo definido para o campo. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de Entrada 
{ 
 "chave":"teste@itau.com", 
 "pagador":{ 
 "cpf":"41034181840", 
 "nome":"Nome de Teste" 
 }, 
 "pago": true, 
 "valor":{ 
 "original":9999.00, 
 "juros":120.00, 
 "desconto":30.00, 
 "permite_alteracao":true, 
 "porcentagem_multa": 10 
 }, 
 "calendario":{ 
 "vencimento":"2020-09-28" 
 }, 
 "info_adicionais":[ 
Comentado [ACMS7]: Apenas CNPJ. Não enviar em 
conjunto com o qrcode_pix.recebedor.cpf 
Comentado [ACMS8]: Apenas CPF. Não enviar em 
conjunto com o qrcode_pix.recebedor.cnpj 
Comentado [ACMS9]: Esse payload não funcionaria, pois 
temos desconto e não temos data de vencimento. Devemos 
tirar expiração e colocar vencimento ou tirar desconto, juros 
e multa 
 { 
 "nome":"Detalhes do Pagamento", 
 "valor":"Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "qrcode_pix":{ 
 "tipo":"dinamico", 
 "recebedor":{ 
 "cnpj":"11720489000112" 
 }, 
 "reutilizavel":false, 
 } 
} 
Exemplo de saida 
 (status = 201, application/json) 
{ 
 "data": { 
 "id_documento": "d7bf4f82-b322-4cc0-9e0f-fb9760594a18", 
 "chave": "teste@itau.com", 
 "txid": "1Rv31MFC0WiHeYfTJwQFRU", 
 "documento_revisao": { 
 "id_documento_revisao": "d7bf4f82-b322-4cc0-9e0f-fb9760594a18", 
 "revisao": 0 
 }, 
 "status": "a_pagar", 
 "pago": false, 
 "devolvido": false, 
 "pagador": { 
 "cpf": "41034181840", 
 "nome": "Nome de Teste" 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-08-31T10:55:48.95Z", 
 "vencimento": "2020-09-28", 
 "recebivel_apos_vencimento": true, 
 "multa": "2020-06-30", 
 "desconto": "2020-08-20", 
 "juros": "2020-08-20" 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
Comentado [ACMS10]: Temos que trazer um exemplo de 
CNPJ 
Comentado [ACMS11]: Vamos dar um exemplo sem 
reutilização? 
Comentado [ACMS12]: Precisamos ajustar a questão de 
data de expiração e juros 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "url": "https://spi.dev.cloud.itau.com.br/documentos/d7bf4f82-b322-4cc0-9e0f-
fb9760594a18", 
 "qrcode_pix": { 
 "simulacao": false, 
 "tipo": "dinamico", 
 "padrao": false, 
 "status": "ativo", 
 "reutilizavel": false, 
 "recebedor": { 
 "cnpj": "11720489600012", 
 "nome": "ITAU PORTABILIDADE REIVINDICACAO", 
 "tipo_chave": "email", 
 "chave_enderecamento": "teste@itau.com", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00596117" 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuZGV2LmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZDdiZjRmODItYjMyMi00Y2MwLTllMGYtZmI5NzYwNTk0YTE4NTIwN
DAwMDA1MzAzOTg2NTQwNzk5OTkuMDA1ODAyQlI1OTI1SVRBVSBQT1JUQUJJTElEQURFIFJFSVZJTjYwMDlTQU8gUEF
VTE82MjYwMDUyMjFSdjMxTUZDMFdpSGVZZlRKd1FGUlU1MDMwMDAxN0JSLkdPVi5CQ0IuQlJDT0RFMDEwNTEuMC4wN
jMwNEI0RjY=", 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.dev.cloud.itau.com.br/documentos/d7bf4f82-b322-
4cc0-9e0f-fb9760594a1852040000530398654079999.005802BR5925ITAU PORTABILIDADE REIVIN6009SAO 
PAULO626005221Rv31MFC0WiHeYfTJwQFRU50300017BR.GOV.BCB.BRCODE01051.0.06304B4F6", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAEo0lEQVR4Xu2YQY6jMBBFjbzwDi6A5Guw40pwARIuE
K7kHddA4gJhx8JKzStH6qSzGI1ka1ZBSN0Nr2W7/Ou7CiN/v4L5fPJxfYHn9QWe1xd4Xv8GbMbsR2jrbn90bXPaq9m
vvb8aWw7Y5dyXVR79VklsxN/NzsOF5+WAayezyHzu82lvXTs4u4T9plhJ4NbLvbd301bSVquX4EsD2yhy7QxX3dmbs
Vf3MYdcgEjq7jg7B1nEP4w/TvkIdR6gerh1n/eHYPKAxLh2cuiNLTMXsQDPF4WArQk7O7XwNpja7Q9nJmdM/5pkPjA
5kVWO1R+rGddtXFvuwfhywP4wcQx+DlvFW7YptBXy7l+7WQDo26GPU6dDX844uZ35oLpyQBw6Fdi1I5hb7bYJPThE8
rPMfIA5mMlY9kvCNjiCqdoYg5QDGHTDHmdSnqE75MefsQqvxMkG9jsjrnIn9525rHJzZE0cnC8HJFXjY+otZKVOaejaqZNyQKyYQCfH6Y+AsJnPppFcX3rIBhjULytbpgA8hoOVLb9CnQlg9SzKcqDcEMPZNpqkhLckIEHuzh4ciA63T6ruO
FB8SUBIeQWOsF3UcJ4mk/61DEAaEj2WZlkaVlAbf+8383KYfEBlLGIfTpn5aWKC5/tyQGRQxKwnl6EQSmeWwydtOSA
tzbUVboxP6h0vajI/c8gHNp1DT6FlVRgaQJa8Ta/6IR+QQ324xb4YnSTCzRYxzZtgsgGiZ2dJAXw6jEF1v6qgbCBWQ
qFL9LAa/1BJq+FfdAqlAIYzeDtKOIKhXKwNhonnvyaZDeAwpHy8SJyMLGsc0TOe5n7mkA/o6MtKccU27cB1jwjtm8P
kAzzhHPTJ7WXWKoioqjMXBIyxR8BkkLepVRIEliP4JftsgF/aUSIyGMhQHpxxPN/dPh/gWI91bxrGpRalX8NnDKWXL
whce85BLeTGEyWo21OjzqstBzAiMdyqIA/t0fCBVg/fsyRw780YLG3UoJ2OmRypShh9SaBLYgtom37K1L0qXKvHcgD
RIzFHtceWZgerQRvYTjkgqqX0qetcRX0YnwlasZQDNu1rtJPS+uruqEXj0KsblwPQAzulNzJLhrZfnU+HVymAo9A0G
D611tmmEkjXi+GUAxBwOxlOdj+fhJEYcvv3Ti0biA31Z1qp9jj0BT2Jgyp+5pAPEDpSBnskXyxtDkVpjfO/0j8fYA5
a4s6iDkNFfahnahNdENBjt6cZ3I9TZ3IIi93fI5kPXLQKoo3al+Ax4WqNTbAcvuUAXrU80Q9WvfbL6djSz2LlAByGi
tRrdyA0ONso7ZASsxygDkn0Gt0dr7nZa27Ob5PMBtLbE42xWYZCiLqLVS9vFWk2EOsO41KfrPRrEhUpPmPearl8QKe
hMtAvPNRyzwbBPjpfDtBOberagdWpqvV3ncavMikTSN8nnYr5om2aqDCYg7MFAbJGPw7THXR0zalZc8Z0ZYF4CeQjP
hBrh73ESasIKQrs+m1Bxcz5KOlPStP3OeQCcm4NP4mkbMnkqVWoUV9zyAbQA4YvS2rJJ63rtLpr5F0wmcDfri/wvL7
A8/oCz+t/AH8Adh/JASNSN5EAAAAASUVORK5CYII=" 
 } 
Comentado [ACMS13]: Ajustar para exemplo de CNPJ 
Comentado [ACMS14]: Por que temos “chave” e 
“chave_enderecamento” no retorno? 
 } 
} 
Emissão de Qr Code Estático 
POST /cash_management/v1/documentos 
API responsável por efetuar a emissão de um QR Code Dinâmico. No momento da emissão 
do QR Code, serão validados os campos obrigatórios bem como os campos de domínios 
definidos no contrato da API. Além disso, também serão validadas as regras de negócio de 
acordo com o tipo de QR Code emitido, com base nos parâmetros enviadas no corpo da 
requisição. 
A seguir os objetos que serão utilizados na Emissão do QR Code. 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâme
tro 
Tipo 
Dado 
Presenç
a Descrição Observação 
Chave body string obrigató
rio 
Chave de 
endereçame
nto do 
Sistema DICT 
- BACEN. 
- 
txid body string opcional 
ID de 
identificação 
do 
documento 
entre os 
bancos e o 
cliente 
emissor. 
O campo Identificador (txid) é 
obrigatório e determina o 
identificador da transação, 
transactionID. O 
objetivo desse campo é ser 
um elemento que possibilite a 
conciliação de pagamentos. 
Ele deve ser único para cada 
agência e conta do 
Recebedor. 
O identificador pode ser 
informado pelo cliente ou 
gerado automaticamente pelo 
Itaú. 
No envio desse campo, será 
verificada sua unicidade. Caso 
ele não seja único para a 
ag/conta associada 
a chave Pix o registro será 
rejeitado. 
mensagem body string opcional 
Mensagem 
de descritiva 
usada na 
emissão do 
tipo estático. 
- 
Comentado [ACMS15]: Não entendi essa frase 
Comentado [ACMS16]: ID de identificação do 
documento entre os bancos e o cliente emissor. 
Parâmetro 
Tipo 
Parâme
tro 
Tipo 
Dado 
Presenç
a 
Descrição Observação 
valor.original body numb
er 
opcional 
Valor 
nominal/cad
astro do QR 
Code. 
- 
qrcode_pix.tipo body string obrigatório 
Tipo do QR 
Code. Pode 
ser Estático 
ou Dinâmico. 
Deve ter o valor "estatico" 
qrcode_pix.recebedor.cpf body string opcional 
Número do 
Cadastro 
Nacional da 
Pessoa 
Jurídica. 
- 
qrcode_pix.participante_indi
reto.ispb body string opcional 
Identificador 
do Sistema 
de 
Pagamentos 
Brasileiros do 
pagador do 
PIX. 
Uso exclusivo do participante 
indireto 
qrcode_pix.recebedor.cnpj body string opcional 
Número do 
Cadastro 
Nacional da 
Pessoa 
Jurídica. 
Apenas CNPJ (não enviar 
junto 
o qrcode_pix.recebedor.cnpj. 
qrcode_pix.recebedor.cpf body string opcional 
Número do 
Documento 
Cadastro de 
Pessoa Física. 
Apenas CPF (não enviar junto 
o qrcode_pix.recebedor.cpf. 
 
Códigos de Status 
Código Descrição 
200 Documento recuperado com sucesso. 
201 Documento criado com sucesso. 
400 Erros de validação ou os campos informados. Verifique na resposta da API os 
campos informados. 
404 Chave não encontrada. 
422 Dados informados estão fora do escopo definido para o campo. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Comentado [ACMS17]: Vamos manter? 
Comentado [ACMS18]: Apenas CNPJ. Não enviar em 
conjunto com o qrcode_pix.recebedor.cpf 
Comentado [ACMS19]: Apenas CPF. Não enviar em 
conjunto com o qrcode_pix.recebedor.cnpj 
Exemplo de Entrada 
{ 
 "chave":"teste@itau.com", 
 "valor":{ 
 "original": 10.00 
 }, 
 "mensagem":"Mensagem de teste", 
 "qrcode_pix":{ 
 "tipo":"estatico", 
 "recebedor":{ 
 "cnpj":"12345678000234" 
 } 
 } 
} 
 
Exemplo de saída 
 (status = 201, application/json) 
{ 
 "data": { 
 "id_documento": "8fc1b6c7-84bd-4d72-875e-97163c7b80c4", 
 "chave": "teste@itau.com", 
 "txid": "6fyrb2DYCKGzfW4IYBPZHy", 
 "documento_revisao": { 
 "id_documento_revisao": "8fc1b6c7-84bd-4d72-875e-97163c7b80c4", 
 "revisao": 0 
 }, 
 "status": "a_pagar", 
 "pago": false, 
 "devolvido": false, 
 "valor": { 
 "original": "10.00", 
 "permite_alteracao": false, 
 "final": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-08-31T11:02:06.94Z", 
 "recebivel_apos_vencimento": false 
 }, 
 "mensagem": "Mensagem de teste", 
 "url": "https://spi.dev.cloud.itau.com.br/documentos/8fc1b6c7-84bd-4d72-875e-
97163c7b80c4", 
 "qrcode_pix": { 
 "simulacao": false, 
 "tipo": "estatico", 
 "padrao": false, 
 "status": "ativo", 
 "reutilizavel": false, 
Comentado [ACMS20]: Ajustar para CNPJ 
Comentado [ACMS21]: Id_documento para QR Code 
estático? 
Comentado [ACMS22]: Estático gera revisão? 
 "recebedor": { 
 "cnpj": "12345678000234", 
 "nome": "ITAU PORTABILIDADE REIVINDICACAO", 
 "tipo_chave": "email", 
 "chave_enderecamento": "teste@itau.com", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00596117" 
 } 
 } 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjEyMjY2MjAwMTRCUi5HT1YuQkNCLlBJWDAxMTlsYWlzMTIzNDU
2QGl0YXUuY29tMDIxN01lbnNhZ2VtIGRlIHRlc3RlNTIwNDAwMDA1MzAzOTg2NTQwNTEwLjAwNTgwMkJSNTkyNUlUQ
VUgUE9SVEFCSUxJREFERSBSRUlWSU42MDA5U0FPIFBBVUxPNjI2MDA1MjI2ZnlyYjJEWUNLR3pmVzRJWUJQWkh5NTA
zMDAwMTdCUi5HT1YuQkNCLkJSQ09ERTAxMDUxLjAuMDYzMDRENUZF", 
 "emv": "00020101021226620014BR.GOV.BCB.PIX0119lais123456@itau.com0217Mensagem de 
teste520400005303986540510.005802BR5925ITAU PORTABILIDADE REIVIN6009SAO 
PAULO626005226fyrb2DYCKGzfW4IYBPZHy50300017BR.GOV.BCB.BRCODE01051.0.06304D5FE", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAENklEQVR4Xu2YMY6sOhBFCzkggw0gsQ0yttS9ARo2A
Fsi8zaQvAE6c4Cof4p+ATNfej+ws9/WBAw+Enb5um5Vi/59rPL7za/xBT7jC3zGF/iM/xUwihsl7N3xKN2k29C173W
TayoXsGhYdHutvA9L1CnqsgaNOYFZeH+IhCker3gUKoOEscsN+Fa9e2tTle3kde/yA8zunRSrFH4bekKaGSCSsx2Q8
nKBiW7vf4c6EUAPcxd+/v0WTCJwjebR6cQyiKQivz9vcwET++q2IjbSSSXNMzYVwbytIR2Yu6aI4ZSjkoOHsTyG0i1
3VScDU5SnbxfPAo5H19R6DH3Y+5zAsrKMdkHSfUskWQzae2QG+DfsbLNrKnG6brWy2ZzA2aFneUZhFOv26NqZbOZzA
qMwy+nIg1TZN4W6yfJMTkD98fRBNbCYJVqGWXwz9DmBRd0pupdHVW7PaNl+4uWP/JAKzNKepQgB7NxkkSRbynBdz1z
AXm6Pcnt5d/bNQ5rCE0xbRkZg0VbZadnw3dlEIRUPfU5ATQCoDqXxim2CBG5TTsCjNPTWSE+qJ0lySUkIOYEFvUX39
oeQvpiKm12i++VNBnbOqMfW0YO+16b24SxNhFkB3JY37bI2gxDJo/DYfU5gFCRhF19KqpQwCtleXreLkw6cOG/PZXS
kmqG7Yujbu+TSAY24CXskyfNMJKVeEXlOYO6ktuKKw8K2yDAIT6o+J/Dm1pghMksJgSG2V8LMCVjZU1I/mLOblVCRd
pTBOQFdcUYMpTULtgzQ6uchH/COQi396BwZrKZox3l5s+YEVA/pWxqQ5+quQs4ieS9604Gz2yx0aICmgAypVNfNXQ/
pwBQbLiMbnEt5KhZMm7AN11QuQPm6tQNXZbJS/W6UpvU9kunAijMis0M6EvKGM/JwV3U68I58FNtFCaT9o/btLnr2O
QHK0bF0Y+/eFtJNSiJ5WWQ+4BRM6nhGPu12Qd5bRbbscwJ7b26IlVSUWJ4eimwWxrwA+7Lz+phvO4ujqL7X1enApO1
otuWWdSOSBWm5/HlxkgGUgJjpPlC1dQqmPSu6MgJ0TKf1gAhvK5TSkUi6e6GVDhA6CpLFcqM9nDRr/njZTDbA9ihW9
3LrHxIwlJqu7ZrKBSzeWjPr1CzDHAMdroa3zwmM1D92QOZZaqQtYLpFMh2wKsi2GdA2GYZyl5XcW9p0YDSHujxLmaV
WZOPWhOYErErcKBcrsSroFWmfpb6l4nRA7bxQAhlGzXm5mDzcDisdGOn3o7MkQO4Su57F+qMKSgc+v0/ig0RvLo9aj
3+1cqnALGEWa2y5nrVlmMYiaTM5gbenzcFE7IdcO7XS/fqVNR04y5aWk62Z8DyzP5rBdMAi6TmygPPSzZJeBlzsZijpgGmAQogMz0pW+82n6i22GYG/jC/wGV/gM77AZ3yBz/hv4B9S44tT/2yvRQAAAABJRU5ErkJggg==" 
 } 
 } 
} 
Decodificação de QR Code (EMV) 
POST /cash_management/v1/decodificacoes_qrcode 
API responsável por efetuar a decodificação de um QR Code no padrão EMV. (leitura da 
imagem para disponibilização dos dados de pagamento). 
A seguir os parâmetros que serão utilizados na decodificação do QR Code. 
Comentado [ACMS23]: Ajustar para CNPJ 
Comentado [ACMS24]: Se formos disponibilizar essa API, 
precisamos garantir que o cliente só buscará as informações 
de QR Codes emitidos para aquele CNPJ. Faz sentido manter 
isso aqui? 
Parâmetros de Entrada 
Parâmetro Tipo Parâmetro 
Tipo 
Dado Presença Descrição Observação 
ispb_decodificador body string obrigatório 
Identificador SPB 
da conta do 
pagador 
decodificante. 
Tamanho é 8 
posições. 
numero_documento_decodificador body string obrigatório 
CPF / CNPJ do 
pagador que está 
solicitando os 
dados do QR 
Code. 
Tamanho 
mínimo é 11 e 
Tamanho 
máximo é 14 
emv body string obrigatório 
Texto do QR 
Code no padrão 
EMV 
- 
 
 
Códigos de status 
Código Descrição 
200 Decodificação concluída com sucesso. 
400 Erros de validação ou os campos informados. Verifique na resposta da API os 
campos informados. 
404 Chave não encontrada. 
422 Pix do QR Code não decodificado. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de entrada: QR Code Estático 
{ 
 "isbp_decodificador":"60701190", 
 "numero_documento_decodificador":"40661047890", 
 "documento": { 
 "qrcode_pix": { 
 
"emv":"00020101021126480014BR.GOV.BCB.PIX0114+55119968575260208Mensagem5204000053039865802
BR5910Fulano 6009SAO PAULO62600522UsmYqcyKRWuOdA--
tzb70g50300017BR.GOV.BCB.BRCODE01051.0.06304E042" 
 } 
 } 
} 
 
Exemplo de saida: QR Code Estático 
 (status = 200, application/json) 
 { 
 "data": { 
 "isbp_decodificador": "60701190", 
 "numero_documento_decodificador": "41034181840", 
 "documento": { 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-?47952cd9d25d", 
 "revisao": 1 
 }, 
 "valor": { 
 "original": "9999.00", 
 "permite_alteracao": false, 
 "final": "9999.00" 
 }, 
 "mensagem": "cobranca do churrasco", 
 "qrcode_pix": { 
 "tipo": "estatico", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "nome": "Fulano", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "emv": 
"00020101021126480014BR.GOV.BCB.PIX0114+55119968575260208Mensagem5204000053039865802BR5910
Fulano 6009SAO PAULO62600522UsmYqcyKRWuOdA--
tzb70g50300017BR.GOV.BCB.BRCODE01051.0.06304E042", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kq
Bg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj
/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
Comentado [ACMS25]: Estamos falando de um QR 
estático. Temos id_documetno_revisao? 
Comentado [ACMS26]: O padrão não é false? 
Comentado [ACMS27]: Como o valor é distinto sendo um 
QR Code estático? 
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
 } 
 } 
} 
 
Exemplo de entrada: QR Code Dinâmico 
{ 
 "isbp_decodificador":"60701190", 
 "numero_documento_decodificador":"40661047890", 
 "documento": { 
 "qrcode_pix": { 
 
"emv":"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c
-5ad6-4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Fulano 6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12" 
 } 
 } 
} 
Exemplo de saída: QR Code Dinâmico 
 (status = 200, application/json) 
 { 
 "data": { 
 "isbp_decodificador": "60701190", 
 "numero_documento_decodificador": "62143255000100", 
 "documento": { 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "pagador": { 
 "cnpj": "62143255000100", 
 "nome": "Nome de Teste" 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
Comentado [ACMS28]: Não está faltando o 
id_documento? 
Comentado [ACMS29]: Esse “cnpj” não deveria ser igual 
ao “numero_documento_decodificador”? 
 "calendario": { 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "vencimento": "2020-08-28", 
 "recebivel_apos_vencimento": true 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "qrcode_pix": { 
 "tipo": "dinamico", 
 "reutilizavel": true, 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "nome": "Fulano", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c-5ad6-
4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Fulano 6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kq
Bg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
 } 
 } 
Comentado [ACMS30]: Estamos com um payload com 
juros e data de expiração. Precisamos ajustar 
Comentado [ACMS31]: Esse cnpj não deveria bater com o 
payload de entrada? 
} 
Decodificação de Pix Link 
POST /cash_management/v1/decodificacoes_pixlink 
API responsável por efetuar a decodificação de um QR Code via Pix Link. (disponibiliza 
dados de pagamento a partir do link informado). 
A seguir os parâmetros que serão utilizados na decodificação do Pix Link. 
Parâmetros de Entrada 
Parâmetro Tipo 
Parâmetro 
Tipo 
Dado 
Presença Descrição Observação 
ispb_decodificador body string obrigatório 
Identificador SPB 
da conta do 
pagador 
decodificante. 
Tamanho é 
de 8 
posições. 
numero_documento_decodificador body string obrigatório 
CPF / CNPJ do 
pagador que está 
solicitando os 
dados do QR Code. 
Tamanho 
minimo é 11 
e Tamanho 
máximo é 14 
pix_link body string obrigatório 
Link para 
compartilhamento 
de QR Code PIX 
através de URL 
BACEN 
- 
 
 
Códigos de Status 
Código Descrição 
200 Decodificação concluída com sucesso. 
400 Erros de validação ou os campos informados. Verifique na resposta da API os 
campos informados. 
404 Chave não encontrada. 
422 Pix do QR Code não decodificado. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de entrada: QR Code Estático 
{ 
 "isbp_decodificador":"60701190", 
 "numero_documento_decodificador":"40661047890", 
 "documento": { 
 "qrcode_pix": { 
 
"pix_link":"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNz
cGkuaG9tLmNsb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2
YzZDAxNTIwNDAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYy
NjAwNTIyOHJ4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0
YxMg==" 
 } 
 } 
 } 
 
 
 
Exemplo de saída: QR Code Estático 
 (status = 200, application/json) 
{ 
 "data": { 
 "isbp_decodificador": "60701190", 
 "numero_documento_decodificador": "41034181840", 
 "documento": { 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "valor": { 
 "original": "9999.00", 
 "permite_alteracao": true, 
 "final": "9999.00" 
 }, 
 "mensagem": "cobranca do churrasco", 
 "qrcode_pix": { 
 "tipo": "estatico", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "nome": "Fulano", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
Comentado [ACMS32]: Temos id_documento_revisao 
para estático? 
Comentado [ACMS33]: Podemos ter valores distintos e 
permitir alteração? 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==", 
 } 
 } 
 } 
} 
 
Exemplo de entrada: QR Code Dinâmico 
{ 
 "isbp_decodificador":"60701190", 
 "numero_documento_decodificador":"40661047890", 
 "documento": { 
 "qrcode_pix": { 
 
"pix_link":"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNz
cGkuaG9tLmNsb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2
YzZDAxNTIwNDAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYy
NjAwNTIyOHJ4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0
YxMg==" 
 } 
 } 
} 
Exemplo de saída: QR Code Dinâmico 
 (status = 200, application/json) 
 { 
 "data": { 
 "isbp_decodificador": "60701190", 
 "numero_documento_decodificador": "62143255000100", 
 "documento": { 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "pagador": { 
 "cnpj": "62143255000100", 
 "nome": "Nome de Teste" 
Comentado [ACMS34]: Não temos que retornar o 
id_documento 
Comentado [ACMS35]: o cnpj não deveria ser igual ao 
“numero_documento_decodificador”? 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90" 
 }, 
 "calendario": { 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "vencimento": "2020-08-28", 
 "recebivel_apos_vencimento": true 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "qrcode_pix": { 
 "tipo": "dinamico", 
 "reutilizavel": true, 
 "recebedor": { 
 "cnpj": "12345678000100", 
 "nome": "Fulano", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==" 
 } 
 } 
 } 
} 
 
Devolução APIREC 
POST /cash_management/v1/devolucoes 
Comentado [ACMS36]: precisamos rever a questão de 
colocar juros e data de expiração juntos 
Comentado [ACMS37]: o cnpj do recebedor está igual ao 
cnpj do pagador 
Dado um QR Code pago ou uma transferência realizada, é possível que exista a 
necessidade de devolução de valores para o usuário pagador. Essa necessidade pode advir, 
por exemplo, de uma eventual reversão do acordo comercial, como insatisfação com o 
bem ou serviço transacionado, ou de algum erro no pagamento. 
A devolução trata-se, portanto, de um processo ágil e padronizado, sem necessidade de 
inserção de informações do pagador da transação original para a realização da nova 
transação. A operação permite que o recebedor ao iniciar a transação de devolução, não 
tenha que saber os dados da conta do usuário pagador. A funcionalidade da devolução 
está disponível para todas as transações recebidas nos últimos noventa dias. 
 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmetr
o 
Tipo 
Dado Presença Descrição Observaçãoid_lancamento body string 
obrigatóri
o 
id que 
identifica o 
lançamento 
de 
transferência 
pix. 
- 
id_transferencia body string 
obrigatóri
o 
UUID que 
identifica a 
transferência 
de 
pagamento. 
- 
id_pagamento body string 
obrigatóri
o 
Código que 
identifica o 
pagamento a 
ser 
devolvido. 
- 
valor body number 
obrigatóri
o 
Valor da 
devolução. - 
Parâmetro 
Tipo 
Parâmetr
o 
Tipo 
Dado 
Presença Descrição Observação 
Inserir no 
formato: 
99.99. 
codigo_motivo_devoluca
o body string 
obrigatóri
o 
Código do 
motivo da 
devolução. 
Obs: Verificar os códigos de 
motivos de devolução 
disponíveis na “API Motivos 
de Devolução”, campo 
“codigo_motivo_devolucao”
. 
motivo_devolucao body string 
obrigatóri
o 
motivo da 
devolução. - 
outro_motivo_devolucao body string opcional 
Motivo 
personalizad
o pela qual 
foi solicitada 
a devolução 
da 
transferência. 
obrigatório caso o 
“codigo_motivo_devolucao” 
usado seja “NARR” 
(Narrative). 
OBS: Tamanho máximo 
permitido de 105 
caracteres alfanuméricos. 
canal_operacao body string 
obrigatóri
o 
Canal que foi 
realizada a 
devolução. 
- 
Códigos de Status 
Código Descrição 
200 Devolução realizada com sucesso. 
400 Erros de validação ou os campos informados. Verifique na resposta da API os 
campos informados. 
422 Devolução não realizada por alguma regra de negócio não atendida. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de Entrada 
{ 
 "id_lancamento":" get543dd-32er-45rt-vf43-827732647365dfe44", 
 "id_transferencia":" b1ff5cc0-2a0c-381e-b207-738904c23555", 
 "valor":"100.01", 
 "codigo_motivo_devolucao":" NARR ", 
 "motivo_devolucao":" Narrativa ", 
 "outro_motivo_devolucao": "Descrição motivo personalizado", 
 "canal_operacao": "MOB" 
} 
Exemplo de saída 
 (status = 200, application/json) 
{ 
 "id_devolucao": "D60701190202004192128DY5e067813c", 
 "id_transferencia": "c3df5cc0-2a0c-381e-b207-738904c23555", 
 "codigo_controle_camara": "E60701190202004192128DY5e067813c", 
 "id_pagamento": "A23D5678-123D-12C4-1B34-A23456789012", 
 "id_documento": "d1ff5cc2-4a91-d97b-b284-548904c23322", 
 "txid":"b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "id":"devolucao_churrasco", 
 "id_lancamento":" get543dd-32er-45rt-vf43-827732647365dfe44", 
 "data": "2016-10-11T12:00:00", 
 "valor": 99.00, 
 "valor_transacao_original": 150.00, 
 "data_transacao_original": "2016-10-11T12:00:00", 
 "motivo_devolucao": "Narrative", 
 "codigo_motivo_devolucao": "NARR", 
 "outro_motivo_devolucao": "Descrição motivo", 
 "favorecido": 
 { 
 "numero_documento": "111.111.111-11", 
 "nome": "João Silva", 
 "codigo_ispb": "0", 
 "nome_instituicao_fincanceira": "Itau", 
 "tipo_conta": "corrente", 
 "agencia": "7654", 
 "conta": "657898", 
 "digito_verificador": "7" 
 }, 
 "solicitante":{ 
 "numero_documento": "222.222.222-22", 
 "nome": "Maria Silva", 
 "codigo_ispb": "0", 
 "nome_instituicao_fincanceira": "Itau", 
 "tipo_conta": "corrente", 
 "agencia": "3200", 
 "conta": "675432", 
 "digito_verificador": "4" 
 }, 
 "canal_operacao": "BKL", 
 "operador": "123456789", 
 "participante_indireto": { 
 "ispb": "01234567890" 
 }, 
 "pagador": { 
 "cpf": "41034181840", 
 "nome": "Nome de Teste", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "id_transacao":"b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "valor_remanescente":5.99 
} 
 
Cancelar QR Code por documento 
PATCH /cash_management/v1/documentos/{id_documento} 
API responsável por efetuar o cancelamento do documento. Uma vez o documento 
cancelado, ele torna-se inapto para o pagamento. 
 
Parâmetros de Entrada 
Parâmetro Tipo Parâmetro 
Tipo 
Dado Presença Descrição Observação 
id_documento path string obrigatório Id documento PIX a ser 
cancelado. 
- 
status path string obrigatório Status do QR Code. - 
Códigos de Status 
Código Descrição 
200 Documento cancelado com sucesso. 
420 Documento já cancelado e não permitida alteração de status. 
Código Descrição 
422 Erro em regra de negócio. 
Exemplo de Entrada 
{ 
 "status":"removido_pelo_usuario_recebedor" 
 
} 
Exemplo de saída 
 /cash_management/v1/documentos/2837be13-2b4e-48ac-8709-329d07452223 
 (status = 200, application/json) 
{ 
 "data": { 
 "versao": "1.0.0", 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "status": "removido_pelo_usuario_recebedor", 
 "pago": true, 
 "devolvido": false, 
 "pagador": { 
 "cnpj": "62143255000100", 
 "nome": "Nome de Teste", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "expiracao": "2020-08-28T12:00:00.0Z", 
 "recebivel_apos_vencimento": true, 
 "multa": "2020-08-20", 
 "desconto": "2020-08-20", 
 "juros": "2020-08-20" 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "mensagem": "cobranca do churrasco", 
 "url": "spi.cloud.itau.com.br/documentos/6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "qrcode_pix": { 
 "id_qrcode_pix": "d1ff5cc0-8a9d-497a-b982-438904c23383", 
 "tipo": "dinamico", 
 "default": false, 
 "status": "ativo", 
 "participante_indireto": { 
 "ispb": "01234567890" 
 }, 
 "reutilizavel": true, 
 "tipo_reutilizacao": "automatica", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "cpf": "41034181840", 
 "nome": "Fulano ", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==", 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c-5ad6-
4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Fulano 6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kqBg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj
/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
 } 
} 
Cancelar Qr Code APIREC (por identificador) 
PUT /cash_management/v1/documento/{txid} 
API responsável por efetuar o cancelamento do qrcode dinâmico por txid. Uma vez o 
qrcode dinâmico cancelado, ele torna-se inapto para o pagamento. 
 
Parâmetros de Entrada 
Parâmetr
o 
Tipo 
Parâmetr
o 
Tipo 
Dado 
Presença Descrição Observação 
txid path string obrigatório txid a ser excluido. - 
id_conta body string obrigatório 
Chave 
constituida 
por ispb (8 
digitos) + 
agencia (4 
- 
Parâmetr
o 
Tipo 
Parâmetr
o 
Tipo 
Dado 
Presença Descrição Observação 
dígitos) + 
conta (13 
dígitos) da 
conta 
corrente do 
cliente, 
com 25 
dígitos. 
status body 
strin
g 
obrigatóri
o 
Status 
para 
cancelar 
o qrcode 
dinâmic
o. 
Cancelar: 
"removido_pelo_usuario_recebed
or" 
 
 
Códigos de Status 
Código Descrição 
200 Documento cancelado com sucesso. 
420 Documento já cancelado e não permitida alteração de status. 
422 Erro em regra de negócio. 
Exemplo de Entrada 
{ 
 "status":"removido_pelo_usuario_recebedor", 
 "id_conta": "6070119015000000000004427" 
} 
 
Exemplo de saída 
 /cash_management/v1/documento/churrasfirma 
 (status = 200, application/json) 
{ 
 "data": { 
 "versao": "1.0.0", 
 "chave": "+5511996857526", 
 "txid": "churrasfirma", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "status": "removido_pelo_usuario_recebedor", 
 "pago": false, 
 "devolvido": false, 
 "pagador": { 
 "cnpj": "62143255000100", 
 "nome": "Nome de Teste", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "expiracao": "2020-08-28T12:00:00.0Z", 
 "recebivel_apos_vencimento": true, 
 "multa": "2020-08-20", 
 "desconto": "2020-08-20", 
 "juros": "2020-08-20" 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "mensagem": "cobranca do churrasco", 
 "url": "spi.cloud.itau.com.br/documentos/6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "qrcode_pix": { 
 "id_qrcode_pix": "d1ff5cc0-8a9d-497a-b982-438904c23383", 
 "tipo": "dinamico", 
 "default": false, 
 "status": "ativo", 
 "participante_indireto": { 
 "ispb": "01234567890" 
 }, 
 "reutilizavel": true, 
 "tipo_reutilizacao": "automatica", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "cpf": "41034181840", 
 "nome": "Fulano ", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==", 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c-5ad6-
4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Fulano 6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kq
Bg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj
/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
 } 
} 
Alterar Qr Code dinâmico por documento (altera txid ativo) 
PATCH /cash_management/v1/documentos/{id_documento} 
API responsável por efetuar a alteração das informações de um QR Code dinâmico. Permite 
alterar as informações do documento desde que esteja ativo (disponível para pagamento). 
A API pode ser utilizada pelo PSP Direto e Indireto. 
 
 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado Presença Descrição Observação 
id_documento path string obrigató
rio 
Id documento PIX a 
ser alterado. 
- 
pagador.cpf body string opcional 
Número do 
Documento Cadastro 
de Pessoa Física. 
Apenas CPF. (não 
enviar 
o pagador.cnpj). 
pagador.cnpj body string opcional 
Número do Cadastro 
Nacional da Pessoa 
Jurídica. 
Apenas 
CNPJ(não enviar 
o pagador.cpf). 
pagador.nome body string opcional Nome do pagador 
do QR Code. 
- 
valor.juros body number opcional 
Valor do juros ao 
mês por atraso de 
pagamento do QR 
Code. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.multa body number opcional 
Valor da multa por 
atraso de 
pagamento do QR 
Code. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.desconto body numbe
r 
opcional 
Desconto aplicado a 
cobrança até a data 
determinada. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado 
Presença Descrição Observação 
estiver 
preenchida. 
valor.permite_alteracao body boolea
n 
opcional 
Indicador se valor da 
cobrança pode ser 
alterado durante o 
pagamento - 
Pagador pode pagar 
outro valor?. 
Padrão de 
retorno é False. 
valor.porcentagem_juros body number opcional 
Porcentagem de 
juros ao mês a ser 
aplicada no cálculo 
dovalor de juros. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.porcentagem_desconto body numbe
r 
opcional 
Porcentagem de 
desconto a ser 
aplicada no cálculo 
do valor de 
desconto. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
calendario.expiracao body dateti
me 
opcional 
Data Hora expiração 
do documento - 
yyyy-MM-
dd'T'hh:mm:ss.z'Z'. 
Indica com 
granularidade de 
segundos a data 
e hora limite 
para pagamento 
do Qr Code. Não 
pode ser 
preenchido junto 
com Vencimento 
calendario.vencimento body date-only opcional 
Data de vencimento 
do documento - 
yyyy-MM-dd. 
Não pode ser 
preenchido junto 
com a data de 
Expiração. 
calendario.recebivel_apos_venc
imento 
body boolea
n 
opcional 
Trata-se de um 
campo booleano ou 
uma flag. Quando 
seu valor for true, 
significa que a 
cobrança pode ser 
paga após o 
vencimento. Quando 
esse campo não 
estiver presente, 
assume-se o valor 
false, ou seja, a 
cobrança não pode 
ser paga após o 
vencimento. Essa 
semântica se aplica 
Padrão de 
retorno é False 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado 
Presença Descrição Observação 
somente 
a calendario.vencim
ento. 
calendario.multa body 
date-
only opcional 
Data de referência 
para aplicação da 
multa no valor 
calculado da 
cobrança. 
Deve ser maior 
que a data de 
vencimento. 
calendario.desconto body date-only opcional 
Data de referência 
para aplicação de 
desconto no valor 
calculado da 
cobrança. 
Deve ser igual ou 
inferior a data de 
vencimento. 
calendario.juros body date-
only 
opcional 
Data de referência 
para aplicação da 
juros no valor 
calculado da 
cobrança. 
Deve ser maior 
que a data de 
vencimento. 
info_adicionais body array opcional - 
info_adicionais.nome body string opcional 
Nome da chave da 
informação 
(Tamanho máximo = 
50). 
Se for enviado, é 
necessário o 
envio do campo 
info_adicionais.v
alor 
info_adicionais.valor body string opcional 
Valor da informação 
(Tamanho máximo = 
200). 
Se for enviado, é 
necessário o 
envio do campo 
info_adicionais.n
ome 
valor.original body number 
obrigató
rio 
Valor 
nominal/cadastro do 
QR Code. 
- 
solicitacao_pagador body opcional 
Mensagem de 
solicitação do 
pagador do 
documento ao 
emissor. 
 
Códigos de Status 
Código Descrição 
200 Documento alterado com sucesso. 
420 Documento já alterado e não permitida alteração de status. 
422 Erro em regra de negócio. 
Exemplo de Entrada 
{ 
 "calendario": { 
 "expiracao": "2020-08-28T12:00:00.0Z" 
 } 
} 
Exemplo de saída 
 /cash_management/v1/documentos/2837be13-2b4e-48ac-8709-329d07452223 
 (status = 200, application/json) 
{ 
 "id_documento": "d1ff5cc2-4a91-d97b-b284-548904c23322", 
 "versao": "1.0.0", 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "status": "a_pagar", 
 "pago": false, 
 "devolvido": false, 
 "pagador": { 
 "cpf": "41034181840", 
 "nome": "Nome de Teste", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "expiracao": "2020-08-28T12:00:00.0Z", 
 "recebivel_apos_vencimento": true, 
 "multa": "2020-08-20", 
 "desconto": "2020-08-20", 
 "juros": "2020-08-20" 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "mensagem": "cobranca do churrasco", 
 "url": "spi.cloud.itau.com.br/documentos/6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "qrcode_pix": { 
 "id_qrcode_pix": "d1ff5cc0-8a9d-497a-b982-438904c23383", 
 "tipo": "dinamico", 
 "default": false, 
 "status": "ativo", 
 "participante_indireto": { 
 "ispb": "01234567890" 
 }, 
 "reutilizavel": true, 
 "tipo_reutilizacao": "automatica", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "cpf": "41034181840", 
 "nome": "Fulano ", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==", 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c-5ad6-
4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Fulano 6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kq
Bg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj
/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
} 
Alterar Qr Code dinâmico APIREC (por identificador) 
PUT /cash_management/v1/documento/{txid} 
API responsável por efetuar a alteração das informações de um QR Code dinâmico por 
txid. Permite alterar as informações, desde que esteja ativo (disponível para pagamento). A 
APi pode ser utilizada pelo PSP Direto e Indireto. 
 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado 
Presença Descrição Observação 
txid path string obrigatório txid a ser alterado. - 
id_conta body string 
obrigató
rio 
Chave constituida 
por ispb (8 digitos) + 
agencia (4 dígitos) + 
conta (13 dígitos) da 
conta corrente do 
cliente, com 25 
dígitos 
- 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado 
Presença Descrição Observação 
pagador.cpf body string opcional 
Número do 
Documento Cadastro 
de Pessoa Física. 
Apenas CPF. (não 
enviar 
o pagador.cnpj). 
pagador.cnpj body string opcional 
Número do Cadastro 
Nacional da Pessoa 
Jurídica. 
Apenas 
CNPJ(não enviar 
o pagador.cpf). 
pagador.nomebody string opcional 
Nome do pagador 
do QR Code. - 
valor.juros body number opcional 
Valor do juros ao 
mês por atraso de 
pagamento do QR 
Code. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.multa body numbe
r 
opcional 
Valor da multa por 
atraso de 
pagamento do QR 
Code. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.desconto body numbe
r 
opcional 
Desconto aplicado a 
cobrança até a data 
determinada. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.permite_alteracao body boolean opcional 
Indicador se valor da 
cobrança pode ser 
alterado durante o 
pagamento - 
Pagador pode pagar 
outro valor?. 
Padrão de 
retorno é False. 
valor.porcentagem_juros body 
numbe
r opcional 
Porcentagem de 
juros ao mês a ser 
aplicada no cálculo 
do valor de juros. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
valor.porcentagem_desconto body number opcional 
Porcentagem de 
desconto a ser 
aplicada no cálculo 
do valor de 
desconto. 
Só deverá ser 
preenchido 
quando a data 
de vencimento 
estiver 
preenchida. 
calendario.expiracao body 
dateti
me opcional 
Data Hora expiração 
do documento - 
yyyy-MM-
dd'T'hh:mm:ss.z'Z'. 
Indica com 
granularidade de 
segundos a data 
e hora limite 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado 
Presença Descrição Observação 
para pagamento 
do Qr Code. Não 
pode ser 
preenchido junto 
com Vencimento 
calendario.vencimento body 
date-
only opcional 
Data de vencimento 
do documento - 
yyyy-MM-dd. 
Não pode ser 
preenchido junto 
com a data de 
Expiração. 
calendario.recebivel_apos_venc
imento 
body boolea
n 
opcional 
Trata-se de um 
campo booleano ou 
uma flag. Quando 
seu valor for true, 
significa que a 
cobrança pode ser 
paga após o 
vencimento. Quando 
esse campo não 
estiver presente, 
assume-se o valor 
false, ou seja, a 
cobrança não pode 
ser paga após o 
vencimento. Essa 
semântica se aplica 
somente 
a calendario.vencim
ento. 
Padrão de 
retorno é False 
calendario.multa body date-only opcional 
Data de referência 
para aplicação da 
multa no valor 
calculado da 
cobrança. 
Deve ser maior 
que a data de 
vencimento. 
calendario.desconto body date-only opcional 
Data de referência 
para aplicação de 
desconto no valor 
calculado da 
cobrança. 
Deve ser igual ou 
inferior a data de 
vencimento. 
calendario.juros body date-only opcional 
Data de referência 
para aplicação da 
juros no valor 
calculado da 
cobrança. 
Deve ser maior 
que a data de 
vencimento. 
info_adicionais body array opcional - 
info_adicionais.nome body string opcional 
Nome da chave da 
informação 
(Tamanho máximo = 
50). 
Se for enviado, é 
necessário o 
envio do campo 
info_adicionais.v
alor 
Parâmetro 
Tipo 
Parâmet
ro 
Tipo 
Dado 
Presença Descrição Observação 
info_adicionais.valor body string opcional 
Valor da informação 
(Tamanho máximo = 
200). 
Se for enviado, é 
necessário o 
envio do campo 
info_adicionais.n
ome 
valor.original body numbe
r 
obrigató
rio 
Valor 
nominal/cadastro do 
QR Code. 
- 
solicitacao_pagador body opcional 
Mensagem de 
solicitação do 
pagador do 
documento ao 
emissor 
 
 
 
Códigos de Status 
Código Descrição 
200 qrcode dinâmico alterado com sucesso. 
420 qrcode dinâmico já alterado e não permitida alteração de status. 
422 Erro em regra de negócio. 
Exemplo de Entrada 
{ 
 "calendario": { 
 "expiracao": "2020-08-28T12:00:00.0Z" 
 } 
} 
Exemplo de saída 
 /cash_management/v1/documento/churrasfirma 
 (status = 200, application/json) 
{ 
 "id_documento": "d1ff5cc2-4a91-d97b-b284-548904c23322", 
 "versao": "1.0.0", 
 "chave": "+5511996857526", 
 "txid": "churrasfirma", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "status": "pago", 
 "pago": true, 
 "devolvido": false, 
 "pagador": { 
 "cpf": "41034181840", 
 "nome": "Nome de Teste", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "expiracao": "2020-08-28T12:00:00.0Z", 
 "recebivel_apos_vencimento": true, 
 "multa": "2020-08-20", 
 "desconto": "2020-08-20", 
 "juros": "2020-08-20" 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "mensagem": "cobranca do churrasco", 
 "url": "spi.cloud.itau.com.br/documentos/6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "qrcode_pix": { 
 "id_qrcode_pix": "d1ff5cc0-8a9d-497a-b982-438904c23383", 
 "tipo": "dinamico", 
 "default": false, 
 "status": "ativo", 
 "participante_indireto": { 
 "ispb": "01234567890" 
 }, 
 "reutilizavel": true, 
 "tipo_reutilizacao": "automatica", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "cpf": "41034181840", 
 "nome": "Fulano ", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==", 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c-5ad6-
4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Fulano 6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12", 
 "imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kq
Bg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj
/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
} 
Consultar Lista Motivos da Devolução Pix 
GET /cash_management/v1/motivos_devolucao_pixsAPI responsável por listar motivos de devolução de um pix. Os motivos de devolução são 
padronizados pelo Sistema de Pagamento Instantâneo (SPI) do Banco Central, por meio do 
catálogo de mensagens PACS004. 
 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmetro 
Tipo 
Dado Presença Descrição Observação 
view query Integer opcional 
Query 
Parameter que 
identifica qual a 
visão desejada 
para os motivos 
de devolução. 
Para listar todos os motivos de 
devolução da PACs.004, complementar 
no final da URL "?view=full". Para lista 
resumida, complementar no final da URL 
"?view=basic". Caso seja utilizado o 
Query Parameter sem nenhum valor 
(?view=), retornara erro 400. Caso não 
use o Query Paramter, será considerado 
o retorno “?view=basic” por padrão. 
Códigos de Status 
Código Descrição 
200 Motivos de devolução retornados com sucesso. 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplos de Saída: basic 
Caso não seja utilizado nenhum valor na Querie "view", o padrão será o "basic". 
 /cash_management/v1/motivos_devolucao_pixs?view=basic 
 (status = 200, application/json) 
 
 { 
 "data":[ 
 { 
 "codigo_motivo_devolucao": "AM05", 
 "nome_motivo_devolucao": "PIX realizado em duplicidade", 
 "descricao_motivo_devolucao": "Duplicidade" 
 }, 
 { 
 "codigo_motivo_devolucao": "FOCR", 
 "nome_motivo_devolucao": "Desistência do pagador", 
 "descricao_motivo_devolucao": "Desistência do pagador" 
 }, 
 { 
 "codigo_motivo_devolucao": "FR01", 
 "nome_motivo_devolucao": "Fraude identificada", 
 "descricao_motivo_devolucao": "Fraude identificada" 
 }, 
 { 
 "codigo_motivo_devolucao": "MD06", 
 "nome_motivo_devolucao": "PIX não aceito pelo recebedor", 
 "descricao_motivo_devolucao": "PIX não aceito pelo recebedor" 
 }, 
 { 
 "codigo_motivo_devolucao": "RUTA", 
 "nome_motivo_devolucao": "Disputa entre usuários", 
 "descricao_motivo_devolucao": "Disputa entre usuários" 
 } 
 ] 
 } 
Exemplos de Saída: full 
 /cash_management/v1/motivos_devolucao_pixs?view=full 
 (status = 200, application/json) 
 { 
 "data": [ 
 { 
 "codigo_motivo_devolucao": "NARR", 
 "nome_motivo_devolucao": "Código de erro genérico que somente deve ser 
utilizado caso o motivo de devolução 
 seja diverso e não esteja previsto na tabela de domínio. obrigatório o uso do 
campo de informação adicional", 
 "descricao_motivo_devolucao": "Narrativa" 
 }, 
 { 
 "codigo_motivo_devolucao": "UPAY", 
 "nome_motivo_devolucao": "Ordem de pagamento não justificada", 
 "descricao_motivo_devolucao": "Ordem de pagamento não justificada" 
 }, 
 { 
 "codigo_motivo_devolucao": "FOCR", 
 "nome_motivo_devolucao": "Desistência do pagador", 
 "descricao_motivo_devolucao": "Desistência do pagador" 
 }, 
 { 
 "codigo_motivo_devolucao": "AM09", 
 "nome_motivo_devolucao": "Devolução devido ao valor recebido não estar de 
acordo com o esperado", 
 "descricao_motivo_devolucao": "Devolução do valor fora do esperado" 
 }, 
 { 
 "codigo_motivo_devolucao": "SL11", 
 "nome_motivo_devolucao": "Usuário do recebedor não faz parte da lista de 
pessoas autorizadas a transacionar 
 recursos (Whitelist) com o usuário do pagador", 
 "descricao_motivo_devolucao": "Recebedor Não faz parte da Whitelist do usuário 
Pagador" 
 }, 
 { 
 "codigo_motivo_devolucao": "DS28", 
 "nome_motivo_devolucao": "Devolução após problemas técnicos, resultando em 
transação incorreta", 
 "descricao_motivo_devolucao": "Transação incorreta, problemas técnicos" 
 }, 
 { 
 "codigo_motivo_devolucao": "RUTA", 
 "nome_motivo_devolucao": "Disputa entre usuários", 
 "descricao_motivo_devolucao": "Disputa entre usuários" 
 }, 
 { 
 "codigo_motivo_devolucao": "BE08", 
 "nome_motivo_devolucao": "Devolução devido a um erro do PSP", 
 "descricao_motivo_devolucao": "Devolução devido a um erro do PSP" 
 }, 
 { 
 "codigo_motivo_devolucao": "FR01", 
 "nome_motivo_devolucao": "Fraude identificada", 
 "descricao_motivo_devolucao": "Fraude identificada" 
 }, 
 { 
 "codigo_motivo_devolucao": "SL12", 
 "nome_motivo_devolucao": "Usuário do recebedor incluída na lista impeditiva 
(Blacklist) do usuário do pagador", 
 "descricao_motivo_devolucao": "Recebedor na lista impeditiva (Blacklist) do 
usuário do pagador" 
 }, 
 { 
 "codigo_motivo_devolucao": "AM05", 
 "nome_motivo_devolucao": "PIX realizado em duplicidade", 
 "descricao_motivo_devolucao": "Duplicidade" 
 }, 
 { 
 "codigo_motivo_devolucao": "MD06", 
 "nome_motivo_devolucao": "PIX não aceito pelo recebedor", 
 "descricao_motivo_devolucao": "PIX não aceito pelo recebedor" 
 } 
 ] 
} 
Consultar lista de Histórico do Qr Code 
GET /cash_management/v1/historicos_pix 
API responsavel por exibir um relatório do histórico de alterações realizadas em um 
determinado pix. 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmetr
o 
Tipo 
Dad
o 
Presença Descrição Observação 
id_conta query string 
obrigatóri
o 
Chave 
constituída 
por ISPB (8 
digitos) + 
agencia (4 
dígitos) + 
conta (13 
dígitos) da 
conta 
corrente do 
cliente, com 
25 dígitos. 
- 
txid query string opcional 
Identificação 
de transação 
de um pix, 
utilizado para 
a sua 
identificação 
no banco 
central. 
- 
id_documen
to query 
strin
g opcional 
Identificação 
do 
documento 
pix. 
Caso não envie este campo, 
retornará o histórico completo de 
todos os documentos e txid 
data_historic
o query 
strin
g opcional 
Range de 
data do 
histórico do 
PIX. Inserir no 
formato 
'2020-06-
22;2020-07-
10'. 
- 
acao query string opcional 
Ação que foi 
executada 
para geração 
do histórico. 
Tipos de 
alteração: valor,vencimento, 
expiração, juros, multa, desconto, 
Parâmetro 
Tipo 
Parâmetr
o 
Tipo 
Dad
o 
Presença Descrição Observação 
final, info_adicionais, 
solicitacao_pagador, 
recebivel_apos_vencimento, 
permite_alteracao, 
cpf_cnpj_pagador, 
nome_pagador, 
exclusao_automatica, 
exclusao_comandada_pelo_recebe
dor, exclusao_expiracao, 
exclusao_portabilidade_reivindica
cao, 
exclusao_automatica_programada
. 
page query strin
g 
opcional 
numero da 
página que 
deseja realizar 
a chamada. 
Para realizar a 
rechamada,ca
so o retorno 
seja em mais 
de uma 
página 
considerar o 
campo do 
retorno da 
requisição 
"total_pages" , 
nesse campo 
retorna a 
quantidade 
páginas 
existentes de 
acordo com o 
page size 
parametrizad
o pelo 
consumidor. 
Exemplo: 
Tenho 30 
registros de 
PIX e preciso 
retornar a 
cada dez 
ocorrências, 
nesse caso 
teremos um 
total de 3 
páginas "total 
- 
Parâmetro 
Tipo 
Parâmetr
o 
Tipo 
Dad
o 
Presença Descrição Observação 
pages" 
retornará 3) e 
para eu 
chamar as 
seguintes 
precisarei 
fazer um novo 
request 
parametrizan
do a página 
desejada a ser 
consultada 
(Ex: page=2). 
page_size query string opcional 
quantidade 
de 
ocorrências 
do pix 
retornadas 
por página. 
- 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída: Histórico de Alteração 
 /cash_management/v1/historicos_pix?id_conta=6070119015000000000080399&r
evisao=3&data_historico=2016-10-01,2016-10-31 
 (status = 200, application/json) 
{ 
 "data":[{ 
 "id_documento":"b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "txid":"Abc2387126x5", 
 "documento_revisao": { 
 "id_documento_revisao":"b1abcdc0-321c-321e-abc3-1234abcc23abc", 
 "revisao":3 
 }, 
 "acao":"Alteração de valor", 
 "visao_campo_anterior": "10.00", 
 "visao_campo_atual": "25.00", 
 "data_historico":"2016-10-11T12:00:00", 
 "canal":"71", 
 "operador":"123456789" 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "https://des-apigateway-
int.mbi.cloud.ihf/cash_management/v1/historicos_pix", 
 "last": "https://des-apigateway-
int.mbi.cloud.ihf/cash_management/v1/historicos_pix?page=2", 
 "previous":"", 
 "next": "https://des-apigateway-
int.mbi.cloud.ihf/cash_management/v1/historicos_pix?page=1" 
 }, 
 "page": 0, 
 "total_pages": 3, 
 "total_elements": 3, 
 "page_size": 1 
 } 
} 
Consultar lista de lançamentos PIX 
GET /cash_management/v1/lancamentos_pix 
API responsável por listar os lançamentos Pix (débitos e créditos Pix). 
 
 
Parâmetros de Entrada 
Parâmetro Tipo Parâmetro 
Tipo 
Dado Presença Descrição Observação 
id_conta query string obrigatório 
Chave constituída por ISPB (8 digitos) 
+ agencia (4 dígitos) + conta (13 
dígitos) da conta corrente do cliente, 
com 25 dígitos. 
- 
visao query string opcional 
declara se a consulta deve retornar os 
pixs pela visão emissor ou visão 
pagador. 
- 
tipo_lancamento query string opcional 
Tipo de pagamento a ser informado 
para consulta deve ser informado 
"pagamento" ou "devolução". 
- 
view query string opcional 
Permite parametrizar visualização 
básica ou completa. Por padrão ela 
virá sempre básica, caso deseje a 
visualização completa, setar 
view=completo. 
- 
tipo_operacao query string opcional 
tipo de operação transacional a ser 
consultada, deve ser informada 
"debito" ou "credito". 
- 
data_lancamento query string opcional 
range de datas para consultar a data 
de lançamento, no formato no 
formato "AAAA-MM-DD;AAAA-MM-
DD 
- 
id_documento query string opcional Identificação do documento Pix. - 
page query string opcional 
numero da pagina que deseja realizar 
a chamada. Para realizar a rechamada, 
caso o retorno seja em mais de uma 
página considerar o campo do retorno 
da requisição "total_pages" , nesse 
campo retorna a quantidade páginas 
existentes de acordo com o page size 
parametrizado pelo consumidor. 
Exemplo: Tenho 30 registros de PIX e 
preciso retornar a cada dez 
ocorrências, nesse caso teremos um 
total de 3 páginas("total pages" 
retornará 3) e para eu chamar as 
seguintes precisarei fazer um novo 
request parametrizando a pagina 
desejada a ser consultada (Ex: page=2) 
. 
- 
page_size query string opcional quantidade de ocorrências do pix 
retornadas por página. 
- 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída: Visão Completa Emissor 
 /cash_management/v1/lancamentos_pix?id_conta=15000080399&visão=emissor
&page=1&page_size=10 
 (status = 200, application/json) 
 { 
 "data": [{ 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "detalhe_pagamento": { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "valor": 1000, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "959d5705-38a5-423d-9728-8e159ec2945b", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "detalhe_pagamento": { 
 "id_pagamento": "2d2eeaf8-58e0-40bc-9d28-58cee10a5afe", 
 "id_transferencia": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "codigo_controle_camara": "E6070119020200713151526485595462", 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "valor": 1000, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "a03c1b04-c720-40a2-a9e3-ee2330f8424d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link":"itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "detalhe_pagamento": { 
 "id_pagamento": "fa5531af-8016-46bc-89e6-c2ddd1cbb07f", 
 "id_transferencia": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "codigo_controle_camara": "E6070119020200713145018687936744", 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "data": "2020-07-13T17:39:13.212", 
 "valor": 1000, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "valor": 1000, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T17:39:13.212", 
 "alterado": false, 
 "txid": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "notificacao_valor": true, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "9a97e3e7-1c27-4933-8f2d-f80949d4a2ac", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "detalhe_pagamento": { 
 "id_pagamento": "27c13d9e-9ba4-4a71-b9a1-703440d22a31", 
 "id_transferencia": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "codigo_controle_camara": "E6070119020200713143940248449557", 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "valor": 1000, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "9a97e3e7-1c27-4933-8f2d-f80949d4a2ac", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "detalhe_pagamento": { 
 "id_pagamento": "d464b26e-d25a-44a4-b382-26207d255fb3", 
 "id_transferencia": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "valor": 1000, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "c52287e2-2313-47a7-988a-f7ba9c6ed12d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }], 
 "summary": [{ 
 "field": "valor_recebido", 
 "value": { 
 "amount": 5000, 
 "unity": "reais" 
 } 
 }, { 
 "field": "valor_debitado", 
 "value": { 
 "amount": 5000, 
 "unity": "reais" 
 } 
 }], 
 "pagination": { 
 "links": { 
 "first": 
"/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "last": 
"/cash_management/v1/lancamentos_pix?page=1.0&page_size=10", 
 "previous": 
"/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "next": "/cash_management/v1/lancamentos_pix?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 5, 
 "pageSize": 10 
 } 
} 
Exemplo de saída: Visão Resumida Emissor 
 /cash_management/v1/lancamentos_pix?id_conta=6070119015000000000080399&visao=emissor&page=1&page_size=10&view=basica 
(status = 200, application/json) 
{ 
"data": [ 
 { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }, 
 { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "2d2eeaf8-58e0-40bc-9d28-58cee10a5afe", 
 "id_transferencia": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "codigo_controle_camara": "E6070119020200713151526485595462", 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }, 
 { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "fa5531af-8016-46bc-89e6-c2ddd1cbb07f", 
 "id_transferencia": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "codigo_controle_camara": "E6070119020200713145018687936744", 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T17:39:13.212", 
 "valor": 1000 
 } 
 }, 
 { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "27c13d9e-9ba4-4a71-b9a1-703440d22a31", 
 "id_transferencia": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "codigo_controle_camara": "E6070119020200713143940248449557", 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }, 
 { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "tipo_qrcode_pix": "estatico", 
 "nome_terceiro": "SQT MC LEOH AL ASSAD DA SI", 
 "tipo_lancamento": "pagamento", 
 "visao": "emissor", 
 "tipo_operacao": "credito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "d464b26e-d25a-44a4-b382-26207d255fb3", 
 "id_transferencia": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 } 
], 
"summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 5000, 
 "unity": "reais" 
 } 
 }, 
 { 
 "field": "valor_debitado", 
 "value": { 
 "amount": 5000, 
 "unity": "reais" 
 } 
 } 
], 
"pagination": { 
 "links": { 
 "first": "/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "last": "/cash_management/v1/lancamentos_pix?page=1.0&page_size=10", 
 "previous": "/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "next": "/cash_management/v1/lancamentos_pix?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 5, 
 "pageSize": 10 
 } 
} 
Exemplo de saída: Visão Completa Pagador 
 /cash_management/v1/lancamentos_pix?id_conta= 
6070119015000000000080399&visao=pagador&page=1&page_size=10 
 (status = 200, application/json) 
{ 
 "data": [ 
 { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "detalhe_pagamento": { 
 "id_pagamento": "27c13d9e-9ba4-4a71-b9a1-703440d22a31", 
 "id_transferencia": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "codigo_controle_camara": "E6070119020200713143940248449557", 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "9a97e3e7-1c27-4933-8f2d-f80949d4a2ac", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR"} 
 }, 
 { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "detalhe_pagamento": { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "959d5705-38a5-423d-9728-8e159ec2945b", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, 
 { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "detalhe_pagamento": { 
 "id_pagamento": "fa5531af-8016-46bc-89e6-c2ddd1cbb07f", 
 "id_transferencia": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "codigo_controle_camara": "E6070119020200713145018687936744", 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "data": "2020-07-13T17:39:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T17:39:13.212", 
 "alterado": false, 
 "txid": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "notificacao_valor": true, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "9a97e3e7-1c27-4933-8f2d-f80949d4a2ac", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, 
 { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "detalhe_pagamento": { 
 "id_pagamento": "d464b26e-d25a-44a4-b382-26207d255fb3", 
 "id_transferencia": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003","nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "c52287e2-2313-47a7-988a-f7ba9c6ed12d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 }, 
 { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "detalhe_pagamento": { 
 "id_pagamento": "2d2eeaf8-58e0-40bc-9d28-58cee10a5afe", 
 "id_transferencia": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "codigo_controle_camara": "E6070119020200713151526485595462", 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 }, 
 "pix": { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "alterado": false, 
 "txid": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "recebedor": { 
 "id": "a03c1b04-c720-40a2-a9e3-ee2330f8424d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR" 
 } 
 } 
 ], 
 "summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 5000.00, 
 "unity": "reais" 
 } 
 }, 
 { 
 "field": "valor_debitado", 
 "value": { 
 "amount": 5000.00, 
 "unity": "reais" 
 } 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "last": "/cash_management/v1/lancamentos_pix?page=1.0&page_size=10", 
 "previous": "/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "next": "/cash_management/v1/lancamentos_pix?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 5, 
 "pageSize": 10 
 } 
Exemplo de saída: Visão Resumida Pagador 
 cash_management/v1/lancamentos_pix?id_conta= 
6070119015000000000080399&visao=pagador&page=1&page_size=10&view=b
asica 
 (status = 200, application/json) 
{ 
 "data": [{ 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "27c13d9e-9ba4-4a71-b9a1-703440d22a31", 
 "id_transferencia": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "codigo_controle_camara": "E6070119020200713143940248449557", 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }, { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador":"10", 
 "detalhe_pagamento": { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }, { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "fa5531af-8016-46bc-89e6-c2ddd1cbb07f", 
 "id_transferencia": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "codigo_controle_camara": "E6070119020200713145018687936744", 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T17:39:13.212", 
 "valor": 1000 
 } 
 }, { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "d464b26e-d25a-44a4-b382-26207d255fb3", 
 "id_transferencia": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }, { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "2d2eeaf8-58e0-40bc-9d28-58cee10a5afe", 
 "id_transferencia": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "codigo_controle_camara": "E6070119020200713151526485595462", 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000 
 } 
 }], 
 "summary": [{ 
 "field": "valor_recebido", 
 "value": { 
 "amount": 5000, 
 "unity": "reais" 
 } 
 }, { 
 "field": "valor_debitado", 
 "value": { 
 "amount": 5000, 
 "unity": "reais" 
 } 
 }], 
 "pagination": { 
 "links": { 
 "first": 
"/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "last": 
"/cash_management/v1/lancamentos_pix?page=1.0&page_size=10", 
 "previous": 
"/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "next": "/cash_management/v1/lancamentos_pix?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 5, 
 "pageSize": 10 
 } 
} 
Consultar detalhe do Lançamento 
GET /cash_management/v1/lancamentos_pix/{id_lancamento_pix} 
API responsável por retornar pontualmente o lançamento (crédito ou débito) do PIX de 
acordo com o identificador do lançamento selecionado. 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmetro 
Tipo 
Dado Presença Descrição Observação 
id_lancamento_pix path string obrigatório 
Identifica unicamente o lançamento 
do pix realizado em formato de 
UUID, como por exemplo, 
"bdbe89ab-da29-4a56-b01d-
70ad4063c668". 
- 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída 
 /cash_management/v1/lancamentos_pix?id_lancamento_pix= b1ff5cc0-8a9c-
497e-b983-738904c23389 
 (status = 200, application/json) 
{ 
 "data": { 
 "id_lancamento": "b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "Carlos De Santo", 
 "tipo_lancamento": "devolucao", 
 "visao": "pagador", 
 "detalhe_devolucao": { 
 "id_devolucao": "b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "id_transferencia": "c3df5cc0-2a0c-381e-b207-738904c23555", 
 "id_pagamento": "A23D5678-123D-12C4-1B34-A23456789012", 
 "data": "2016-10-11T12:00:00", 
 "valor": 99.00, 
 "motivo_devolucao": "Valor maior que o combinado.", 
 "canal_operacao": "BKL", 
 "operador": "123456789" 
 }, 
 "documento":{ 
 "id_documento": "d1ff5cc2-4a91-d97b-b284-548904c23322", 
 "versao": "1.0.0", 
 "chave": "+5511996857526", 
 "txid": "bqJJjaVAThmtnUeVLNnSXQ", 
 "documento_revisao": { 
 "id_documento_revisao": "6ea2498d-a540-4e19-ad9d-47952cd9d25d", 
 "revisao": 1 
 }, 
 "status": "pago", 
 "pago": true, 
 "devolvido": false, 
 "pagador": { 
 "cpf": "41034181840", 
 "nome": "Nome de Teste", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "valor": { 
 "original": "9999.00", 
 "juros": "120.00", 
 "desconto": "30.00", 
 "permite_alteracao": true, 
 "final": "11042.90", 
 "porcentagem_multa": "10.00" 
 }, 
 "calendario": { 
 "criacao": "2020-07-03T18:23:50.0Z", 
 "apresentacao": "2020-07-22T11:24:18.4Z", 
 "expiracao": "2020-08-28T12:00:00.0Z", 
 "recebivel_apos_vencimento": true, 
 "multa": "2020-08-20", 
 "desconto": "2020-08-20", 
 "juros": "2020-08-20" 
 }, 
 "info_adicionais": [ 
 { 
 "nome": "Detalhes do Pagamento", 
 "valor": "Informação Adicional do PSP do Recebedor" 
 } 
 ], 
 "solicitacao_pagador": "", 
 "mensagem": "cobranca do churrasco", 
 "url": "spi.cloud.itau.com.br/documentos/6ea2498d-a540-4e19-ad9d-
47952cd9d25d", 
 "qrcode_pix": { 
 "id_qrcode_pix": "d1ff5cc0-8a9d-497a-b982-438904c23383", 
 "tipo": "dinamico", 
 "padrao": false, 
 "status": "ativo", 
 "participante_indireto": { 
 "ispb": "01234567890" 
 }, 
 "reutilizavel": true, 
 "tipo_reutilizacao": "automatica", 
 "recebedor": { 
 "cnpj": "62143255000100", 
 "cpf": "41034181840", 
 "nome": "Neymar CPF", 
 "tipo_chave": "PHONE", 
 "chave_enderecamento": "+5511996857526", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "ITAÚ UNIBANCO S.A.", 
 "agencia": "1500", 
 "conta": "00633381" 
 } 
 }, 
 "pix_link": 
"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjExMjY5NTAwMTRCUi5HT1YuQkNCLlBJWDI1NzNzcGkuaG9tLmN
sb3VkLml0YXUuY29tLmJyL2RvY3VtZW50b3MvZjJiYzU5NmMtNWFkNi00YjhiLTlhMDEtNmQxMWNmY2YzZDAxNTIwN
DAwMDA1MzAzOTg2NTQwOTk5OTkwMC4wMDU4MDJCUjU5MTBOZXltYXIgQ1BGNjAwOVNBTyBQQVVMTzYyNjAwNTIyOHJ
4WmJGcldTNHVhQVcwUno4ODlBUTUwMzAwMDE3QlIuR09WLkJDQi5CUkNPREUwMTA1MS4wLjA2MzA0Q0YxMg==", 
 "emv": 
"00020101021126950014BR.GOV.BCB.PIX2573spi.hom.cloud.itau.com.br/documentos/f2bc596c-5ad6-
4b8b-9a01-6d11cfcf3d015204000053039865409999900.005802BR5910Neymar CPF6009SAO 
PAULO626005228rxZbFrWS4uaAW0Rz889AQ50300017BR.GOV.BCB.BRCODE01051.0.06304CF12","imagem_base64": 
"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAD4ElEQVR4Xu2YQc6kOAyFjbLIDi6AlGtklysVF4DiA
nCl7HINpFyA2mUR4XmGbmlgpH+T9KI1ZZVUFHyogmM/2xD/bJ6eZx72BS77Apd9gcu+wGV/EXAQdcGs3LdOLY536pt
E5KoCjnF+9jRSP3g1M3+SnKwJWLVynji/aCMdOVGTtrY2sFj8bz9a8wmKfR7+ALAytVqelFw8CHBtAJ7UskeT5zVsI
Nf/uroQIGptXG6fZ8AUAmKBRp2bxG9nDmt+n60GHKTebhuS+STqfPxw34R+qAsgWXSegtmJ5xDZb6OLb1cTQIwhKzn
0U8hT2pqE50Wq1gQOK/v1wkqcehON9rmGcoBTbskcmoaEH2r2Bs6cziu1AKwBR4NEclxc3G0/ujy6qgDFNRkOjHheO
a4BD9t3cqUikF+uf2lJ+cX1RPFwtQGN3FQ7IdjMHLYpmd2elysCEElPHfdkM2kFwcR6Hq4uBJApnaeW4u4Mp540VsK
f60ol4KBtYLWQ2nV8yxpo4DjXBRw13HcJNQvConAGUX1XmFKAGcKlUK0WJwp8WIS0ueVmBQAF16wp7towS7C9Sd0kq
Bg4NPIRUow1wJOovwBiXQA62fi4EEisZBtC36G+VwUOp6At0C6oPUrwx0cJDFcTQFQToS0xq0f/I43c+HB1MXDYeEj
/kFvxIWR5e7m7q4sBxjYRegY1J4hknFPf2m2qDRwuDz6P4ske6TO67dailANMZCMqb0vwJEQmojj+W4prAAr5fon8q
Hkh8Ftd4NC5Y7VbiADkC4Im9fG6sxaAr4kZwohIRnF52f5l7wpTDMiMg6EGIokWLkGE1QLB/3VrHQDtKB5tTmZO6Bt
xgCXdF1kB2KD2AwYQbaCZU8oT36O6HIBkedGWGZrsUFbQ/T5cXQycAw76qwmTYNhGHJwbVxfAdHOOnEgfhMSGeLgpT
DFwOMxNCiV+8lsToPZos2+eLAfYS+fTBPPW+KDdkvp4d3UpgKzHpPbBdJCwGHSnKO58f8xiQEZm/KlhzOY6fpL6eEn
VmoDLnewRDSGuXsmrDC2pVBFgmc6yTAcQFlzyUBh02jUBdFatxXSAkDBvuNQj3sx5Zz0AvShhTMMeiQKgeUAVbqoCs
FWKr8LvBtqC8RMjoasMoO+dZDpA1ks8nCNbTUDeYJx1ZMSkhkkBuWkfvX0xgDQJ6E8kJLBZuz1bU1cVwBkrIv+y1AV
qgnjyHnI1AJ2HIPs1M7ogczybvRoA/p3xgLkJiOqNHlJcDmBYRp1ihJnkfuPzFO5NbzmAeBCpxDAItZf3APPjbVIx8
IN9gcu+wGVf4LIvcNn/BfgHeb/dxs0/WuwAAAAASUVORK5CYII=" 
 } 
 } 
 } 
} 
 
Consultar lista de QR Codes / transferências 
GET /cash_management/v1/documentos 
API responsável por listar os PIXs gerados de um determinado cliente. 
 
Parâmetros de Entrada 
Parâmetro Tipo Parâmetro 
Tipo 
Dado Presença Descrição Observação 
chave_enderecamento query string opcional 
Chave de endereçamento 
do recebedor, utilizada em 
uma emissão. 
- 
txid query query opcional 
ID de 
transação/identificação do 
documento entre os 
bancos e o cliente emissor. 
- 
tipo_qrcode_pix query string opcional 
Classifica o tipo do QR 
Code gerado, deverá ser 
informado: "dinamico" ou 
"estatico" 
- 
status query string opcional 
Status do QR Code, deve-
se informar se é "ativo", 
"inativo" ou "cancelado" 
- 
valor_documento_pagador query string opcional 
CPF/CNPJ do pagador, 
informar o número desse 
documento para consulta. 
- 
pago query boolean opcional 
Identificador para saber se 
o PIX já foi pago. - 
data_pagamento query string opcional Data de pagamento do PIX. - 
devolvido query string opcional 
Identificador para saber se 
o PIX já foi devolvido. - 
data_devolucao query string opcional Data devolução do PIX. - 
data_emissao query string opcional Data de emissão do PIX. - 
data_vencimento query string opcional Data de vencimento do PIX. - 
data_cancelamento query string opcional Data de cancelamento do PIX. - 
data_expiracao query string opcional Data de expiração do PIX. - 
id_operador query string opcional 
Identificação única do 
operador que realizou 
alteração no PIX. 
- 
view query string opcional Permite parametrizar visualização básica ou 
Visão básica: 
Retorna 
Parâmetro 
Tipo 
Parâmetro 
Tipo 
Dado Presença Descrição Observação 
completa. Por padrão ela 
virá sempre básica, caso 
deseje a visualização 
completa, setar 
view=completo. 
informações 
resumidas do 
documento. 
Visão 
completa: 
Retorno 
informações 
completas do 
documento. 
order_by query string opcional Campo para ordenação. - 
page query string opcional Definir a página. - 
page_size query string opcional Quantidade de ocorrências do PIX por página. - 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída: Lista de PIX padrão visão completa 
 /cash_management/v1/documentos?chaves=46122746487&txid=cc3b911f-8eb6-
4a9b-856a-
3483553591ce&valor_documento_pagador=1000&tipo=1&pago=false&data_pag
amento=2020-08-08&data_emissao=2020-08-
08&id_operador=1&order_by=txid&default=true&view=completo&page=1&pag
e_size=10 
 (status = 200, application/json) 
 { 
 "data": [ 
 { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "tipo": "estatico", 
 "padrao": true, 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "27c13d9e-9ba4-4a71-b9a1-703440d22a31", 
 "id_transferencia": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "codigo_controle_camara": "E6070119020200713143940248449557", 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00 
 } 
 }, 
 { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00 
 } 
 }, 
 { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "fa5531af-8016-46bc-89e6-c2ddd1cbb07f", 
 "id_transferencia": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "codigo_controle_camara": "E6070119020200713145018687936744", 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T17:39:13.212", 
 "valor": 1000.00 
 } 
 }, 
 { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71", 
 "operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "d464b26e-d25a-44a4-b382-26207d255fb3", 
 "id_transferencia": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00 
 } 
 }, 
 { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "tipo_pix": "estatico", 
 "nome_terceiro": "BELLARMINO ALCANTARA MACHADO", 
 "tipo_lancamento": "pagamento", 
 "visao": "pagador", 
 "tipo_operacao": "debito", 
 "canal_operacao": "71","operador": "10", 
 "detalhe_pagamento": { 
 "id_pagamento": "2d2eeaf8-58e0-40bc-9d28-58cee10a5afe", 
 "id_transferencia": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "codigo_controle_camara": "E6070119020200713151526485595462", 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "texto_resposta_pagador": "Volte sempre!", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00 
 } 
 } 
 ], 
 "summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 5000.00, 
 "unity": "reais" 
 } 
 }, 
 { 
 "field": "valor_debitado", 
 "value": { 
 "amount": 5000.00, 
 "unity": "reais" 
 } 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "last": "/cash_management/v1/lancamentos_pix?page=1.0&page_size=10", 
 "previous": "/cash_management/v1/lancamentos_pix?page=1&page_size=10", 
 "next": "/cash_management/v1/lancamentos_pix?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 5, 
 "pageSize": 10 
 } 
} 
Exemplo de saída: Lista de PIX padrão visão resumida 
 /cash_management/v1/documentos?chaves=46122746487&txid=cc3b911f-8eb6-
4a9b-856a-
3483553591ce&valor_documento_pagador=1000&tipo=1&pago=false&data_pag
amento=2020-08-08&data_emissao=2020-08-
08&id_operador=1&order_by=txid&default=true&view=basico&page=1&page_s
ize=10 
(status = 200, application/json) 
{ 
 "data": [ 
 { 
 "id_documento": "0f255b6a-d0df-11ea-87d0-0242ac130003", 
 "chave": "46122746487", 
 "txid": "cc3b911f-8eb6-4a9b-856a-3483553591ce", 
 "data_emissao": "2020-08-08T00:00:00.069", 
 "status": "ativo", 
 "tipo": "estatico", 
 "padrao": true, 
 "pago": true, 
 "pagamentos_pix": [ 
 { 
 "data": "2020-08-08T00:00:00.069", 
 "valor": 1000.00 
 } 
 ] 
 } 
 ], 
 "summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 1000.00, 
 "unity": "pix" 
 } 
 }, 
 { 
 "field": "valor_devolvido", 
 "value": { 
 "amount": 0, 
 "unity": "pix" 
 } 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "last": "http://localhost:8082/cash_management/v1/pixs?page=10&page_size=10", 
 "previous": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "next": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 1, 
 "pageSize": 10 
 } 
Exemplo de saída: Lista de PIX dinâmico visão resumida 
 /cash_management/v1/documentos?chaves=40661047890&txid=5b88a62e-034f-
447b-aea8-
27df1289ef68&valor_documento_pagador=1000&tipo=1&pago=false&data_pag
amento=2020-08-08&data_emissao=2020-08-
08&id_operador=1&order_by=txid&default=true&view=basico&page=1&page_s
ize=10 
(status = 200, application/json) 
{ 
 "data": [ 
 { 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "chave": "40661047890", 
 "txid": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "data_emissao": "2020-03-03T00:00:00.069", 
 "data_vencimento": "2020-08-08T00:00:00", 
 "data_expiracao": "2020-10-10T00:00:00.069", 
 "status": "ativo", 
 "tipo": "dinamico", 
 "pago": true, 
 "pagador": "40661047890", 
 "aceita_apos_vencimento": true, 
 "pagamentos_pix": [ 
 { 
 "data": "2020-05-05T12:00:00.069", 
 "valor": 1000.00, 
 "valor_devolvido": 1000.00 
 } 
 ] 
 } 
 ], 
 "summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 1000.00, 
 "unity": "pix" 
 } 
 }, 
 { 
 "field": "valor_devolvido", 
 "value": { 
 "amount": 1000.00, 
 "unity": "pix" 
 } 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "last": "http://localhost:8082/cash_management/v1/pixs?page=10&page_size=10", 
 "previous": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "next": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 1, 
 "pageSize": 10 
 } 
} 
Exemplo de saída: Lista de PIX dinâmico visão completa 
 /cash_management/v1/documentos?chaves=46122746487&txid=cc3b911f-8eb6-
954b-856a-
3483553591ce&valor_documento_pagador=1000&tipo=1&pago=false&data_pag
amento=2020-08-08&data_emissao=2020-08-
08&id_operador=1&order_by=txid&default=true&view=completo&page=1&pag
e_size=10 
(status = 200, application/json) 
 { 
 "data": [ 
 { 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "valor": 1000.00, 
 "tipo": "dinamico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-03-03T00:00:00.069", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": true, 
 "alterado": false, 
 "txid": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_dinamico": { 
 "id_referencia": "40661047890", 
 "tipo_chave": "CPF", 
 "url": 
"itau.com.br/pagamentos/consuta/WdrFgLsLfMfKtpeRtDSFdsfs2525FSDfsdf3242FSDFs", 
 "data_juros": "2020-08-08", 
 "juros_valor": 10.00, 
 "juros_percentual": "1.000000", 
 "data_multa": "2020-08-08", 
 "multa_valor": 15.00, 
 "multa_percentual": "1.000000", 
 "data_desconto": "2020-07-07", 
 "desconto_valor": 40.00, 
 "desconto_percentual": "1.000000", 
 "abatimento": 40.00, 
 "vencimento": "2020-08-08", 
 "data_expiracao": "2020-10-10T00:00:00.069", 
 "reutilizavel": true, 
 "pagador": { 
 "id": "bc202ffc-a326-4f62-89d5-bcd04f0bdd00", 
 "tipo_documento": "cpf", 
 "valor_documento": "40661047890", 
 "nome": "Claudio Marquez", 
 "email": "Claudinho@hotmail.com", 
 "telefone": "5515998723050", 
 "tipo_conta": "corrente", 
 "instituicao": "56935735", 
 "agencia": "1500", 
 "conta": "0005201" 
 }, 
 "informacoes_adicionais": [ 
 {} 
 ], 
 "aceita_pagamento_apos_vencimento": true, 
 "aceita_divergencia_pagamento": true, 
 "solicitacao_pagador": "Obrigado !!!" 
 }, 
 "qrcode": { 
 "qrcode": "6ebd50ac-f9ae-453a-a4fd-c69f2d1ae5cc", 
 "qrcode_base64": "QR Code Bolado" 
 }, 
 "recebedor": { 
 "id": "5b5488e4-8eb7-4b5b-935e-93b5d344b064", 
 "tipo_documento": "cpf","valor_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "341", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "461", 
 "conta": "1005878" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "341", 
 "agencia": "461", 
 "conta": "1005878", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "codigo_controle_camara": "22", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-05-05T12:00:00.069", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao":0.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "devolucoes_pix": [ 
 { 
 "id_devolucao": "f2c2e90c-bb3c-4499-bd68-b33491fb81d5", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-
27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-04-05T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 }, 
 { 
 "id_devolucao": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-
27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-04-04T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 } 
 ] 
 } 
 ] 
 } 
 ], 
 "summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 1000.00, 
 "unity": "pix" 
 } 
 }, 
 { 
 "field": "valor_devolvido", 
 "value": { 
 "amount": 1000.00, 
 "unity": "pix" 
 } 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "last": "http://localhost:8082/cash_management/v1/pixs?page=10&page_size=10", 
 "previous": 
"http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "next": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 1, 
 "pageSize": 10 
 } 
 } 
Exemplo de saída: Lista de PIX estático visão completa 
 /cash_management/v1/documentos?chaves=46122746487&txid=19ab3d07-
a002-4fa1-babb-81300dcf164f&tipo_qrcode_pix=estatico 
&view=completo&page=1&page_size=10 
 (status = 200, application/json) 
 { 
 "data": [ 
 { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico":{ 
 "mensagem": "Estatico" 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "959d5705-38a5-423d-9728-8e159ec2945b", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 } 
 ] 
 }, 
 { 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T17:39:13.212", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "notificacao_valor": true, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "9a97e3e7-1c27-4933-8f2d-f80949d4a2ac", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "fa5531af-8016-46bc-89e6-c2ddd1cbb07f", 
 "id_transferencia": "c4cc29f2-bfcb-37bd-a1a4-104f83b101f2", 
 "codigo_controle_camara": "E6070119020200713145018687936744", 
 "id_documento": "645f1bb9-16f0-37cd-a048-bd6cba318ed1", 
 "data": "2020-07-13T17:39:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 } 
 ] 
 }, 
 { 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "9a97e3e7-1c27-4933-8f2d-f80949d4a2ac", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "27c13d9e-9ba4-4a71-b9a1-703440d22a31", 
 "id_transferencia": "10cec566-47f8-3ca0-92e4-9599bd844d98", 
 "codigo_controle_camara": "E6070119020200713143940248449557", 
 "id_documento": "7f4f5b4e-7878-4ae5-9e5d-9ca4c3b771b4", 
 "data": "2020-07-13T15:13:13.212","valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 } 
 ] 
 }, 
 { 
 "id_documento": "8510643b-1684-409f-89e6-cff01461eb68", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "bk", 
 "id_operador": "1", 
 "status": "ativo", 
 "data_emissao": "2020-08-08T00:00:00.069", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "cc3b911f-8eb6-4a9b-856a-3483553591ce", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": " " 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "85f7a6cf-231e-4cc2-aaf7-d2814589933d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "felipe rodrigues", 
 "telefone": "5511997707823", 
 "tipo_chave": "cpf", 
 "chave": "46122746487", 
 "dados_conta": { 
 "tipo_conta": "conta-corrente", 
 "ispb": "85967285", 
 "nome_instituicao": "banco itau", 
 "agencia": "784", 
 "conta": "01005878" 
 } 
 }, 
 "tipo_conta": "conta-corrente", 
 "banco": "85967285", 
 "agencia": "784", 
 "conta": "01005878", 
 "pix_link": "itau.com.br/pagamentos/wdrfglslfmfktper", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "76c27ea2-39a7-4d14-b5a8-b93ece94dbde", 
 "id_transferencia": "0f573d00-7960-41ef-b6bf-5d709d5c5056", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "8510643b-1684-409f-89e6-cff01461eb68", 
 "data": "2020-08-08T00:00:00.069", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "obrigado pela preferencia, volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "felipe rodrigues", 
 "codigo_ispb": "85967285", 
 "nome_instituicao_financeira": "banco itau", 
 "tipo_conta": "conta-corrente", 
 "agencia": "784", 
 "conta": "01005878" 
 }, 
 "solicitante": { 
 "numero_documento": "46115822783", 
 "nome": "rodrigo nunes", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "banco itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "4877", 
 "conta": "227209" 
 } 
 } 
 ] 
 }, 
 { 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "a03c1b04-c720-40a2-a9e3-ee2330f8424d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "2d2eeaf8-58e0-40bc-9d28-58cee10a5afe", 
 "id_transferencia": "7c7072f3-d992-449a-9151-fbab107af6ae", 
 "codigo_controle_camara": "E6070119020200713151526485595462", 
 "id_documento": "b1c500b3-910b-30eb-a4dd-81610661e7d3", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 } 
 ] 
 }, 
 { 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo","data_emissao": "2020-07-13T15:13:13.212", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "c52287e2-2313-47a7-988a-f7ba9c6ed12d", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "d464b26e-d25a-44a4-b382-26207d255fb3", 
 "id_transferencia": "741b4088-b204-4902-bb60-8209f7750d9e", 
 "codigo_controle_camara": "E6070119020200713151671227498667", 
 "id_documento": "c42a65f0-cabc-3bd5-b5b9-68f4a0cefcb6", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 } 
 ] 
 } 
 ], 
 "summary": [ 
 { 
 "field": "valor_recebido", 
 "value": { 
 "amount": 6000.00, 
 "unity": "pix" 
 } 
 }, 
 { 
 "field": "valor_devolvido", 
 "value": { 
 "amount": 0, 
 "unity": "pix" 
 } 
 } 
 ], 
 "pagination": { 
 "links": { 
 "first": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "last": "http://localhost:8082/cash_management/v1/pixs?page=10&page_size=10", 
 "previous": 
"http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10", 
 "next": "http://localhost:8082/cash_management/v1/pixs?page=1&page_size=10" 
 }, 
 "page": 1, 
 "totalPages": 1, 
 "totalElements": 6, 
 "pageSize": 10 
 } 
} 
Exemplo de saída: Lista de PIX com devolução visão completa 
 /cash_management/v1/documentos?chaves=46122746487&txid=cc3b911f-8eb6-
954b-856a-3483553591ce&devolucao=true& 
&order_by=txid&default=true&view=completo&page=1&page_size=10 
(status = 200, application/json) 
{ 
 "data": [ 
 { 
 "id_devolucao": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-04-04T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 }, 
 { 
 "id_devolucao": "f2c2e90c-bb3c-4499-bd68-b33491fb81d5", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-04-05T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 } 
 ] 
} 
Consultar detalhe do QR Code / transferência 
GET /cash_management/v1/documentos/{id_documento} 
API responsável por retornar pontualmente as informações do PIX de acordo com o 
identificador do PIX selecionado. 
Parâmetros de Entrada 
Parâmetro 
Tipo 
Parâmetro 
Tipo 
Dado Presença Descrição Observação 
id_documento path string obrigatório 
Identificação do documento 
pix. - 
 
 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída: Consulta Pontual de PIX Estático 
 /cash_management/v1/documentos/4b3740e2-51ba-320e-8824-48c8324ad793 
 (status = 200, application/json) 
{ 
 "data": { 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "valor": 1000.00, 
 "tipo": "estatico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-07-13T15:13:13.212", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": false, 
 "alterado": false, 
 "txid": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao":false, 
 "detalhe_estatico": { 
 "mensagem": "Estatico" 
 }, 
 "qrcode": {}, 
 "recebedor": { 
 "id": "959d5705-38a5-423d-9728-8e159ec2945b", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "60701190", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "3977", 
 "conta": "0057213" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "60701190", 
 "agencia": "3977", 
 "conta": "0057213", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "af9341d6-1696-4982-aeda-364ac7fa4ebc", 
 "id_transferencia": "19ab3d07-a002-4fa1-babb-81300dcf164f", 
 "codigo_controle_camara": "E6070119020200713151432295041629", 
 "id_documento": "4b3740e2-51ba-320e-8824-48c8324ad793", 
 "data": "2020-07-13T15:13:13.212", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": true, 
 "valor_maximo_devolucao": 1000.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "BELLARMINO ALCANTARA MACHADO", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "3977", 
 "conta": "0057213", 
 "digito_verificador": "4" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "SQT MC LEOH AL ASSAD DA SI", 
 "codigo_ispb": "60701190", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "corrente", 
 "agencia": "1500", 
 "conta": "0079558", 
 "digito_verificador": "6" 
 } 
 } 
 ] 
 } 
} 
Exemplo de saída: Consulta Pontual de PIX Dinâmico 
 /cash_management/v1/documentos/810b0bd8-6f50-4e6a-a362-d13aadab7e49 
 (status = 200, application/json) 
 { 
 "data": { 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "valor": 1000.00, 
 "tipo": "dinamico", 
 "canal_operacao": "71", 
 "id_operador": "10", 
 "status": "ativo", 
 "data_emissao": "2020-03-03T00:00:00.069", 
 "pago": true, 
 "quantidade_pagamentos": 1, 
 "devolvido": true, 
 "alterado": false, 
 "txid": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "notificacao_valor": false, 
 "registro_txid": false, 
 "validacao_valor": false, 
 "simula_emissao": false, 
 "detalhe_dinamico": { 
 "id_referencia": "40661047890", 
 "tipo_chave": "CPF", 
 "url": 
"itau.com.br/pagamentos/consuta/WdrFgLsLfMfKtpeRtDSFdsfs2525FSDfsdf3242FSDFs", 
 "data_juros": "2020-08-08", 
 "juros_valor": 10.00, 
 "juros_percentual": "1.000000", 
 "data_multa": "2020-08-08", 
 "multa_valor": 15.00, 
 "multa_percentual": "1.000000", 
 "data_desconto": "2020-07-07", 
 "desconto_valor": 40.00, 
 "desconto_percentual": "1.000000", 
 "abatimento": 40.00, 
 "vencimento": "2020-08-08", 
 "data_expiracao": "2020-10-10T00:00:00.069", 
 "reutilizavel": true, 
 "pagador": { 
 "id": "bc202ffc-a326-4f62-89d5-bcd04f0bdd00", 
 "tipo_documento": "cpf", 
 "valor_documento": "40661047890", 
 "nome": "Claudio Marquez", 
 "email": "Claudinho@hotmail.com", 
 "telefone": "5515998723050", 
 "tipo_conta": "corrente", 
 "instituicao": "56935735", 
 "agencia": "1500", 
 "conta": "0005201" 
 }, 
 "informacoes_adicionais": [ 
 { 
 "nome": "QRCODE", 
 "valor": "TESTE" 
 } 
 ], 
 "aceita_pagamento_apos_vencimento": true, 
 "aceita_divergencia_pagamento": true, 
 "solicitacao_pagador": "Obrigado !!!" 
 }, 
 "qrcode": { 
 "qrcode": "6ebd50ac-f9ae-453a-a4fd-c69f2d1ae5cc", 
 "qrcode_base64": "QR Code Bolado" 
 }, 
 "recebedor": { 
 "id": "5b5488e4-8eb7-4b5b-935e-93b5d344b064", 
 "tipo_documento": "cpf", 
 "valor_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "telefone": "5511997707823", 
 "tipo_chave": "CPF", 
 "chave": "40661047890", 
 "dados_conta": { 
 "tipo_conta": "corrente", 
 "ispb": "341", 
 "nome_instituicao": "BANCO ITAU", 
 "agencia": "461", 
 "conta": "1005878" 
 } 
 }, 
 "tipo_conta": "corrente", 
 "banco": "341", 
 "agencia": "461", 
 "conta": "1005878", 
 "pix_link": "itau.com.br/pagamentos/WdrFgLsLfMfKtpeR", 
 "pagamentos_pix": [ 
 { 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "codigo_controle_camara": "22", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-05-05T12:00:00.069", 
 "valor": 1000.00, 
 "indicador_possibilidade_devolucao": false, 
 "valor_maximo_devolucao":0.00, 
 "texto_resposta_pagador": "Volte sempre!", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "devolucoes_pix": [ 
 { 
 "id_devolucao": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-
27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "data": "2020-04-04T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003","nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 }, 
 { 
 "id_devolucao": "f2c2e90c-bb3c-4499-bd68-b33491fb81d5", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-
27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "txid": "fef5656-6543-4e6a-a362-dfdggff67890", 
 "id": "Devolucao_churras", 
 "data": "2020-04-05T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 } 
 ] 
 } 
 ] 
 } 
} 
Exemplo de saída: Consulta Pontual de Devolução 
 /cash_management/v1/documentos/810b0bd8-6f50-4e6a-a362-d13aadab7e49 
 (status = 200, application/json) 
 { 
 "data": { 
 "id_documento": "810b0bd8-6f50-4e6a-a362-d13aadab7e49", 
 "id_devolucao": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "id_transferencia": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "id_transferencia_pagamento": "5b88a62e-034f-447b-aea8-27df1289ef68", 
 "codigo_controle_camara": "UFA", 
 "id_pagamento": "0d7360b8-7657-4832-a007-ac22e4886c48", 
 "data": "2020-04-04T00:00:00.069", 
 "valor": 500.00, 
 "valor_transacao_original": 1000.00, 
 "data_transacao_original": "2020-05-05T12:00:00.069", 
 "motivo_devolucao": "Devolucao Parcial", 
 "favorecido": { 
 "numero_documento": "12245870003", 
 "nome": "Fabiana Pereira", 
 "codigo_ispb": "341", 
 "nome_instituicao_financeira": "BANCO ITAU", 
 "tipo_conta": "corrente", 
 "agencia": "461", 
 "conta": "1005878" 
 }, 
 "solicitante": { 
 "numero_documento": "40661047890", 
 "nome": "Marcos Augusto", 
 "codigo_ispb": "39576829", 
 "nome_instituicao_financeira": "Banco Itau", 
 "tipo_conta": "desconhecido", 
 "agencia": "1500", 
 "conta": "0004427" 
 }, 
 "canal_operacao": "012" 
 } 
} 
Consultar Movimentação detalhada Pix 
GET /cash_management/v1/movimentos_pix?id_conta=id_conta 
API responsável por listar os movimentos do cliente. 
Parâmetros de Entrada 
Parâmetro Tipo Parâmetro 
Tipo 
Dado Presença Descrição Observação 
id_conta query string obrigatório 
Chave constituída por ISPB 
(8 digitos) + agencia (4 
dígitos) + conta (13 dígitos) 
da conta corrente do 
cliente, com 25 dígitos. 
- 
chaves_enderecamento query string opcional 
Lista de chaves de 
endereçamento do 
recebedor, utilizada na 
emissão de um PIX. Inserir 
no formato 'chave1;chave2'. 
- 
periodo_de query string opcional Data inicial para filtragem 
por período. 
- 
periodo_ate query string opcional 
Data final para filtragem 
por período. - 
nome_pagador query string opcional Nome do pagador para 
filtro da movimentação 
- 
documento_pagador query string opcional 
CPF / CNPJ do pagador que 
está solicitando os dados. - 
transaction_id query string opcional 
Informação 'txId' do 
documento para filtro de 
movimentação 
- 
document_id query string opcional 
Informação document.id 
para filtro de 
movimentação 
- 
tipo_consulta query string opcional 
Tipo de consulta que será 
realizada para 
movimentação 
ativos, 
devolvidos, 
emitidos, 
excluidos, 
recebidos 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída: Lista de movimentos PIX 
 /cash_management/v1/movimentos_pix?id_conta=46122746487&chaves_enderec
amento=CPF,CNPJ&periodo_de=2020-08-18&periodo_ate=2020-08-
19&nome_pagador=Joao&documento_pagador=00000000000&tipo_consulta=ati
vos 
 (status = 200, application/json) 
 { 
 "data": [{ 
 "nome_pagador": "Joao Siqueira", 
 "cnpj_pagador": "44333094000109", 
 "tipo_documento": "estático", 
 "id_documento": "b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "id_transacao": "b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "data_vencimento": "2020-08-04T12:00:00", 
 "valor_original": 1000.00, 
 "valor_final": 1000.00, 
 "valor_pago": 1000.00, 
 "valor_devolvido": 1000.00, 
 "valor_desconto": 10.00, 
 "valor_juros": 20.00, 
 "valor_multa": 20.00, 
 "valor_tarifa": 4.0, 
 "status": "a_pagar" 
 }, 
 { 
 "nome_pagador": "Joao da Silva", 
 "cnpj_pagador": "44333094000109", 
 "tipo_documento": "estático", 
 "id_documento": "b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "id_transacao": "b1ff5cc0-8a9c-497e-b983-738904c23389", 
 "data_vencimento": "2020-08-04T12:00:00", 
 "valor_original": 1000.00, 
 "valor_final": 1000.00, 
 "valor_pago": 1000.00, 
 "valor_devolvido": 1000.00, 
 "valor_desconto": 10.00, 
 "valor_juros": 20.00, 
 "valor_multa": 20.00, 
 "valor_tarifa": 4.0, 
 "status": "a_pagar" 
 }] 
} 
Consultar resumo posição consolidada 
GET /cash_management/v1/resumo_pix 
API responsavel por retornar uma sumarização de movimentos por agência/conta e 
período. 
Parâmetros de Entrada 
Parâmetro Tipo Parâmetro 
Tipo 
Dado Presença Descrição Observação 
id_conta query string obrigatório 
Chave constituída por ISPB (8 digitos) + 
agencia (4 dígitos) + conta (13 dígitos) da 
conta corrente do cliente, com 25 dígitos. 
- 
periodo_de query string opcional Data inicial para filtragem por período. - 
periodo_ate query string opcional Data final para filtragem por período. - 
Códigos de Status 
Código Descrição 
200 Requisição executada com sucesso (success). 
403 Acesso proibido. 
404 Recurso inexistente. 
500 Erro Inesperado. Entre em contato com o suporte Itaú. 
Exemplo de saída: Resumocom posição consolidada 
 /cash_management/v1/resumo_pix?id_conta=46122746487&periodo_de=2020-
08-18&periodo_ate=2020-08-19 
 (status = 200, application/json) 
 { 
 "data": { 
 "emitidos" : { 
 "quantidade_emitido": 2, 
 "valor_emitido": 100.00 
 }, 
 "excluidos" : { 
 "quantidade_excluido": 2, 
 "valor_excluido": 100.00 
 }, 
 "devolvidos" : { 
 "quantidade_devolvido": 2, 
 "valor_devolvido": 100.00 
 }, 
 "recebidos": { 
 "quantidade_recebido": 2, 
 "valor_recebido": 100.00 
 }, 
 "ativos" :[{ 
 "quantidade_ativo": 2, 
 "valor_ativo": 100.00, 
 "tipo_vencimento": "a_vencer" 
 }, 
 { 
 "quantidade_ativo": 2, 
 "valor_ativo": 100.00, 
 "tipo_vencimento": "vencidos" 
 }, 
 { 
 "quantidade_ativo": 2, 
 "valor_ativo": 100.00, 
 "tipo_vencimento": "sem_vencimento" 
 }] 
 } 
}