Kkiapay

https://docs.kkiapay.me/v1/
Admin
Kkiapay is a payment aggregation platform that enables businesses to accept payments globally via...
Tokens:17,352
Snippets:249
Trust Score:7.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Kkiapay Python SDK

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

Commands to initialize a virtual environment and install the Kkiapay package.

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

#Installation du SDK Admin
pip install kkiapay
```

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

### Install Node.js Admin SDK

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

Use npm to install the Kkiapay Node.js SDK package.

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

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

### Install KKiaPay SDK dependencies

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

Install the required webview and SDK packages using npm or expo.

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

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

### Installation and Importation

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

Instructions for installing the Node.js Admin SDK using npm and how to import it in your JavaScript or TypeScript project.

```APIDOC
## Installation

Install the Node.js Admin SDK using npm:

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

## Importation

Import the SDK in your project:

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

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

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

### SDK Initialization

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

Guides on how to initialize the KKiapay Admin SDK for both Sandbox and Production environments using your API keys.

```APIDOC
## Initialization

Initialize the KKiapay Admin SDK by instantiating the `kkiapay` object with your API keys.

### Sandbox Mode

To use the SDK in Sandbox mode, set the `sandbox` attribute to `true`.

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

### Production Mode

For production use, initialize the SDK without the `sandbox` attribute or set it to `false`.

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

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

### Installation du package KKiaPay

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

Commande pour installer la dernière version du SDK KKiaPay via npm.

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

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

### Install PHP Admin SDK using Composer

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

Use this composer command to install the latest development version of the Kkiapay PHP Admin SDK.

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

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

### Verify Transaction Status

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

Example of initializing the Kkiapay instance and retrieving transaction details using a transaction reference.

```python
#Procéder à la création d'une instance de KKiaPay
from kkiapay import Kkiapay
k = Kkiapay('public_key', 'private_key', 'secret', sandbox=True)

#Initialiser le processus de vérification de la transaction
transaction = k.verify_transaction('LVFNrK1nx')
#Où LVFNrK1nx est la référence de la 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
```

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

### Webhook Request Header Example

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

The structure of the HTTP request sent to your webhook URL, including the x-kkiapay-secret header for verification.

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

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

### Initialize Kkiapay SDK in Production Mode

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

Instantiate the Kkiapay SDK with your API keys for live transactions. Sandbox mode is false by default.

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

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

### Initialize Kkiapay SDK in Sandbox Mode

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

Instantiate the Kkiapay SDK with your API keys and set the sandbox mode to true for testing purposes.

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

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

### Initialize KkiapayProvider

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

Wrap the application root with KkiapayProvider to enable context access for child components.

```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>
  );
}
```

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

### KKiaPay SDK Initialization

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

This snippet shows how to initialize the KKiaPay SDK with necessary parameters.

```APIDOC
## Initialize KKiaPay SDK

### Description
Initializes the KKiaPay SDK with transaction details and API credentials.

### Method
Initialization (Constructor)

### Endpoint
N/A (SDK Initialization)

### Parameters
#### Request Body (Implicit via Constructor)
- **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 - The public API key for your KKiaPay account.
- **sandbox** (Boolean) - Required - Set to `true` for testing environment, `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** (Function) - Optional - The callback function to be invoked upon successful payment.
- **viewModel** (Object) - Required - An instance of `KKiaPayViewModel` for handling observation.

### Request Example
```swift
@ObservedObject var viewModel = KKiaPayViewModel()

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
    )
}
```

### Response
#### Success Response (Initialization)
N/A (SDK initialization does not return a direct response in this context).

#### Response Example
N/A
```

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

### KKiaPay SDK Initialization

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

Details on how to initialize the KKiaPay instance with required payment parameters.

```APIDOC
## KKiaPay Initialization

### Description
Initializes the KKiaPay payment instance with the necessary configuration and user details.

### Parameters
- **callback** (Function) - Required - Callback function handling the response and context.
- **amount** (int) - Required - The transaction amount.
- **apikey** (String) - Required - The public API key.
- **sandbox** (bool) - Required - Toggle for sandbox mode.
- **data** (String) - Optional - Additional data.
- **phone** (String) - Optional - Customer phone number.
- **name** (String) - Optional - Customer name.
- **reason** (String) - Optional - Transaction reason.
- **email** (String) - Optional - Customer email.
- **callbackUrl** (String) - Optional - Redirect URL after payment.
- **theme** (String) - Optional - UI theme color hex code.
- **countries** (List<String>) - Optional - List of allowed country codes.
- **partnerId** (String) - Optional - Partner identification.
- **paymentMethods** (List<String>) - Optional - List of allowed payment methods (e.g., "momo", "card").
```

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

### Initialize KKiaPay Payment Instance

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

Instantiate the KKiaPay class with required parameters like callback, amount, API key, and sandbox mode. Optional parameters for customization include data, phone, name, reason, email, callbackUrl, theme, countries, partnerId, and paymentMethods.

```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

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. Set the sandbox attribute to true for testing environments.

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

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

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

### 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, incluant la clé publique et le mode sandbox.

```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 SDK in Application Class

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

Initialize the KKiapay SDK in the `onCreate` method of your Application class. 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 )
)
```

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

### Implement CSS Class Method

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

Configure the script tag with payment details and apply the kkiapay-button class to an existing HTML button.

```markup
<script amount="<montant-a-prelever-chez-le-client>" 
        callback=""
        data=""
        position="right" 
        theme="#0095ff"
        sandbox="true"
        key="<votre-api-key>"
        src="https://cdn.kkiapay.me/k.js"></script>
```

```markup
<button class="kkiapay-button"></button>
```

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

### Initiate Payment on Web

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

Use the KkiapayFlutterSdkPlatform.instance.pay method to initiate payments on web platforms.

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

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

### Import the KKiaPay SDK

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

Include the SDK script before the closing body tag in your HTML.

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

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

### Initialize KKiaPay in SwiftUI

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

Use this implementation to configure the KKiaPay instance and handle payment success or failure via the view model.

```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-javascript

Configuration parameters 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 be charged
- **data** (Object) - Optional - Transaction-related information
- **partnerId** (String) - Optional - 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 address
- **theme** (String) - Optional - Widget color theme
- **callback** (String) - Optional - Redirect URL after payment
- **position** (String) - Optional - Widget position: left, right, center
- **sandbox** (Boolean) - Optional - Set to true for test mode
```

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

### Import Kkiapay SDK

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

Import the SDK using either CommonJS or ES module syntax.

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

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

### Importer le package KKiaPay

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

Importation du module SDK nécessaire pour accéder aux fonctionnalités de paiement.

```swift
 import KKiaPaySDK;
```

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

### Implement payment widget with useKkiapay

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

Use the useKkiapay hook to register success/failure listeners and trigger the payment widget with transaction details.

```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>
  );
}
```

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

### Implement WebComponent Widget

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

Add the kkiapay-widget tag to your HTML to render the payment button. Ensure attributes like amount, key, and callback are configured correctly.

```markup
<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>
```

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

### Add Jitpack Repository to settings.gradle

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

Include the Jitpack repository in your root `settings.gradle` file to resolve SDK dependencies.

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

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

### Request Payment with KKiapay SDK

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

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

```kotlin
// 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"),
)
```

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

### Créer un modèle de vue

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

Initialisation de l'objet observable requis pour gérer l'état du paiement.

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

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

### Kkiapay.requestPayment

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

Initiates the payment process by displaying the Kkiapay payment widget to the user.

```APIDOC
## Kkiapay.requestPayment

### Description
Initiates the payment process and displays the Kkiapay payment widget to the user.

### Parameters
#### Request Body
- **api_key** (String) - Required - Your public API key.
- **amount** (Number) - Required - The amount to be debited from the client.
- **phone** (String) - Required - The client's phone number to be debited (e.g., 22967434270).
- **name** (String) - Optional - The client's full name.
- **email** (String) - Optional - The client's email address.
- **partnerId** (String) - Optional - Your custom ID to track the transaction.
- **paymentMethods** (Array of string) - Optional - Allowed payment methods (e.g., ["momo", "card"]).
- **sandbox** (Boolean) - Optional - Set to true to enable test mode.
- **reason** (String) - Optional - The reason for the transaction.
```

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

### Import necessary Android SDK classes

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

Import the required classes for using the KKiapay SDK within your Android Activity.

```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
```

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

### Import KKiaPay Flutter SDK

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

Import the necessary library to use the KKiaPay SDK in your Dart code.

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

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

### Handling Payment Events

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

This snippet demonstrates how to subscribe to payment events, specifically for successful transactions.

```APIDOC
## Handle Payment Events

### Description
Subscribes to payment events to receive notifications about the transaction status, particularly for successful payments.

### Method
`onReceive`

### Endpoint
N/A (SDK Event Handling)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request 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")
    }
}
```

### Response
#### Success Response (Event Notification)
- **paymentData** (Object) - Contains details about the payment transaction.
  - **isSuccessful** (Boolean) - Indicates if the payment was successful.
  - **amount** (String) - The transaction amount.
  - **transactionId** (String) - The unique identifier for the transaction.

#### Response Example
```json
{
  "isSuccessful": true,
  "amount": "3000",
  "transactionId": "txn_1234567890"
}
```
```

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

### Set Payment Status Listener

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

Configure a listener to handle the payment status and transaction ID after a payment attempt. This code should be placed in `onStart`.

```kotlin
// 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()
}
```

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

### Importation des fonctions KKiaPay

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

Importation des fonctions nécessaires pour interagir avec le widget de paiement.

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

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

### Ouverture du widget de paiement

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

Configuration de la fonction pour déclencher l'ouverture du widget de paiement KKiaPay.

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

  function open() {
    openKkiapayWidget({
      amount: 1000,
      api_key: "xxxxxxxxxxxxxxxx",
      sandbox: true,
      phone: "97000000",
    });
  }
</script>
```

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

### Initiate Payment on Mobile

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

Navigate to the KKiaPay payment screen using Navigator.push for mobile applications.

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

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

### 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 traiter 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")
    }
}
```

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

### Open KKiaPay Payment Widget

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

Define a function to open the KKiaPay payment widget with transaction details. Ensure your API key and other parameters are correctly set.

```typescript
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",
    })
  }  
}
```

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

### Add SDK Dependency to build.gradle

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

Add the KKiapay SDK dependency to your application's `build.gradle` file.

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

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

### Souscription aux événements de paiement

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

Enregistrement d'un listener pour gérer le succès d'une transaction lors du montage du composant.

```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>
```

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

### Listen for Payment Success Events

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

Use this function to handle successful payment transactions. It logs the response object to the console.

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

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

### Add KKiaPay Flutter SDK Dependency

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

Add the kkiapay_flutter_sdk to your Flutter project's pubspec.yaml file under dependencies.

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

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

### 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.

```typescript
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)
  }
}
```

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

### Invoke Payment via Javascript

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

Call the openKkiapayWidget function directly from your Javascript code to trigger the payment window.

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

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

### Handle Activity Result for Payment

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

Forward the activity result to the KKiapay SDK to handle the outcome of the payment process. This should be implemented in your `onActivityResult` method.

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

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

### Trigger Payment from Template

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

Use the defined 'open' function in your Angular template to trigger the payment process when a button is clicked.

```html
<div>
    <button (click)="open()">
        Payer Maintenant
    </button>
</div>
```

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

### Payment Event Listeners

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

Functions to subscribe to payment success and failure events.

```APIDOC
## Payment Event Listeners

### Description
Use these functions to handle the outcome of the payment transaction.

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

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

### Response
- **response** (Object) - Contains the transaction identifier upon success.
```

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

### Déclenchement du paiement dans le template

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

Utilisation de la fonction d'ouverture dans un bouton Svelte.

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

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

### Listen for Payment Failure Events

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

Use this function to handle failed payment transactions. It logs the error object to the console.

```javascript
addFailedListener(error => {
        console.log(error);
    });
```

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

### Refund Transaction

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

Allows you to initiate a refund for a completed mobile money transaction.

```APIDOC
## Refund Transaction

Initiate a refund for a successful mobile money transaction. Note that transaction fees are not included in the refund.

### Method

```
POST
```

### Endpoint

```
/transaction/refund
```

### Parameters

#### Path Parameters

- **transactionId** (string) - Required - The unique identifier of the transaction to be refunded.

#### Request Body

This endpoint does not require a request body. The `transactionId` is passed directly to the `refund` method.

### Request Example

```javascript
k.refund("transactionId").
  then((response) => {
    // Handle successful response
    console.log(response);
  }).
  catch((error) => {
    // Handle error
    console.error(error);
  });
```

### Response

#### Success Response (200)

- The response structure for a successful refund is not explicitly defined in the provided text. Typically, it would include confirmation of the refund operation.

#### Response Example

```json
{
  "message": "Refund initiated successfully",
  "refundId": "refund_xyz123"
}
```
```

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

### Nettoyage des listeners

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

Suppression du callback lors de la destruction du composant pour éviter les fuites de mémoire.

```javascript
<script>
  //... others options
  onDestroy(() => {
    removeKkiapayListener("success", successHandler);
  });
</script>
```

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

### Refund a Transaction

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

Initiate a refund for a completed mobile money transaction. Note that transaction fees are not included in the refund.

```php
$kkiapay->refundTransaction($transaction_id);
```
Tokens:
Raw