Code Monkey home page Code Monkey logo

kkiapay-php-sdk's Introduction

KKIAPAY PHP-SDK

Raw Files

    git clone https://github.com/kkiapay/php-sdk.git

Installing

Using composer:

    composer require kkiapay/kkiapay-php

Initialization

Production

    $kkiapay = new \Kkiapay\Kkiapay($public_key, $private_key, $secret);

Sandbox

    $kkiapay = new \Kkiapay\Kkiapay($public_key, $private_key, $secret, $sandbox = true);

Request to retrieve transactions

EXAMPLE

    $kkiapay->verifyTransaction($transaction_id);

Request to revert transaction

EXAMPLE

    $kkiapay->refundTransaction($transaction_id);

Request to schedule payout

EXAMPLE

    
    // Example to schedule payout when amount reaches a ceiling
    $kkiapay->setupPayout(array( "algorithm" => "roof", "send_notification" => true, 
        "destination_type" => "MOBILE_MONEY", "roof_amount" => "1000", 
        "destination" => "22997000000" ));
        
        // Example to schedule payout by frequency
    $kkiapay->setupPayout(array( "algorithm" => "rate", "send_notification" => true, 
        "destination_type" => "MOBILE_MONEY", "rate_frequency" => "1m", 
        "destination" => "22997000000" ));
PARAMETERS DESCRIPTION
algorithm (String) "roof" if the amount reaches a ceiling or "rate" for refund by frequency.
send_nofitication (Boolean) to receive a notification after payment.
destination_type (String) "BANK_ACCOUNT" or "MOBILE_MONEY"
destination (String) the bank number or phone number of the receiver of the refund
rate_frequency (String) "1m", "1w", "3j" Refund frequency when choosing "rate" algorithm
roof_amount (String) Refund amount when choosing "roof" algorithm

COMPLETE POSSIBLE STATUS LIST

STATUS DESCRIPTION
SUCCESS Successful transaction
FAILED Transaction failed
INSUFFICIENT_FUND Not enough money in developper account
TRANSACTION_NOT_ELIGIBLE This transaction are already reverted or are not eligible
TRANSACTION_NOT_FOUND Transaction not found
INVALID_TRANSACTION You are not owner of this transaction
INVALID_TRANSACTION_TYPE We can't revert this transaction
INVALID_PAYOUT_DESTINATION_ACCOUNT Provided destination account is not valid mobile money account

kkiapay-php-sdk's People

Contributors

asaje379 avatar barbeblance avatar barbeblanche96 avatar boussarilatif avatar iamdanajr avatar issotina avatar jennifer-am avatar kurtzl avatar nagamodle avatar thoughtaboutcode avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.