README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require mah-shamim/city-bank-api

Usage

For Non-Laravel Projects

$config = [
        'mode' => 'sandbox',
        'username' => 'CITY_BANK_API_USERNAME',
        'password' => 'CITY_BANK_API_PASSWORD',
        'company' => 'CITY_BANK_EXCHANGE_COMPANY',
        'base_url' => 'https://nrbms.thecitybank.com',
        'api_url' => '/nrb_api_test/dynamicApi.php?wsdl',
    ];
    

$cityBank = new \MahShamim\CityBank($config);

For Laravel & Lumen

You can set up whole configuration using this command

php artisan city-bank:install

You can publish the config file with(Laravel & Lumen):

php artisan vendor:publish --tag="city-bank-config"

This is the contents of the published config file:

return [
    'mode' => env('CITY_BANK_API_MODE', \MahShamim\CityBank\Config::MODE_SANDBOX), //sandbox, live
    'sandbox' => [
        'mode' => \MahShamim\CityBank\Config::MODE_SANDBOX,
        'username' => env('CITY_BANK_API_USERNAME'),
        'password' => env('CITY_BANK_API_PASSWORD'),
        'company' => env('CITY_BANK_EXCHANGE_COMPANY'),
        'base_url' => 'https://nrbms.thecitybank.com/nrb_api_test',
        'api_url' => '/dynamicApi.php?wsdl',
    ],
    'live' => [
        'mode' => \MahShamim\CityBank\Config::MODE_LIVE,
        'username' => env('CITY_BANK_API_USERNAME'),
        'password' => env('CITY_BANK_API_PASSWORD'),
        'company' => env('CITY_BANK_EXCHANGE_COMPANY'),
        'base_url' => 'https://nrbms.thecitybank.com',
        'api_url' => '/dynamicApi.php?wsdl',
    ],
];

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

mah-shamim / city-bank-api

Maintainers

Details