leandroferreirama/api-itau

SDK php para integração com a API Itau

v2.2.6 2024-12-11 20:32 UTC

Requires

• php: >=8.1

MIT

• Leandro Ferreira

README

Esta api está habilitada a utilizar a API PIX do banco central, bolecode do Itaú, alteração e baixa utilizando a API de boleto do Itaú

IMPORTANTE

• Para utilizar todas as funções da API é necessário realizar duas habilitações junto ao itaú. Uma servirá para consumir a api pix e bolecode, a outra para consumir a alteração de vencimento e baixa de boleto.

Installation

Api Itau é disponibilizado através do composer:

"leandroferreirama/api-itau": "^2.0"

or run

composer require leandroferreirama/api-itau

Documentation

API pix:

<?php

require __DIR__ . "/../vendor/autoload.php";

use Itau\API\Itau;
use Itau\API\Pix\Pix;

try{
    $itau = new Itau(
        "clientID",
        "secretToken",
        __DIR__ . "/caminhoCertificado",
        __DIR__ . "/caminhoCertificadoKey"
    );

    #Descomente este trecho caso queira imprimir na tela o JSON da requisição
    #$itau->setDebug(true);

    //pix
    $pix = new Pix();
    $pix->setChave('chavePixCadastradaBanco');
    $pix->valor()->setOriginal('10.00');
    $response = $itau->pix($pix);

    //capturando o payload do PIX (copia e cola)
    $response->getPixCopiaECola();
} catch(Exception $e){

}

API bolecode (Boleto + PIX):

<?php

require __DIR__ . "/../vendor/autoload.php";

use Itau\API\Itau;
use Itau\API\BoleCode\BoleCode;

try{
    $itau = new Itau(
        "clientID",
        "secretToken",
        __DIR__ . "/caminhoCertificado",
        __DIR__ . "/caminhoCertificadoKey"
    );

    #Descomente este trecho caso queira imprimir na tela o JSON da requisição
    #$itau->setDebug(true);

    #Explicações dos campos após este exemplo
    $boleCode = new BoleCode (
        $modo, $agencia, $conta, $contaDV, $valor, $tipoBoleto, $numeroDocumento, $nome, $tipoPessoa,
        $documento, $endereco, $numero, $complemento, $bairro, $cidade, $siglaEstado, $cep, $nossoNumero,
        $vencimento, $chavePix, $tipoMulta, $percentualMulta, $tipoJuros, $percentualJuros
    );

    $response = $itau->boleCode($boleCode);

    #Caso tenha sucesso, conseguirá recuperar o TXID dessa maneira
    $response->getTxid();

    #PIXCOPIA E COLA - Em caso de sucesso
    $response->getPixCopiaECola();

} catch(Exception $e){

}

Explicação dos campos

Modo

BoleCode::ETAPA_EFETIVO ou BoleCode::ETAPA_TESTE

Tipo Boleto

DadoBoleto::ESPECIE_DS = Boleto de Serviço

DadoBoleto::ESPECIE_DM = Boleto de Venda

Tipo Pessoa

TipoPessoa::PESSOA_FISICA = Para CPF

TipoPessoa::PESSOA_JURIDICA = Para CNPJ

Sigla Estado

Duas Sílabas apenas = Ex: SP

Nosso Número

Seu número.É de sua responsabilidade gerar esse número único para boleto.

Vencimento

Padrão: Y-m-d (não possui tratamento de conversão)

Tipo Multa

Multa::SEM_MULTA = Sem multa

Multa::PERCENTUAL = Percentual

Valor Multa

2 = 2%

Tipo Juros

Juros::SEM_JUROS = Sem juros

Juros::PERCENTUAL_MENSAL = Percentual mensal

Valor Juros

1 = 1% am

API Baixar Boleto:

ATENÇÃO: O clientId, SecretToken e certificados devem ser diferentes do utilizado na API do PIX e Bolecode

<?php

require __DIR__ . "/../vendor/autoload.php";

use Itau\API\Itau;

try{
    $itau = new Itau(
        "clientID",
        "secretToken",
        __DIR__ . "/caminhoCertificado",
        __DIR__ . "/caminhoCertificadoKey"
    );

    #Descomente este trecho caso queira imprimir na tela o JSON da requisição
    #$itau->setDebug(true);

    $response = $itau->baixarBoleto('agencia', 'contaComDVSemTraço', 'cateira(geralmente 109)', 'nossoNumeroSemDV');
    
    if($response->getStatusCode() == 204){
        //Sucesso quando retornado o status code 204
    }
} catch(Exception $e){

}

API Alterar Valor:

ATENÇÃO: O clientId, SecretToken e certificados devem ser diferentes do utilizado na API do PIX e Bolecode

<?php

require __DIR__ . "/../vendor/autoload.php";

use Itau\API\Itau;

try{
    $itau = new Itau(
        "clientID",
        "secretToken",
        __DIR__ . "/caminhoCertificado",
        __DIR__ . "/caminhoCertificadoKey"
    );

    #Descomente este trecho caso queira imprimir na tela o JSON da requisição
    #$itau->setDebug(true);

    $response = $itau->alterarValorBoleto(
        'agencia', 'contaComDVSemTraço', 'cateira(geralmente 109)', 'nossoNumeroSemDV',
        new Valor('100.00')
    );
    
    if($response->getStatusCode() == 204){
        //Sucesso quando retornado o status code 204
    }
} catch(Exception $e){

}

API Alterar Vencimento:

<?php

require __DIR__ . "/../vendor/autoload.php";

use Itau\API\Itau;
use Itau\API\Vencimento\Vencimento;

try{
    $itau = new Itau(
        "clientID",
        "secretToken",
        __DIR__ . "/caminhoCertificado",
        __DIR__ . "/caminhoCertificadoKey"
    );

    #Descomente este trecho caso queira imprimir na tela o JSON da requisição
    #$itau->setDebug(true);

    $response = $itau->alterarVencimentoBoleto(
        'agencia', 'contaComDVSemTraço', 'cateira(geralmente 109)', 'nossoNumeroSemDV',
        new Vencimento('novoVencimento (Y-m-d)')
    );
    
    if($response->getStatusCode() == 204){
        //Sucesso quando retornado o status code 204
    }
} catch(Exception $e){

}

Suporte

Se você descobrir algum problema relacionado à segurança ou tiver alguma dúvida, envie um e-mail para [e-mail].

Credits

• Leandro Ferreira Marcelli (Developer)

License

The MIT License (MIT). Please see License File for more information.