Download the PHP package bitsika/merchant-sdk-php without Composer
On this page you can find all versions of the php package bitsika/merchant-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bitsika/merchant-sdk-php
More information about bitsika/merchant-sdk-php
Files in bitsika/merchant-sdk-php
Package merchant-sdk-php
Short Description This package fluent way to use the bitsika merchant api.
License MIT
Homepage https://github.com/bitsika/merchant-sdk-php
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package merchant-sdk-php
Bitsika Console for Merchants - PHP SDK
The Bitsika PHP library gives convenient access to the Console Merchant API for applications written in the PHP language. Devs and merchants alike can use our API and corresponding dashboard to create invoices that any Bitsika user can instantly pay. Learn more here: https://console.bitsika.africa. Our raw API documentation: https://documenter.getpostman.com/view/12690520/UUy39RrV. Small video demo.
General Requirements
- PHP version 7.0 or greater.
- Composer for installing packages.
- The binding relies on Guzzle to work fine. This package comes pre-installed with Guzzle.
Installation
Install the Bitsika PHP Library. Version to install is dev-main.
You can also install these packages using the composer install command from your composer.json file.
To use the bindings, use Composer's autoload.
Getting Started
To get started, create an instance of the Merchant class. You will need a copy of your Bitsika API Secret Key. This can be found on the Keys and Security page of our Console.
The variable $merchant is now an instance of the Merchant class and can be used to perform any of the multiple tasks available to merchants.
Merchant Methods
Get merchant detail.
This method returns basic data related to the merchant company whose Secret Key you’re currently using. Data returned includes company name, Bitsika username, profile picture URL, KYC status, balances across multiple currencies and much more.
Get merchant statistics.
This method returns transaction statistics pertaining to the respective merchant company. It returns data like number of unique users, sum of successful transactions, sum of all transactions, etc.
Invoice Methods
Create invoice.
This method returns basic data for a newly created invoice including (most importantly) the invoice / payment web link URL. This invoice can we paid by any Bitsika user who opens the payment link. They can pay the invoice with any currency balance in their Bitsika app. You, the merchant, will get settled instantly in the currency you specify when creating the invoice below.
| Param | Required | About | Validation |
|---|---|---|---|
| title | Yes | Title of the invoice. Here, provide a heading of the service you rendered to your customer. For example "Vanilla ice-cream with coconut shavings". | String. Minimum number of characters = 4. Maximum number of characters = 50. |
| description | Yes | Provide more info on the service your customer is about to pay for. Example: "2 scoops of vanilla ice-cream, chocolate biscuits and coconut shavings. Large cup size". | String. Minimum number of characters = 4. Maximum number of characters = 280. |
| amount | Yes | Amount number that the service costs. | Integer. Minimum amount: 1. Maximum amount: 10000000. 2 decimal places, if used. It is important to note that because of KYC, fraud control and best practices, we suggest that the amount of your invoice doesn't exceed the equivalent of $1,000 in its respective currency. |
| currency | Yes | Denote the currency you / your company would like the payment of this invoice to be settled in. | String. Provide one of the following currencies: NGN, USD, XOF, XAF, GHS |
| recipient_email | No | Who should a copy of this invoice be sent to upon creation? | String / Email format. Minimum number of characters = 4. Maximum number of characters = 50. |
| photo_url | No | Provide the URL of your product's / service's item photo. | String / URL format. Minimum number of characters = 4. Maximum number of characters = 280. |
Get invoice by id.
This method is used to query an invoice’s data any time in the future. You can use this method to manually check on the state (if it’s been paid or not) or expiry status of an invoice.
Send cash.
Your merchant company needs to be verified (KYC verification) before you can successfully call this method.
Use this method to send money from your company’s merchant balances to any Bitsika user or merchant with a $username or $cashtag. All such transfers are instant and free.
| Param | Required | About | Validation |
|---|---|---|---|
| platform | Yes | What network are you transferring the money on? | String. bitsika |
| amount | Yes | Numerical value of amount to be transferred. | Integer. Minimum amount: 1. Maximum amount: 10000000. 2 decimal places, if used. It is important to note that because of KYC, fraud control and best practices, we suggest that the amount of your invoice doesn't exceed the equivalent of $1,000 in its respective currency. |
| currency | Yes | Denote the currency you / your company would like the end user to receive the transfer in. | String. Provide one of the following currencies: NGN, USD, XOF, XAF, GHS |
| username | Yes | Provide the username or cashtag of the Bitsika user or merchant you're making the transfer to. |
String. Example: davido, taylorswift13. Do not include the $ infront of the username when writing it. |
| debit_from | Yes | Denote the currency balance you / your company would like the transfer to be deducted from. You can make a transfer in one currency, debited from another. For example: you can send a user 100 USD, but choose to deduct the debit from your NGN balance. | String. Provide one of the following currencies: NGN, USD, XOF, XAF, GHS |
| purpose | No | A comment or note to accompany the transfer. | String. Minimum number of characters = 4. Maximum number of characters = 255. |
Verify transaction.
Use this method to verify the status of transfers you make with the Send Cash method above.
Search for a user.
Use this method to search for a bitsika user, and verify is they exist.
Virtual card
Merchants can generate virtual cards for their account. Here's a list of operations that can be performed pertaining to a virtual card.
Create Card
This method is used to create a virtual card
| Param | Required | About | Validation |
|---|---|---|---|
| name | Yes | The virtual card name | String |
| currency | Yes | The currency the generated card will have | String. NGN, USD, GHS |
| amount | Yes | The amount to fund the card with upon creation | Integer. numeric |
| debit_from | Yes | The wallet currency to be debited from upon creation | String.NGN, USD, GHS |
Get all virtual cards
You can fetch all the available virtual cards with the method below
Get virtual card by id
You can get a virtual card by it's id with the method below
Top-up virtual card by id
You can top up a virtual card by it's id with the method below
| Param | Required | About | Validation |
|---|---|---|---|
| amount | Yes | The amount to fund the card with | Integer. numeric |
| currency | Yes | The currency to fund the card with | String. NGN, USD, GHS |
| debit_from | Yes | The wallet currency to be debited from | String.NGN, USD, GHS |
Withdraw from card by id
You can withdraw from a virtual card by it's id with the method below
Get card Transactions
You can fetch a virtual card's transaction by it's id with the method below
Freeze Card
You can freeze a virtual card by it's id with the method below
Unfreeze Card
You can unfreeze a virtual card by it's id with the method below
Invoice Webhooks
Whenever invoices are paid, notifications are sent to the webhook URL you provided on the Keys and Security page of your Bitsika Console account. Your webhook URL is expected to be an unauthenticated POST request URL.
Once payments are recieved, weather Initiated, Failed or Successful, we make a Post request containing the event object to your webhook URL.
The request object contains the event, invoice_id and transaction details.
The event key will be invoice.payment_failed for failed payments, or invoice.payment_success for successful payments.
The invoice_id is the id of the invoice being paid for, while the transaction key contains a JSON object of the payment.
Verifying webhooks
(Optional) Everytime a request is made to your webhook url, for security reasons, we also send a x-bitsika-signature in the header. This contains a HMAC SHA512 hash of the payload signed using your secret key.
Sample Response - An example of the JSON response to expect:
License
The MIT License (MIT). Please see License File for more information.
