ebanx/benjamin

Business rule provider lib for plugin implementations


README

Build Status codecov Latest Stable Version Total Downloads License

This is the repository for business rules as of implemented by merchant sites for use in e-commerce platform plugins. The objective is to be a central repository for services and to communicate with the EBANX API (also known as "Pay").

Getting Started

It is very simple to use Benjamin. You will only need an instance of Ebanx\Benjamin\Models\Configs\Config and an instance of Ebanx\Benjamin\Models\Payment:

<?php
$config = new Config([
    'integrationKey' => 'YOUR_INTEGRATION_KEY',
    'sandboxIntegrationKey' => 'YOUR_SANDBOX_INTEGRATION_KEY'
]);

$payment = new Payment([
    //Payment properties(see wiki)
]);

$result = EBANX($config)->create($payment);

If you want more information you can check the Wiki.

Contributing

Check the Wiki.

License

Copyright 2017 EBANX Payments

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.