Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 3.89 KB

README.md

File metadata and controls

92 lines (69 loc) · 3.89 KB
Raw

SwissPayment

Build Status Tested on PHP PHP 7.2, 7.3, 7.4, 8.0

SwissPayment is a PHP library to generate Swiss pain.001 XML messages (complies with ISO-20022).

Installation

Just install Composer and run composer require ch2877/swiss-payment in your project directory.

Usage

To get a basic understanding on how the messages are structured, take a look the resources mentioned below. The following example shows how to create a message containing two transactions:

<?php

require_once __DIR__.'/vendor/autoload.php';

use Z38\SwissPayment\BIC;
use Z38\SwissPayment\IBAN;
use Z38\SwissPayment\Message\CustomerCreditTransfer;
use Z38\SwissPayment\Money;
use Z38\SwissPayment\PaymentInformation\PaymentInformation;
use Z38\SwissPayment\PostalAccount;
use Z38\SwissPayment\StructuredPostalAddress;
use Z38\SwissPayment\TransactionInformation\BankCreditTransfer;
use Z38\SwissPayment\TransactionInformation\IS1CreditTransfer;
use Z38\SwissPayment\UnstructuredPostalAddress;

$transaction1 = new BankCreditTransfer(
    'instr-001',
    'e2e-001',
    new Money\CHF(130000), // CHF 1300.00
    'Muster Transport AG',
    new StructuredPostalAddress('Wiesenweg', '14b', '8058', 'Zürich-Flughafen'),
    new IBAN('CH51 0022 5225 9529 1301 C'),
    new BIC('UBSWCHZH80A')
);

$transaction2 = new IS1CreditTransfer(
    'instr-002',
    'e2e-002',
    new Money\CHF(30000), // CHF 300.00
    'Finanzverwaltung Stadt Musterhausen',
    UnstructuredPostalAddress::sanitize('Altstadt 1a', '4998 Musterhausen'),
    new PostalAccount('80-151-4')
);

$payment = new PaymentInformation(
    'payment-001',
    'InnoMuster AG',
    new BIC('ZKBKCHZZ80A'),
    new IBAN('CH6600700110000204481')
);
$payment->addTransaction($transaction1);
$payment->addTransaction($transaction2);

$message = new CustomerCreditTransfer('message-001', 'InnoMuster AG');
$message->addPayment($payment);

echo $message->asXml();

Tip: Take a look at Z38\SwissPayment\Tests\Message\CustomerCreditTransferTest to see all payment types in action.

Caveats

  • Not all business rules and recommendations are enforced, consult the documentation and validate the resulting transaction file in cooperation with your bank.
  • At the moment cheque transfers are not supported (for details consult chapter 2.2 of the Implementation Guidelines)
  • The whole project is still under development and therefore BC breaks can occur. Please contact me if you need a stable code base.

Contributing

If you want to get your hands dirty, great! Here's a couple of steps/guidelines:

  • Fork this repository
  • Add your changes & tests for those changes (in tests/).
  • Remember to stick to the existing code style as best as possible. When in doubt, follow PSR-2.
  • Send me a pull request!

If you don't want to go through all this, but still found something wrong or missing, please let me know, and/or open a new issue report so that I or others may take care of it.

Further Resources