kouinkouin/be-bank-transfer-message

Generate and validate Belgian bank transfer structured messages

BE Bank Transfer Message

, _(*1)

This package contains a validator and generator for structured messages included in Belgian bank transfers. Common use cases:, _(*2)

• Automatic generation of order invoices.
• Association of payment provider messages to orders stored in your application.

The structured message format adheres to the Febelfin Guidelines, _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require kouinkouin/be-bank-transfer-message, <sub>(*5)</sub>

## Usage

### Generate a structured message

Based on a random number

``` php
$transferMessage = new BeBankTransferMessage\TransferMessage();
echo transferMessage->getStructuredMessage();

Based on a predefined number, <sub>(*6)</sub>

``` php $transferMessage = new BeBankTransferMessage\TransferMessage(12345); echo transferMessage->getStructuredMessage();, <sub>(*7)</sub>

Change to a different predefined number

``` php
$transferMessage->setNumber(54321);
$transferMessage->generate();
echo transferMessage->getStructuredMessage();

Or a random number, <sub>(*8)</sub>

``` php $transferMessage->setNumber(); $transferMessage->generate(); echo transferMessage->getStructuredMessage();, <sub>(*9)</sub>

The default, valid circumfix of a structured message is the plus sign. Optionally, it's possible to use asterisks as a circumfix, if your formatting demands it.

``` php
$transferMessage->setNumber();
$transferMessage->generate(TransferMessage::CIRCUMFIX_ASTERISK);
echo transferMessage->getStructuredMessage();

Validate a structured message

A valid message, <sub>(*10)</sub>

``` php $transferMessage = new BeBankTransferMessage\TransferMessage(); $transferMessage->setStructuredMessage('+++090/9337/55493+++'); $result = $transferMessage->validate(); // TRUE, <sub>(*11)</sub>

An invalid message

``` php
$transferMessage = new BeBankTransferMessage\TransferMessage();
$transferMessage->setStructuredMessage('+++011/9337/55493+++');
$result = $transferMessage->validate();  // FALSE

Additionally the setter method will throw an TransferMessageException() if the format of the structured message is not valid., <sub>(*12)</sub>

Testing

bash $ phpunit, <sub>(*13)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*14)</sub>

Credits

• Matthias Vandermaesen
• kouinkouin

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>