Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abcaeffchen/sephpa
PHP class to create SEPA xml files for credit transfer and direct debit
https://github.com/abcaeffchen/sephpa
credit-transfer direct-debits php sepa sepa-files xml
Last synced: 4 days ago
JSON representation
PHP class to create SEPA xml files for credit transfer and direct debit
- Host: GitHub
- URL: https://github.com/abcaeffchen/sephpa
- Owner: AbcAeffchen
- License: lgpl-3.0
- Created: 2013-09-08T09:55:06.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T15:51:18.000Z (11 months ago)
- Last Synced: 2024-12-15T04:08:15.184Z (11 days ago)
- Topics: credit-transfer, direct-debits, php, sepa, sepa-files, xml
- Language: PHP
- Homepage:
- Size: 309 KB
- Stars: 72
- Watchers: 10
- Forks: 32
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Sephpa - A PHP class to export SEPA files
===============
[](https://github.com/AbcAeffchen/Sephpa/actions/workflows/php.yml)
[](https://packagist.org/packages/abcaeffchen/sephpa)
[](https://packagist.org/packages/abcaeffchen/sephpa)
[](https://packagist.org/packages/abcaeffchen/sephpa)
[](https://gitter.im/AbcAeffchen/Sephpa?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## General
**Sephpa** [sefa] is a PHP class that creates SEPA XML files. The created XML files fulfill
the specifications of Electronic Banking Internet Communication Standard (EBICS).
## Supported file versions
- SEPA Credit Transfer
- pain.001.001.03
- pain.001.002.03
- pain.001.003.03
- SEPA Direct Debit
- pain.008.001.02
- pain.008.001.02.austrian.003
- pain.008.002.02
- pain.008.003.02
## Requirements
Sephpa was created for PHP >=7.1 including PHP 8 and requires [SepaUtilities 1.3.4+](https://github.com/AbcAeffchen/SepaUtilities) and [SimpleXML](http://php.net/manual/en/book.simplexml.php).
Sephpa should also work with PHP <=5.6, but since these versions are very old and don't get
any security updates, it is strongly recommended not to use PHP older than 5.6.
If you want to download correctly sorted files, you also need the zip library and for documentation
files you need [SepaDocumentor](https://github.com/AbcAeffchen/SepaDocumentor).
## Installation
### Composer
Just add
```json
{
"require": {
"abcaeffchen/sephpa": "^2.0"
}
}
```
to your `composer.json` and include the Composer autoloader to your script.
### Direct download
You can download Sephpa from this GitHub page. Make sure you also download [SepaUtilities](https://github.com/AbcAeffchen/SepaUtilities).
You should store the files in a structure that looks like this:
```
your project root
├── your_code
│ └── ...
└── vendor
├── Sephpa (the Sephpa project go here)
├── SepaUtilities (the SepaUtilities files go here)
└── ...
```
In your code you can include the Sephpa autoloader by including the file
```
vendor/Sephpa/src/autoloader.php
```
You also need to include the SepaUtilities file which should be
```
vendor/SepaUtilities/src/SepaUtilities.php
```
In total your code should look something like this:
```
require PROJECT_ROOT . '/vendor/Sephpa/src/autoloader.php';
require PROJECT_ROOT . '/vendor/abcaeffchen/sepa-utilities/src/SepaUtilities.php';
```
You need to define `PROJECT_ROOT` by yourself.
### Documentation Module
Sephpa uses [SepaDocumentor](https://github.com/AbcAeffchen/SepaDocumentor) to create File
Routing Slips and Control Lists. If you are interested in this files you need to add
```
{
"require": {
"abcaeffchen/sepa-documentor": "^1.0"
}
}
```
to your composer file or download it from the website and make it available to Sephpa.
## Disclaimer
Sephpa is not meant to teach you SEPA. If you want to learn more about SEPA or SEPA files,
you should ask your bank for help. You use this library at your own risk and I assume no liability
if anything goes wrong. You are supposed to check the files **before** handing them to your bank.
## Documentation
Have a look at the [wiki pages](https://github.com/AbcAeffchen/Sephpa/wiki) for the
documentation and examples.
## Credits
Thanks to [Hermann Herz](https://github.com/Heart1010) who supported me debugging and with great
ideas to improve Sephpa and SepaUtilities.
Thanks to [sargac](https://github.com/sargac) for the help with the wiki pages and for creating
the nice logo.
## Support Sephpa
If you use and like Sephpa, drop me a note on what project you use it. I'm really curious.
If you like it a lot, consider [buying me a coffee](https://www.buymeacoffee.com/schickedanz) :)
## License
Licensed under the LGPL v3.0 License.