> For the complete documentation index, see [llms.txt](https://docs.kkiapay.me/v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/php-admin-sdk.md).

# PHP Admin SDK

To use the PHP version of the Admin SDK you must use this *composer* command:

```
composer require kkiapay/kkiapay-php:dev-master
```

## Initialization 

The use of the server Admin SDK requires the creation of a *kkiapay* object. In order to create that object, you will need to retrieve your API keys and to use the following commands whether you are in Sandbox mode or in production.

* In Sandbox

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

{% hint style="info" %}
When the attribute `$sandbox` is set to ***true*** you're in test mode.
{% endhint %}

* In live

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

## Status of a transaction

With the Server Admin SDK, you can retrieve all the information related to a transaction, using the reference of the operation that has been performed. To do this, you will need to fill in the following fields: 

* Your public, private and secret API keys
* The reference of the operation (see the image below)

![](/files/-LhkBg3LnqA8lHNZqn1i)

### Example 

You can use the following code to test this feature:

```php
$kkiapay->verifyTransaction($transaction_id)

//response
Array(
    [performed_at] => 2025-04-10T15:01:49.499Z
    [type] => DEBIT
    [status] => SUCCESS
    [source] => MOBILE_MONEY
    [source_common_name] => mtn-benin
    [amount] => 40
    [fees] => 1
    [reason] => payment
    [failureCode] => 
    [failureMessage] => 
    [state] => null
    [partnerId] => 
    [feeSupportedBy] => customer
    [income] => 40
    [transactionId] => 0845058258857440
    [performedAt] => 10/04/2025
    [client] => Array
        (
            [fullname] => John Doe
            [phone] => 22997000000
            [email] => john.doe@gmail.com
        )
)
```

## **Refund a transaction**

Any ***success*** transaction made by mobile money can be subject to a refund operation. You have the possibility to make a refund if your customer hasn't obtained satisfaction for the service for which he paid or if you consider it necessary. In order to carry out such an operation, you will need to provide the following information:

* Your public, private and secret API keys
* The reference of the operation (see the image below)

![](/files/-LhkBg3LnqA8lHNZqn1i)

{% hint style="info" %}
The refund of a transaction doesn't include the refund of the fees related to.
{% endhint %}

### Example 

You can use the following code to test this feature:

```php
$kkiapay->refundTransaction($transaction_id);
```