Como configurar o boleto registrado Itaú API?

1. Obter credenciais no Itaú

O primeiro passo é entrar em contato com sua gerência do Itaú para obter as seguintes credenciais:

Credencial	Descrição
Agência	Número da sua agência bancária.
Conta Corrente	Número da sua conta corrente.
Carteira	Código da sua carteira de cobrança.
CNPJ	CNPJ da sua empresa.
`ClientId`	Identificador único da sua aplicação.
Token Temporário	Token com validade de 7 dias para a primeira autenticação. Solicite ao Itaú.

2. Gerar certificado dinâmico

Você precisará fazer login no portal Itaú for Developers para gerar o certificado dinâmico.

📘
Para gerar o certificado dinâmico, acesse a documentação do Itaú e vá para o Passo 7 – Passo a passo para gerar o certificado dinâmico.
Seguindo a documentação do Itaú, é possível:

Gerar o certificado dinâmico e fazer download pelo portal ;

Criar o certificado dinâmico manualmente .

Formato do certificado dinâmico

O certificado dinâmico é formado pela chave privada (KEY) e chave pública (CSR) e segue o seguinte padrão:

Exemplo de chave privada - arquivo .key que será enviada em Credencials.PrivateKey na etapa de onboarding:

Exemplo de chave pública - arquivo .csr que será enviada em Credencials.PublicKey na etapa de onboarding:

Os valores acima são apenas exemplo. Você deve gerar o seu certificado no portal do Itaú

⚠️
Salve as credenciais PublicKey e PrivateKey em local seguro, pois serão usadas no processo de renovação anual do certificado.

3. Onboarding do boleto Itaú API no Gateway de Pagamento

Com as credenciais em mãos, você fará o onboarding no novo provedor de boleto no Gateway de Pagamento da Cielo. Para isso, será necessário realizar uma requisição para o seguinte endpoint:

Requisição

Método	Endpoint
POST	`https://adminservices.pagador.com.br/provider/onboarding`

Parâmetros no header

Parâmetro	Tipo	Descrição
`MerchantId`	`GUID`	Obrigatório. Identificador da loja
`MerchantKey`	`string`	Obrigatório. Chave da loja

{
    "Provider": "Itau3",
    "PaymentType": "Boleto",
    "Credencials": {
        "PublicKey": "-----BEGIN CERTIFICATE REQUEST-----\\n...\\n-----END CERTIFICATE REQUEST-----",
        "PrivateKey": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----",
        "TokenTemporario": "eyJraWQiOi...f+tRUg==",
        "ClientId": "b0509ad1-e928-4907-9b7d-7d308f3e7g13",
        "Agencia": "2938",
        "Conta": "51122-9",
        "Carteira": "176",
        "Vencimento": "1"
    }
}

Observação sobre os parâmetrosPublicKey ePrivateKey
Para que o Postman (ou interface similar) interprete corretamente as quebras de linha em certificados ou chaves, utilize o caractere de escape \r\n dentro da string. Isso garante que o conteúdo seja formatado corretamente durante a requisição.

Parâmetros no body

Parâmetro	Tipo	Descrição
`Provider`	`string`	Nome do provedor. Nesse caso, use "Itau3".
`PaymentType`	`string`	Tipo do meio de pagamento. Nesse caso, use "Boleto".
`Credencials.PublicKey`	`string`	Certificado obtido na etapa de criação do certificado dinâmico.
`Credencials.PrivateKey`	`string`	Chave privada obtida na etapa de criação do certificado dinâmico.
`Credencials.TokenTemporario`	`string`	Token temporário obtido com o Itaú na etapa de obtenção de credenciais com o Itaú.
`Credencials.ClientId`	`string`	`ClientId` obtido com o Itaú na etapa de obtenção de credenciais com o Itaú.
`Credencials.Agencia`	`string`	Código da agência da conta no Itaú (ver etapa de obtenção de credenciais com o Itaú).
`Credencials.Conta`	`string`	Número da conta no Itaú (ver etapa de obtenção de credenciais com o Itaú).
`Credencials.Carteira`	`string`	Código da carteira obtido com o Itaú na etapa de obtenção de credenciais com o Itaú.
`Credencials.Vencimento`	`string`	Quantidade de dias para vencimento do boleto a partir da data atual. Só será aplicado se o estabelecimento não informar a data de vencimento do boleto. Ex. Se `Vencimento` = "1", a data de vencimento do boleto será a data atual mais um dia.

Resposta

200 OK: onboarding realizado com sucesso. Retorna o objeto de resposta do provedor.
401 Unauthorized: falha na autenticação dos headers.
400 Bad Request: dados inválidos no corpo da requisição.

4. Configurar o novo provedor na requisição ao Gateway de Pagamento

Na integração da requisição de criação de boleto ao Gateway de Pagamento, altere o valor de Payment.Provider para Itau3

5. Configurar a conciliação automática do boleto

Com o Itaú Shopline a conciliação era feita por API diretamente com o Itaú. Na integração com o boleto Itaú API a conciliação será por arquivo e configurada com a parceira van Nexxera.

📘
Veja no artigo: Como funciona a conciliação de boleto o passo a passo para a configuração da conciliação via arquivo.

No modelo de conciliação por arquivos, a conciliação automática de boletos pagos será mantida.

Updated 7 months ago

Did this page help you?

1. Obter credenciais no Itaú

2. Gerar certificado dinâmico

Para gerar o certificado dinâmico, acesse a documentação do Itaú e vá para o Passo 7 – Passo a passo para gerar o certificado dinâmico.

Formato do certificado dinâmico

3. Onboarding do boleto Itaú API no Gateway de Pagamento

Requisição

Resposta

4. Configurar o novo provedor na requisição ao Gateway de Pagamento

5. Configurar a conciliação automática do boleto

Veja no artigo: Como funciona a conciliação de boleto o passo a passo para a configuração da conciliação via arquivo.