Retorno¶

There are 2 types of Retornos: 240 positions and 400 positions.

Options available by bank:

Banco	240	400
Bancoob	yes	yes
Banrisul	yes*	yes*
Banco do Brasil	yes	yes*
Banco do Nordeste	no	no
Bradesco	yes	yes*
Caixa Econônica Federal	yes	yes*
HSBC	no	yes
Itaú	yes	yes*
Santander	yes	yes
Sicredi	yes*	yes*

Note

* requires homologation

All banks have the same reading process. The constructor accepts as argument:

// File path
$argument = '/path/to/retorno.ret';

// Or, String content
$argument = '0RETORNOCONTENTHERE...\n1RETORNOCONTENTHERE...';

// Or, Array content
$argument = [
    '0RETORNOCONTENTHERE...',
    '1RETORNOCONTENTHERE...'
];

Factory¶

// The Factory will guess what the return if it is 240 or 400 and which bank and already return the instantiated object
$return = \Eduardokum\LaravelBoleto\Cnab\Retorno\Factory::make($argument);

// To process the file
$return->processar();

// You can know the type of bank after instantiate, using the methods respectively:
$return->getTipo();
$return->getCodigoBanco();

Bancoob¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bancoob($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bancoob($argument)

// To process the file
$return->processar();

Banrisul¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Banrisul($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Banrisul($argument)

 // To process the file
$return->processar();

Banco do Brasil¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bb($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bb($argument)

 // To process the file
$return->processar();

Banco do Nordeste¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bnb($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bnb($argument)

 // To process the file
$return->processar();

Bradesco¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Bradesco($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Bradesco($argument)

 // To process the file
$return->processar();

Caixa Econônica Federal¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Caixa($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Caixa($argument)

 // To process the file
$return->processar();

HSBC¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Hsbc($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Hsbc($argument)

 // To process the file
$return->processar();

Itaú¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Itau($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Itau($argument)

 // To process the file
$return->processar();

Santander¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Santander($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Santander($argument)

 // To process the file
$return->processar();

Sicredi¶

// 400 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab400\Banco\Sicredi($argument)

// 240 positions
$return = new \Eduardokum\LaravelBoleto\Cnab\Retorno\Cnab240\Banco\Sicredi($argument)

 // To process the file
$return->processar();

Dealing with the return¶

In return of 400 positions the object of the bank has the following methods:

// This will return a iterable object, with all returns
$return->getDetalhes();
// This will return a object with information
$return->getHeader();
// This will return a object with totals information
$return->getTrailer();

 // To iterate do:
foreach($return->getDetalhes() as $object) {
    var_dump($object->toArray());
}

In return of 240 positions the object of the bank has the following methods:

// This will return a iterable object, with all returns
$return->getDetalhes();
// This will return a object with information
$return->getHeader();
// This will return a object with information by lote
$return->getHeaderLote();
// This will return a object with totals information
$return->getTrailer();
// This will return a object with totals information by lote
$return->getTrailerLote();

// To iterate do:
foreach($return->getDetalhes() as $object) {
    var_dump($object->toArray());
}

The return object implements SeekableIterator, so you can do a foreach on the object that will iterate for each return:

foreach($return as $object) {
    var_dump($object->toArray());
}