levelfiveteam/railsbank-sdk

Railsbank PHP SDK

v1.4 2019-08-20 21:17 UTC

Requires

• php: ^7.1
• ext-json: *
• guzzlehttp/guzzle: ^6.3
• league/container: ^3.3
• league/tactician: ^1.0
• league/tactician-container: ^2.0
• zendframework/zend-coding-standard: ~1.0.0
• zendframework/zend-config: ^3.2
• zendframework/zend-inputfilter: ^2.10
• zendframework/zend-validator: ^2.12

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpstan/phpstan: ^0.11.7
• phpunit/phpcov: ^5.0
• phpunit/phpunit: ^7.5

MIT

• Gaurav Malhotra

README

This is the Railsbank integration using PHP.

_{This repository is actively used in projects, and we will be maintaining it regularly.}

Donations

[

Instructions

This is the Railsbank PHP SDK Kit that allows you to provide a full facility to create customer accounts, ledgers, and a mastercard for your business/service.

We use commands and queries to de-couple requests, and to allow the ability to use a messaging queue system (AWS SQS, RabbitMQ etc...).

1. Simply set your application to store the service as a factory;

$railsbank = new Railsbank('demo.config.php', 'live_account');

1. Create commands and queries as and when you need to (example below returns back a response to give you the API Version);

Example query: $response = $railsbank->handle(new GetVersion());

Example Command:

$command = new CreatePerson(
    [
        'name' => 'Mr Sponge Bob',
        'date_of_birth' => '1983-02-02',
        'telephone' => '07000000001',
        'nationality' => 'British',
        'country_of_residence' => 'GB',
        'date_onboarded' => (new \DateTime('now'))->format('d-m-Y'),
        'address' => [ 'address_refinement' => 'Spongebob House, Indian Ocean, Ocean12' ],
    ]
);

$person = $railsbank->handle($command);

You will not need to validate data using this service. Validation happens at the command level. Any validation errors will return as a DomainException with a json error message.

The valid response will be an immutable object, with the option to see the the full response.

Important note; we are only supporting GBP. Our aim is to release this in v1.2.

Commands and Queries

Action	Command or Query
GET	Query\Version\GetVersion
GET	Query\Me\Information
GET	Query\Customer\GetLedger
GET	Query\Customer\GetLedgers
GET	Query\Customer\GetEndusers
GET	Query\Customer\GetEnduser
GET	Query\Transaction\GetTransaction
GET	Query\Transaction\GetTransactions
GET	Query\Card\GetCard
GET	Query\Card\GetCards
GET	Query\Card\GetCardsByLedgerId
GET	Query\Card\GetCardImageUrl
GET	Query\Card\GetPin
GET	Query\Beneficiary\GetBeneficiaries
POST	Command\Customer\EndUsers\CreatePerson
POST	Command\Customer\Ledger\CreateLedger
POST	Command\Customer\Ledger\CloseLedger
POST	Command\Beneficiary\CreateBeneficiary
POST	Command\Transaction\CreateTransaction
POST	Command\Card\CreateCard
POST	Command\Card\ActivateCard

Submitting bugs and feature requests

Bugs and feature requests are tracked on GitHub.

We are actively updating the SDK Kit.

Licence

You are free to reuse and adapt this content with credit, for non-commercial purposes. Please review License for further information.