https://github.com/mah-shamim/city-bank-api
This document provides the details related to Remittance API. This APIs is used to initiate payment request from Mobile client/others exchange house.
https://github.com/mah-shamim/city-bank-api
hacktoberfest
Last synced: about 1 month ago
JSON representation
This document provides the details related to Remittance API. This APIs is used to initiate payment request from Mobile client/others exchange house.
- Host: GitHub
- URL: https://github.com/mah-shamim/city-bank-api
- Owner: mah-shamim
- License: mit
- Created: 2022-08-13T19:03:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T20:00:12.000Z (about 1 year ago)
- Last Synced: 2025-02-28T09:20:43.046Z (2 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 300 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# City Bank Remittance API
[](https://packagist.org/packages/mah-shamim/city-bank-api)
[](https://github.com/mah-shamim/city-bank-api/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/mah-shamim/city-bank-api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/mah-shamim/city-bank-api)
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:
```bash
composer require mah-shamim/city-bank-api
```
## Usage
### For Non-Laravel Projects
```php
$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
```bash
php artisan city-bank:install
```
OR
You can publish the config file with(Laravel & Lumen):
```bash
php artisan vendor:publish --tag="city-bank-config"
```
This is the contents of the published config file:
```php
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](docs/CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/mah-shamim/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [MD ARIFUL HAQUE](https://github.com/mah-shamim)
- [Mohammad Hafijul Islam](https://github.com/hafijul233)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Support us
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
