Download the PHP package suq/suq-k2-connect-php without Composer
On this page you can find all versions of the php package suq/suq-k2-connect-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download suq/suq-k2-connect-php
More information about suq/suq-k2-connect-php
Files in suq/suq-k2-connect-php
Package suq-k2-connect-php
Short Description Suq's Kopokopo php SDK
License MIT
Homepage https://github.com/kopokopo/k2-connect-php
Informations about the package suq-k2-connect-php
Suq Kopokopo PHP SDK
This is a module to assist php developers in consuming Kopokopo's API
... updated php unit and guzzle
composer require suq/suq-k2-connect-php:dev-master
Installation
You can install the PHP SDK via composer.
The recommended way to install the SDK is with Composer.
Initialisation
The package should be configured with your client id and client secret which you can get from your account on the kopokopo's app
After initialization, you can get instances of offered services as follows:
- Tokens :
$tokens = $K2->TokenService();
- Webhooks :
$webhooks = $K2->Webhooks();
- STK PUSH :
$stk = $K2->StkService();
- Pay :
$pay = $K2->PayService();
- Settlement Transfer :
$transfer = $K2->SettlementTransferService();
- PollingService :
$polling = $K2->PollingService();
- SmsNotificationService :
$sms_notification = $K2->SmsNotificationService();
Usage
Tokens
You will need to pass an access token when sending data to Kopokopo's API.
This will return accessToken
and expiresIn
values
Webhooks
-
Consuming
- Subscription
STK PUSH
For other usage examples check out the example app.
Services
The only supported ISO currency code at the moment is: KES
TokenService
-
$TokenService->getToken()
to get an access token.- The response will have the following structure
NB: The access token is required to send subsequent requests
$TokenService->revokeToken(['accessToken' => 'myRand0mAcc3ssT0k3n'])
to revoke an access token.
NB: The access token cannot be used to send subsequent requests
-
$TokenService->introspectToken(['accessToken' => 'myRand0mAcc3ssT0k3n'])
to introspect a token. $TokenService->infoToken(['accessToken' => 'myRand0mAcc3ssT0k3n'])
to get more information on a token
StkService
-
$StkService->initiateIncomingPayment([ stkOptions ])
:stkOptions
: An array of arrays containing the following keys:tillNumber
: Your online payments short code from Kopo Kopo's DashboardREQUIRED
firstName
: Customer's first namelastName
: Customer's last namephoneNumber
: Phone number to pull money from.REQUIRED
email
: Customer's email addresscurrency
: 3-digit ISO format currency code.REQUIRED
amount
: Amount to charge.REQUIRED
callbackUrl
: Url that the result will be posted toREQUIRED
paymentChannel
: Payment channel. Default is:"M-PESA STK Push"
.REQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
metadata
: It is a hash containing a maximum of 5 key value pairs
-
$StkService->getStatus([location ])
:location
: The request location you get when you send a requestaccessToken
: Gotten from theTokenService
responseREQUIRED
For more information, please read https://api-docs.kopokopo.com/#receive-payments-from-m-pesa-users-via-stk-push
PayService
-
PayService->addPayRecipient([ payRecipientOptions ])
:payRecipientOptions
: An array of arrays containing the following keys:type
: Recipient typeREQUIRED
- Mobile Wallet Recipient(
mobile_wallet
)firstName
: Pay recipient's first nameREQUIRED
lastName
: Pay recipient's last nameREQUIRED
phoneNumber
: Pay recipient's phone numberREQUIRED
email
: Pay recipient's email numbernetwork
: Pay recipient's networkREQUIRED
- Bank Account Recipient(
bank_account
)accountName
: Pay recipient's account nameREQUIRED
accountNumber
: Pay recipient's account numberREQUIRED
bankBranchRef
: Bank branch reference from the kopokopo dashboardREQUIRED
settlementMethod
: Settlement methodREQUIRED
- External Till Recipient(
till
)tillNumber
: Pay recipient's till numberREQUIRED
tillName
: Pay recipient's till nameREQUIRED
- Paybill(
paybill
)paybillName
: Pay recipient's paybill nameREQUIRED
paybillNumber
: Pay recipient's paybill numberREQUIRED
paybillAccountNumber
: Pay recipient's account numberREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
-
PayService->sendPay([ payOptions ])
:payOptions
: An array of arrays containing the following keys:destinationType
: The recipient type.REQUIRED
destinationReference
: The recipient reference.REQUIRED
currency
: 3-digit ISO format currency code.REQUIRED
amount
: Amount to charge.REQUIRED
callbackUrl
: Url that the result will be posted toREQUIRED
description
: Payment descriptionREQUIRED
tags
: Tags associated with the paymentcategory
: Category that the payment belongs toaccessToken
: Gotten from theTokenService
responseREQUIRED
metadata
: It is a hash containing a maximum of 5 key value pairs
-
PayService->getStatus([ location ])
:location
: The request location you get when you send a requestaccessToken
: Gotten from theTokenService
responseREQUIRED
For more information, please read https://api-docs.kopokopo.com/#send-money-pay
SettlementTransferService
-
SettlementTransferService->createMerchantBankAccount([ accountOpts ])
:accountOpts
: An array of arrays containing the following keys:accountName
: Settlement Account NameREQUIRED
bankBranchRef
: Settlement Bank Branch ReferenceREQUIRED
accountNumber
: Settlement account numberREQUIRED
settlementMethod
: Settlement methodREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
-
SettlementTransferService->createMerchantWallet([ accountOpts ])
:accountOpts
: An array of arrays containing the following keys:phoneNumber
: Phone number to settle toREQUIRED
network
: Mobile money network to settle toREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
-
SettlementTransferService->settleFunds([ settleOpts ])
:settleOpts
: An array of arrays containing the following keys:destinationType
: The destination typeREQUIRED FOR A TARGETED TRANSFER
destinationReference
: The destination referenceREQUIRED FOR A TARGETED TRANSFER
currency
: 3-digit ISO format currency code.REQUIRED FOR A TARGETED TRANSFER
amount
: Amount to settle.REQUIRED FOR A TARGETED TRANSFER
PS: If not included the whole balance will be settled.accessToken
: Gotten from theTokenService
responseREQUIRED
-
SettlementTransferService->getStatus([ location ])
:location
: The request location you get when you send a requestaccessToken
: Gotten from theTokenService
responseREQUIRED
For more information, please read api-docs#transfer
PollingService
-
PollingService->pollTransactions([ pollingOpts ])
:pollingOpts
: An array of arrays containing the following keys:fromTime
: The starting time of the polling requesttoTime
: The end time of the polling requestscope
: The scope of the polling requestscopeReference
: The scope referenceREQUIRED for the 'Till' scope
callbackUrl
: Url that the result will be posted toREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
-
PollingService->getStatus([ statusOpts ])
:statusOpts
: An array of arrays containing the following keys:location
: The location url you got from the requestREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
This works the same for all requests that you get a location response.
For more information, please read api-docs#polling
SmsNotificationService
-
SmsNotificationService->sendTransactionSmsNotification([ transactionNotificationOpts ])
:transactionNotificationOpts
: An array of arrays containing the following keys:webhookEventReference
: The webhook event reference for a buygoods_transaction_received webhook.message
: The message to be sentcallbackUrl
: Url that the result will be posted toREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
-
SmsNotificationService->getStatus([ statusOpts ])
:statusOpts
: An array of arrays containing the following keys:location
: The location url you got from the requestREQUIRED
accessToken
: Gotten from theTokenService
responseREQUIRED
This works the same for all requests that you get a location response.
For more information, please read api-docs#transaction-sms-notifications
Responses and Results
- All the post requests are asynchronous apart from
TokenService
. This means that the result will be posted to your custom callback url when the request is complete. The immediate response of the post requests contain thelocation
url of the request you have sent which you can use to query the status.
Note: The asynchronous results are processed like webhooks.
- To access the different parts of the response or webhook payload passed, use the following keys to access:
Token Response
-
getToken() successful response
acessToken
tokenType
expiresIn
createdAt
-
introspectToken() successful response
active
scope
clientId
tokenType
exp
- expiring timeiat
- initiated at
-
infoToken() successful response
scope
expiresIn
resourceOwnerId
applicationId
tokenType
createdAt
Webhooks
-
Buygoods Received
id
topic
createdAt
eventType
resourceId
reference
originationTime
senderPhoneNumber
amount
currency
tillNumber
system
status
senderFirstName
senderMiddleName
senderLastName
linkSelf
linkResource
-
B2b transaction received
id
topic
createdAt
eventType
resourceId
reference
originationTime
sendingTill
amount
currency
tillNumber
system
status
linkSelf
linkResource
-
Merchant to merchant transaction received
id
topic
createdAt
eventType
resourceId
originationTime
sendingMerchant
amount
currency
status
linkSelf
linkResource
-
Buygoods transaction reversed
id
topic
createdAt
eventType
resourceId
reference
originationTime
senderPhoneNumber
amount
currency
tillNumber
system
status
senderFirstName
senderMiddleName
senderLastName
linkSelf
linkResource
-
Transfer completed webhook
id
topic
createdAt
eventType
resourceId
originationTime
amount
currency
status
disbursements
linkSelf
linkResource
destinationReference
destinationType
-
if destination type is bank:
settlementMethod
bankBranchRef
accountName
-
accountNumber
-
if destination type is mobile wallet:
firstName
lastName
phoneNumber
network
-
Customer created webhook
id
topic
createdAt
eventType
firstName
middleName
lastName
phoneNumber
linkSelf
linkResource
Results
-
Settlement Transfer result
id
type
createdAt
status
transferBatches
amount
currency
linkSelf
callbackUrl
-
Payment result
id
type
status
createdAt
transferBatches
amount
currency
metadata
linkSelf
callbackUrl
-
Stk Push Result
-
Successful result
id
type
initiationTime
status
eventType
resourceId
reference
originationTime
senderPhoneNumber
amount
currency
tillNumber
system
senderFirstName
senderMiddleName
senderLastName
resourceStatus
errors
metadata
linkSelf
-
callbackUrl
-
Unsuccessful result
id
type
initiationTime
status
eventType
resource
errors
metadata
linkSelf
callbackUrl
-
-
Polling Result
id
type
status
fromTime
toTime
scope
scopeReference
transactions
linkSelf
callbackUrl
- Transaction SMS Notification Result
id
type
status
message
webhookEventReference
linkSelf
callbackUrl
Status Payloads
-
Webhook Subscription Status
id
type
eventType
webhookUri
status
scope
scopeReference
-
Merchant Bank Account Status
id
type
accountNumber
accountName
bankBranchRef
settlementMethod
status
accountReference
-
Merchant Mobile Wallet Status
id
type
firstName
lastName
phoneNumber
network
status
accountReference
-
Settlement Transfer Status
- This payload is similar to
SettlementTransferResult
payload
- This payload is similar to
-
Payment Status
- This payload is similar to
PaymentResult
payload
- This payload is similar to
-
Pay Recipient Status
id
type
recipientType
status
-
recipientReference
-
If
recipientType == "Bank Account"
accountNumber
accountName
bankBranchRef
-
settlementMethod
-
If
recipientType == "Mobile Wallet"
firstName
lastName
phoneNumber
network
-
email
-
If
recipientType == "Till"
tillNumber
-
tillName
-
If
recipientType == "Paybill"
paybillName
paybillNumber
paybillAccountNumber
-
Stk Push Status
- Successful request
- This payload is simialr to the successful result
- Failed request
- This payload is similar to failed result
- Pending request
id
type
initiationTime
status
eventType
resource
errors
metadata
linkSelf
callbackUrl
-
Polling Status
- This payload is the same as the
Polling
result payload
- This payload is the same as the
- Transaction SMS Notification Status
- This payload is the same as the
Transaction SMS Notification
result payload
- This payload is the same as the
Error responses
errorCode
-
errorMessage
- Token Error Responses
error
errorDescription
For more information on the expected payloads and error codes, please read the api docs
Author
Contributions
We welcome those with open arms just make a pull request and we will review.
Development
Run all tests:
Issues
If you find a bug, please file an issue on our issue tracker on GitHub.
License
k2-connect-php is MIT licensed. See LICENSE for details.