bankofmaldives / bml-connect-php
PHP Bindings for the BML Connect API
Installs: 5 191
Dependents: 3
Suggesters: 0
Security: 0
Stars: 3
Watchers: 5
Forks: 17
Open Issues: 6
Requires
- php: >= 7.0
- guzzlehttp/guzzle: ~6.0|~7.0
Requires (Dev)
- phpstan/phpstan: ^0.9.2
- phpunit/phpunit: ~5.0
- roave/security-advisories: dev-master
- squizlabs/php_codesniffer: ^3.1
This package is auto-updated.
Last update: 2024-10-07 17:24:39 UTC
README
The code provided for this service is a sample code. In the event of any direct or indirect losses due to use of this code, Bank of Maldives is not liable for damages. We advise all merchants to generate a unique code based on this sample code to avoid any possibility of loss that may arise in the future.
BMLConnectPHP
PHP API Client and bindings for the Bank of Maldives Connect API
Using this PHP API Client you can interact with your Bank of Maldives Connect API:
- 💳 Transactions
Installation
Requires PHP 7.0 or higher
The recommended way to install bml-connect-php is through Composer:
First, install Composer:
$ curl -sS https://getcomposer.org/installer | php
Next, install the latest bml-connect-php:
$ php composer.phar require bankofmaldives/bml-connect-php
Finally, you need to require the library in your PHP application:
require "vendor/autoload.php";
Development
- Run
composer test
andcomposer phpcs
before creating a PR to detect any obvious issues. - Please create issues for this specific API Binding under the issues section.
- Contact Bank of Maldives directly for Bank of Maldives Connect API support.
Quick Start
BMLConnect\Client
First get your production
or sandbox
API key from Merchant Portal.
If you want to get a production
client:
use BMLConnect\Client; $client = new Client('apikey', 'appid');
If you want to get a sandbox
client:
use BMLConnect\Client; $client = new Client('apikey', 'appid', 'sandbox');
If you want to pass additional GuzzleHTTP options:
use BMLConnect\Client; $options = ['headers' => ['foo' => 'bar']]; $client = new Client('apikey', 'appid', 'sandbox', $options);
Available API Operations
The following exposed API operations from the Bank of Maldives Connect API are available using the API Client.
See below for more details about each resource.
💳 Transactions
Create a new transaction with or without a specific payment method.
Usage details
💳 Transactions
Create transaction with a specific payment method
use BMLConnect\Client; $client = new Client('apikey', 'appid'); $json = [ "provider" => "alipay", // Payment method enabled for your merchant account such as bcmc, alipay, card "currency" => "MVR", "amount" => 1000, // 10.00 MVR "redirectUrl" => "https://foo.bar/order/123" // Optional redirect after payment completion ]; $transaction = $client->transactions->create($json); header('Location: '. $transaction["url"]); // Go to transaction payment page
Create transaction without a payment method that will redirect to the payment method selection screen
use BMLConnect\Client; $client = new Client('apikey', 'appid'); $json = [ "currency" => "MVR", "amount" => 1000, // 10.00 MVR "redirectUrl" => "https://foo.bar/order/987" // Optional redirect after payment completion ]; $transaction = $client->transactions->create($json); header('Location: '. $transaction["url"]); // Go to payment method selection screen
About
⭐ Sign up as a merchant at https://dashboard.merchants.bankofmaldives.com.mv and start receiving payments in seconds.