KKiaPay

https://docs.kkiapay.me/
Admin
KKiaPay is a digital payment aggregation platform that enables developers to integrate electronic...
Tokens:21,901
Snippets:321
Trust Score:7.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install KKiaPay PHP SDK

Source: https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/php-admin-sdk

Use this composer command to install the PHP Admin SDK.

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

--------------------------------

### Install Node.js Admin SDK

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side/node.js-admin-sdk

Install the Node.js Admin SDK using npm.

```bash
$ npm i @kkiapay-org/nodejs-sdk
```

--------------------------------

### Payment Request Example

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

Example of how to initiate a payment request using the KKiapay SDK.

```APIDOC
## Example

```gradle
import android.content.Intent
import android.os.Bundle
import android.widget.Button
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import co.opensi.kkiapay.uikit.Kkiapay
```

```gradle
class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
    }

    override fun onStart() {
        super.onStart() 

        // Configure the listener for payment status
        Kkiapay.get().setListener { status, transactionId ->
            // This code will execute at the end of the payment
            Toast.makeText(
                this@MainActivity,
                "Transaction: ${status.name} -> $transactionId",
                Toast.LENGTH_LONG
            ).show()
        }
    }

    override fun onResume() {
        super.onResume()
        val testButtonWithKkiapay = findViewById<Button>(R.id.test_button_with_kkiapay)
        testButtonWithKkiapay.setOnClickListener {
            // Start the payment process
            // This will display the payment widget to the user
            Kkiapay.get().requestPayment(
                this,
                1,
                reason = "Paiement d'un service",
                api_key = "<kkiapay-api-key>",
                sandbox = false,
                name = "Johna DOE",
                partnerId = "AxXxxXXid",
                phone = "22961877882",
                email = "email@mail.com",
                paymentMethods = listOf("momo", "card", "direct_debit"),
            )
        }
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        Kkiapay.get().handleActivityResult(requestCode, resultCode, data)
    }

}
```
```

--------------------------------

### Installation

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

Instructions for adding the KKiapay Android SDK to your project.

```APIDOC
## Installation

1. Add the following line to your root `settings.gradle` file within the `dependencyResolutionManagement` `repositories` section:

```gradle
maven { url 'https://jitpack.io' }
```

2. Add this to your application's `build.gradle` file within the `dependencies` section:

```gradle
implementation 'com.github.kkiapay:android-sdk:<latestVersion>'
```
```

--------------------------------

### Install KKiaPay React Native SDK

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-react-native

Install the necessary packages for the KKiaPay React Native SDK. Ensure react-native-webview is also installed.

```bash
npx expo install react-native-webview
npm install @kkiapay-org/react-native-sdk
```

--------------------------------

### Flutter SDK Installation

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Instructions for adding the KKiaPay Flutter SDK to your project's dependencies.

```APIDOC
## Flutter SDK Installation

To use this package, add the following to your `pubspec.yaml` file:

```dart
dependencies:
  flutter:
    sdk: flutter
  kkiapay_flutter_sdk:
```

For web integration, add the following script to your `index.html` file:

```html
<script src="https://cdn.kkiapay.me/k.js"></script>
```
```

--------------------------------

### Install KKiaPay Package

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript/integration-de-kkiapay-dans-une-application-svelte

Execute this command in your project's terminal to install the latest version of the KKiaPay package.

```shell
npm install kkiapay@latest
```

--------------------------------

### MainActivity Setup for KKiapay Payment

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

This Kotlin code sets up the `MainActivity` to handle KKiapay payments, including setting up the payment listener and initiating a payment request when a button is clicked. It also includes the necessary imports for the SDK and Android components.

```kotlin
import android.content.Intent
import android.os.Bundle
import android.widget.Button
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import co.opensi.kkiapay.uikit.Kkiapay

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
    }

    override fun onStart() {
        super.onStart() // Configure le listener pour le statut de paiement
        Kkiapay.get().setListener { status, transactionId ->
            // Ce code s'exécutera à la fin du paiement
            Toast.makeText(
                this@MainActivity,
                "Transaction: ${status.name} -> $transactionId",
                Toast.LENGTH_LONG
            ).show()
        }
    }

    override fun onResume() {
        super.onResume()
        val testButtonWithKkiapay = findViewById<Button>(R.id.test_button_with_kkiapay)
        testButtonWithKkiapay.setOnClickListener {
            // commence le processus de paiement
            // Ceci affichera le widget de paiement à l'utilisateur
            Kkiapay.get().requestPayment(
                this,
                1,
                reason = "Paiement d'un service",
                api_key = "<kkiapay-api-key>",
                sandbox = false,
                name = "Johna DOE",
                partnerId = "AxXxxXXid",
                phone = "22961877882",
                email = "email@mail.com",
                paymentMethods = listOf("momo", "card", "direct_debit"),
            )
        }
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        Kkiapay.get().handleActivityResult(requestCode, resultCode, data)
    }

}
```

--------------------------------

### Install KKiaPay Python SDK

Source: https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/python-admin-sdk

Installs the KKiaPay SDK using pip within a virtual environment. Ensure Python 3 is used for creating the virtual environment.

```python
#Initialize a virtual environment with python3 
python3 -m venv venv

#Install the SDK Admin
pip install kkiapay
```

--------------------------------

### Install KKiaPay Python Admin SDK

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side/python-admin-sdk

Installs the KKiaPay Admin SDK using pip within a Python virtual environment.

```python
#Initialisation d'un environnement virtuel avec python3 
python3 -m venv venv

#Installation du SDK Admin
pip install kkiapay
```

--------------------------------

### Install Flutter Dependency

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Add the kkiapay_flutter_sdk package to your pubspec.yaml file.

```yaml
dependencies:
  flutter:
    sdk: flutter
  kkiapay_flutter_sdk:
```

--------------------------------

### Verify Webhook Request

Source: https://docs.kkiapay.me/v1/tableau-de-bord/webhook

Example of the request structure including the x-kkiapay-secret header used for signature verification.

```bash
curl -H "x-kkiapay-secret: XXX" -H "Content-Type: application/json http://example.com/webhook
```

--------------------------------

### GET /verify

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side/node.js-admin-sdk

Retrieves detailed information about a specific transaction using its unique reference ID.

```APIDOC
## GET /verify

### Description
Retrieves the status and details of a transaction using the transaction reference ID.

### Method
GET

### Parameters
#### Path Parameters
- **transactionId** (string) - Required - The unique reference ID of the transaction.

### Response
#### Success Response (200)
- **performed_at** (string) - Timestamp of the transaction
- **type** (string) - Transaction type (e.g., DEBIT)
- **status** (string) - Transaction status (e.g., SUCCESS)
- **amount** (number) - Transaction amount
- **client** (object) - Client details including fullname, phone, and email
```

--------------------------------

### SDK Initialization and Usage

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Demonstrates how to initialize the KKiaPay SDK and initiate a payment on mobile and web.

```APIDOC
## SDK Initialization and Usage

Import the SDK:

```dart
import 'package:kkiapay_flutter_sdk/kkiapay_flutter_sdk.dart';
```

### Initializing the Kkiapay Instance

```dart
final kkiapay = KKiaPay(
    @required callback: Function(Map<String, dynamic> response, BuildContext context),
    @required amount: int, // Ex : 1000
    @required apikey: String, // Ex : XXXX_public_api_key_XXX
    @required sandbox: bool, // Ex : true
    data: String, // Ex : 'Big data'
    phone: String, // Ex : "22961000000"
    name: String, // Ex : "John Doe"
    reason: String, // Ex : "transaction reason"
    email: String, // Ex : "email@mail.com"
    callbackUrl: String, // Ex : "http://kkiapay.me"
    theme: String, // Ex : "#222F5A"
    countries: List<String>, // Ex :  ["CI","BJ"]
    partnerId: String, // Ex : 'AxXxXXxId'
    paymentMethods: List<String> // Ex : ["momo","card"]
);
```

### Initiating Payment

**Mobile:**

```dart
Navigator.push( context, MaterialPageRoute(builder: (context) => kkiapay), );
```

**Web:**

```dart
KkiapayFlutterSdkPlatform.instance.pay( kkiapay, context, callback );
```
```

--------------------------------

### Initialization

Source: https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/php-admin-sdk

Initialize the KKiPay Admin SDK with your API keys. You can switch between sandbox and production modes by setting the `$sandbox` parameter.

```APIDOC
## Initialization

The KKiPay Admin SDK requires the creation of a `Kkiapay` object using your API keys. The `$sandbox` parameter controls whether you are in test mode (`true`) or production mode (`false`, default).

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

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

**Parameters:**
- **$public_key** (string) - Your public API key.
- **$private_key** (string) - Your private API key.
- **$secret** (string) - Your secret API key.
- **$sandbox** (bool) - Optional. Set to `true` for sandbox mode, `false` for production. Defaults to `false`.
```

--------------------------------

### KKiaPay SDK Initialization and Usage

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-swift-pour-ios

This section covers the essential steps for initializing and using the KKiaPay SDK in your Swift application, including creating an instance with payment details and handling payment callbacks.

```APIDOC
## KKiaPay SDK Integration

### Description
This guide details the integration of the KKiaPay Swift SDK into an iOS application. It covers installation, importing the SDK, creating a view model, initializing the KKiaPay instance with various parameters, and handling payment status updates.

### Installation
Add the KKiaPay Swift SDK to your project using the Swift Package Manager.

Refer to the official Swift Package Manager documentation for installation guidance: [Installation d'un package](https://github.com/apple/swift-package-manager/tree/main/Documentation).

### Importing the SDK
Import the KKiaPay SDK into your Swift file:

```swift
import KKiaPaySDK;
```

### Creating a ViewModel
Create an `ObservedObject` to manage the KKiaPay view model:

```swift
@ObservedObject var viewModel = KKiaPayViewModel()
```

### Initializing KKiaPay Instance
Instantiate `KKiaPay` with the required parameters. Ensure `sandbox` is set to `false` for production environments.

#### Parameters

- **amount** (Numeric) - Required - The amount to be paid in FCFA.
- **phone** (String) - Required - A valid mobile money number.
- **data** (String) - Required - Data or information related to the transaction, interpretable by your system.
- **publicAPIKey** (String) - Required - Your KKiaPay public API key.
- **sandbox** (Boolean) - Required - Set to `true` for testing, `false` for production.
- **theme** (String) - Optional - The theme color for the payment interface (e.g., "#4E6BFC").
- **name** (String) - Optional - The full name of the payment initiator.
- **email** (String) - Optional - The email address of the payment initiator.
- **callback** (String) - Required - The URL to redirect to after a successful payment.
- **viewModel** (KKiaPayViewModel) - Required - The view model instance.

#### Request Example

```swift
private var kkiaPay: KKiaPay{
    KKiaPay(amount: "3000",
            phone: "22997000000",
            data: "Hello world",
            publicAPIKey: "xxxxxxxxxxxxxxxxxxx",
            sandbox: true,
            theme: "#4E6BFC",
            name: "John Doe",
            email:"user@email.com",
            callback: "https://redirect.kkiapay.com",
            viewModel:viewModel
    )
}
```

### Handling Payment Callbacks
Use the `onReceive` function to be notified of the payment status. The callback receives `paymentData` which includes `isSuccessful` and transaction details.

#### Success Response Example

```swift
kkiaPay.onReceive(self.viewModel.paymentData.receive(on: RunLoop.main)) { paymentData in
    if(paymentData.isSuccessful){
        print("The amount of the transaction is " + paymentData.amount + " with id " + paymentData.transactionId)
        showWebView = false
    } else {
        print("The payment was not successful")
    }
}
```

### Security Warning

**Important!** To prevent fraud, verify transactions on your server-side. Refer to the [Server-Side SDKs](https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side) documentation for more information.
```

--------------------------------

### Initialize KKiapay SDK

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

Initialize the KKiapay SDK in your Application class's `onCreate` method. Ensure you replace `<kkiapay-api-key>` with your actual API key and configure `enableSandbox` appropriately.

```kotlin
import co.opensi.kkiapay.uikit.Kkiapay
import co.opensi.kkiapay.uikit.SdkConfig

Kkiapay.init(applicationContext,
    "<kkiapay-api-key>",
    SdkConfig(themeColor = R.color.colorPrimary,
        /* définissez enableSandbox à false si vous utilisez les clés d'API live */
        enableSandbox = true )
)
```

--------------------------------

### Initialize Kkiapay SDK in Production Mode

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side/node.js-admin-sdk

Instantiate the kkiapay object with your API keys for production use. The sandbox option defaults to false.

```javascript
const k = kkiapay({privatekey:"xxxxxxx",
                   publickey:"xxxxxxx",
                   secretkey:"xxxxxxx"})
```

--------------------------------

### Initialize KKiaPay Provider

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-react-native

Wrap your application with KkiapayProvider to make the SDK context available. This should be done at the root of your application.

```javascript
// Dans le fichier App
import { KkiapayProvider } from '@kkiapay-org/react-native-sdk';

import TestComponent from './TestComponent';

export default function App() {
  return (
    <KkiapayProvider>
      <TestComponent />
    </KkiapayProvider>
  );
}
```

--------------------------------

### Ajouter une instance de KKiaPay

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-swift-pour-ios

Configuration de l'instance KKiaPay avec les paramètres de transaction requis. Définissez sandbox sur false pour la production.

```swift
 private var kkiaPay: KKiaPay{
    KKiaPay(amount: "3000",
            phone: "22997000000",
            data: "Hello world",
            publicAPIKey: "xxxxxxxxxxxxxxxxxxx",
            sandbox: true,//set this to false in production
            theme: "#4E6BFC",
            name: "John Doe",
            email:"user@email.com",
            callback: "https://redirect.kkiapay.com",
            viewModel:viewModel
    )
}
```

--------------------------------

### Initialize KKiaPay Instance

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Configure the KKiaPay object with required credentials and transaction details.

```dart
final kkiapay = KKiaPay(
    @required callback: Function(Map<String, dynamic> response, BuildContext context),
    @required amount: int, // Ex : 1000
    @required apikey: String, // Ex : XXXX_public_api_key_XXX
    @required sandbox: bool, // Ex : true
    data: String, // Ex : 'Big data'
    phone: String, // Ex : "22961000000"
    name: String, // Ex : "John Doe"
    reason: String, // Ex : "transaction reason"
    email: String, // Ex : "email@mail.com"
    callbackUrl: String, // Ex : "http://kkiapay.me"
    theme: String, // Ex : "#222F5A"
    countries: List<String>, // Ex :  ["CI","BJ"],
    partnerId: String, // Ex : 'AxXxXXxId'
    paymentMethods: List<String> // Ex : ["momo","card"]
);
```

--------------------------------

### Initialize Kkiapay SDK in Sandbox Mode

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side/node.js-admin-sdk

Instantiate the kkiapay object with your API keys and set sandbox to true for testing.

```javascript
const k = kkiapay({privatekey:"xxxxxxx",
                   publickey:"xxxxxxx",
                   secretkey:"xxxxxxx",
                   sandbox:true})
```

--------------------------------

### Initialize KKiaPay SDK in Live Mode

Source: https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/php-admin-sdk

Initialize the KKiaPay object for live (production) mode using your API keys. Omit the fourth parameter or set it to false.

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

--------------------------------

### API Initialization

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

How to initialize the KKiapay SDK in your Android application.

```APIDOC
## Initialize the API

In the `onCreate` method of your Application class:

```javascript
import co.opensi.kkiapay.uikit.Kkiapay
import co.opensi.kkiapay.uikit.SdkConfig

Kkiapay.init(applicationContext,
    "<kkiapay-api-key>",
    SdkConfig(themeColor = R.color.colorPrimary, 
        /* set enableSandbox to false if you are using live API keys */
        enableSandbox = true )
)
```
```

--------------------------------

### Initialize KKiaPay SDK in Sandbox Mode

Source: https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/php-admin-sdk

Initialize the KKiaPay object for sandbox (test) mode using your API keys. Set the fourth parameter to true for sandbox.

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

--------------------------------

### Créer un modèle KKiaPayViewModel

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-swift-pour-ios

Initialisation du modèle d'observation pour gérer l'état du paiement.

```swift
@ObservedObject var viewModel = KKiaPayViewModel()
```

--------------------------------

### Import SDK

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Import the KKiaPay library into your Dart files.

```dart
import 'package:kkiapay_flutter_sdk/kkiapay_flutter_sdk.dart';
```

--------------------------------

### SwiftUI Payment Integration with KKiaPay

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-swift-pour-ios

This snippet shows how to initialize and present the KKiaPay payment interface within a SwiftUI view. It includes setting up payment details, handling the payment callback, and processing the transaction result. Ensure the `sandbox` property is set to `false` for production environments.

```swift
import SwiftUI
import KKiaPaySDK

struct ContentView: View {
        //Create a view model instance to use later
        @ObservedObject var viewModel = KKiaPayViewModel()
        @State private var showWebView = false
        
        //Initialise the Kkiapay Instance
        private var kkiaPay: KKiaPay{
            KKiaPay(amount: "3000",
                    phone: "97000000",
                    data: "Hello world",
                    publicAPIKey: "xxxxxxxxxxxxxxxxxxx",
                    sandbox: true,//set this to false in production
                    theme: "#4E6BFC",
                    name: "John Doe",
                    email:"user@email.com",
                    callback: "https://redirect.kkiapay.com",
                    viewModel:viewModel
            )
        }
        
        var body: some View {
            Button {
                showWebView.toggle()
            } label: {
                Text("Pay")
            }
            .sheet(isPresented: $showWebView) {
                
                //Get the transaction data back 
                kkiaPay.onReceive(self.viewModel.paymentData.receive(on: RunLoop.main)){
                    paymentData in
                    
                    if(paymentData.isSuccessful){
                        print("The amount of the transaction is " + paymentData.amount+" with id "+paymentData.transactionId)
                        showWebView = false
                    }else{
                        print("The payment was not successful")
                    }
                }
            }
        }
}

struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ContentView()
    }
}
```

--------------------------------

### KKiaPay Widget Configuration

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Details the parameters required to configure and initialize the KKiaPay payment widget.

```APIDOC
## KKiaPay Widget Configuration

### Description
Parameters used to initialize the KKiaPay payment widget for processing transactions.

### Parameters
#### Request Body
- **phone** (String) - Required - Numéro de téléphone du client à débiter. Ex: 22967434270
- **amount** (Numeric) - Required - Le montant à débiter au client (XOF)
- **name** (String) - Optional - Nom et prénoms du client
- **partnerId** (String) - Optional - Votre id pour retrouver la transaction
- **countries** (Array of String) - Optional - Les pays supportés par le widget. Ex: ["CI"]
- **paymentMethods** (Array of String) - Optional - Les méthodes de paiement à autoriser sur le widget. Ex: ["momo","card"]
- **theme** (String) - Optional - La couleur que vous souhaitez pour le widget KKiaPay
- **apikey** (String) - Required - Votre clé d'API publique
- **sandbox** (Boolean) - Optional - La valeur true de cet attribut vous permet de passer en mode test
- **successCallback** (Function) - Required - Cette fonction est appelée une fois que le paiement est succès
```

--------------------------------

### Verify Transaction Status with KKiaPay SDK

Source: https://docs.kkiapay.me/v1/en-1.0.0/plugin-et-sdk/admin-sdks-server-side/python-admin-sdk

Initializes the KKiaPay SDK with API keys and verifies a transaction using its reference. The transaction status and details can then be accessed.

```python
#Create an instance of KKiaPay
from kkiapay import Kkiapay
k = Kkiapay('public_key', 'private_key', 'secret', sandbox=True)

#Initialize the process of verification
transaction = k.verify_transaction('LVFNrK1nx')
#Where LVFNrK1nx is the reference of the transaction

print(transaction)

# => KkiapayTransaction(
#       performed_at='2019-07-11T11:24:42.687Z',
#       type='DEBIT',
#       status='FAILED',
#       source='MOBILE_MONEY',
#       amount=1,
#       fees=0,
#       country='BJ',
#       reason='invalid_number',
#       transactionId='LVFNrK1nx',
#       performedAt='07/11/2019'
#   )

print(transaction.status)
# => FAILED
print(transaction.amount)
# => 1
```

--------------------------------

### Add Jitpack Repository to settings.gradle

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

Add the Jitpack repository to your root `settings.gradle` file to resolve the SDK dependency.

```gradle
maven { url 'https://jitpack.io' }
```

--------------------------------

### Importer le package KKiaPay

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-swift-pour-ios

Importation du module SDK dans votre fichier Swift.

```swift
 import KKiaPaySDK;
```

--------------------------------

### KKiaPay Widget Configuration

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript

Configuration attributes for initializing the KKiaPay payment widget.

```APIDOC
## KKiaPay Widget Configuration

### Description
Attributes used to configure the behavior and appearance of the KKiaPay payment widget.

### Parameters
- **key** (String) - Required - Your public API key
- **amount** (Number) - Required - The amount to charge the client
- **data** (Object) - Optional - Information related to your transaction
- **partnerId** (String) - Optional - Your unique identifier linked to the transaction
- **phone** (String) - Optional - Client phone number (for mobile money)
- **paymentmethod** (array) - Optional - Allowed payment methods: momo, card, wallet
- **countries** (array) - Optional - Allowed countries: BJ, CI, TG, SN, NE
- **name** (String) - Optional - Client full name
- **email** (String) - Optional - Client email
- **theme** (String) - Optional - Widget color theme
- **callback** (String) - Optional - Redirect URL after payment completion
- **position** (String) - Optional - Widget position: left, right, center
- **sandbox** (Boolean) - Optional - Set to true for test mode
```

--------------------------------

### Request Payment with KKiapay

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

Initiate a payment request using the `requestPayment` method. This will display the KKiapay payment widget to the user. Ensure all required parameters like `api_key` and `amount` are provided.

```kotlin
Kkiapay.get().requestPayment(
    this,
    1,
    reason = "Paiement d'un service",
    api_key = "<kkiapay-api-key>",
    sandbox = false,
    name = "Johna DOE",
    partnerId = "AxXxxXXid",
    phone = "22961877882",
    email = "email@mail.com",
    paymentMethods = listOf("momo", "card", "direct_debit"),
)
```

--------------------------------

### Import Node.js Admin SDK

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/admin-sdks-server-side/node.js-admin-sdk

Import the kkiapay object for use in your JavaScript or TypeScript project.

```javascript
const { kkiapay } = require("@kkiapay-org/nodejs-sdk"); // javascript
```

```typescript
import { kkiapay } from "@kkiapay-org/nodejs-sdk" // typescript
```

--------------------------------

### Trigger Payment Widget from Button

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript/integration-de-kkiapay-dans-une-application-svelte

Use this HTML template to create a button that, when clicked, invokes the function to open the KKiaPay payment widget.

```html
<main>
  <button on:click={open}> click me </button>
</main>
```

--------------------------------

### Add Web Script

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Include the KKiaPay script in your index.html file for web support.

```html
ajouter ce script dans le fichier index.html
<script src="https://cdn.kkiapay.me/k.js"></script>
```

--------------------------------

### KKiaPay WebComponent Integration

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript

Use this WebComponent in your HTML to create a payment button. Replace placeholder values with your actual amount, API key, and callback URL. The 'sandbox' attribute enables test mode.

```html
<kkiapay-widget amount="<montant-a-prelever-chez-le-client>" 
                key="<votre-api-key>"
                position="center"
                sandbox="true"
                data=""
                callback="<url-de-redirection-quand-le-paiement-est-reussi>">
</kkiapay-widget>
```

--------------------------------

### Include KKiaPay SDK Script

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript

Add this script tag before the closing </body> tag in your HTML to include the KKiaPay Javascript SDK.

```html
<script src="https://cdn.kkiapay.me/k.js"></script>
```

--------------------------------

### Import KKiaPay Functions

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript/integration-de-kkiapay-dans-une-application-svelte

Import the required functions from the KKiaPay library into your Svelte component for payment integration.

```javascript
import {
  openKkiapayWidget,
  addKkiapayListener,
  removeKkiapayListener,
} from "kkiapay";
```

--------------------------------

### Open KKiaPay Widget via Javascript

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript

Call the 'openKkiapayWidget' function in your Javascript code to programmatically open the payment widget. Ensure all required parameters like amount, key, and callback are provided.

```javascript
openKkiapayWidget({"amount":"1","position":"right","callback":"",
                  "data":""
                  "theme":"green",
                  "key":"<votre-api-key>"})
```

--------------------------------

### Add SDK Dependency to build.gradle

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-android

Include the KKiapay SDK as a dependency in your application's `build.gradle` file.

```gradle
implementation 'com.github.kkiapay:android-sdk:<latestVersion>'
```

--------------------------------

### Handle Payment Success Event

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript/integration-de-kkiapay-dans-une-application-svelte

Subscribe to the 'success' event using addKkiapayListener within the onMount hook to be notified when a payment is successfully completed. This ensures the listener is active when the component is mounted.

```javascript
<script>
  import { onMount, onDestroy } from "svelte";
  import {
    openKkiapayWidget,
    removeKkiapayListener,
    addKkiapayListener,
  } from "kkiapay";

  function successHandler() {
    console.log("payment success...");
  }

  onMount(() => {
    addKkiapayListener("success", successHandler);
    console.log("the component has mounted");
  });
</script>
```

--------------------------------

### Trigger Payment Flow

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-flutter

Initiate the payment process using the configured instance for mobile or web.

```dart
Navigator.push( context, MaterialPageRoute(builder: (context) => kkiapay), );
```

```dart
KkiapayFlutterSdkPlatform.instance.pay( kkiapay, context, callback );
```

--------------------------------

### Souscrire aux événements de paiement

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-swift-pour-ios

Utilisation de la fonction onReceive pour écouter le statut de la transaction et gérer les résultats.

```swift
kkiaPay.onReceive(self.viewModel.paymentData.receive(on: RunLoop.main)){paymentData in
    
    if(paymentData.isSuccessful){
        print("The amount of the transaction is " + paymentData.amount+" with id "+paymentData.transactionId)
        showWebView = false
    }else{
        print("The payment was not successful")
    }
}
```

--------------------------------

### Use KKiaPay Hook for Payment

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-react-native

Utilize the useKkiapay hook to access payment functions like openKkiapayWidget, addSuccessListener, and addFailedListener. Set up listeners in a useEffect hook.

```javascript
// Dans le composant -- TestComponent
import { useKkiapay } from '@kkiapay-org/react-native-sdk';
import { useEffect } from 'react';
import { Button, View } from 'react-native';

export default function TestComponent() {
  const { openKkiapayWidget, addSuccessListener, addFailedListener } = useKkiapay();

  useEffect(() => {
    addSuccessListener(data => {
      console.log('data ', data);
    });
    
    addFailedListener(data => {
      console.log('data ', data);
    });
  }, []);

  const openWidget = () => {
    openKkiapayWidget({
      amount: 4000,
      api_key: "xxxxxxxxxxxxxxxxxx",
      sandbox: true,
      email: "randomgail@gmail.com",
      phone: "97000000",
    });
  };

  return (
    <View>
      <Button title="Payer maintenant" onPress={openWidget} />
    </View>
  );
}
```

--------------------------------

### Handle Payment Success Event

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript/integration-de-kkiapay-dans-une-application-angular

Subscribe to the 'success' event using addKkiapayListener to be notified when a payment is successful. This listener is added in ngOnInit.

```javascript
import { Component } from '@angular/core';
import { openKkiapayWidget, addKkiapayListener,removeKkiapayListener  } from 'kkiapay'

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})

export class AppComponent {
  title = 'kkiapay-sample-project';

  open() {
    openKkiapayWidget({
      amount: 1000,
      api_key: "xxxxxxxxxxxxxxx",
      sandbox: true,
      phone: "97000000",
    })
  }  

  successHandler() {
    console.log("payment success...");
  }

  ngOnInit() {
    addKkiapayListener('success',this.successHandler)
  }
}
```

--------------------------------

### Subscribe to Payment Events

Source: https://docs.kkiapay.me/v1/plugin-et-sdk/sdk-javascript

Use these listeners to handle success and failure callbacks during the payment process.

```javascript
   addSuccessListener(response => {
        console.log(response);
    });

   addFailedListener(error => {
        console.log(error);
    });
```
Tokens:
Raw