Get started

You can accept payments today on KidaPay easily. KidaPay is a pre-built payment page and complete checkout experience that can be branded for your business. Integrate once, gain new features as KidaPay evolves

Use the following steps to create a Checkout page that lets a customer make a one-time payment or subscribe to recurring payment plans:

• Register and Get API Key
• Integrate with KidaPay Checkout on your website.
• Integration test for KidaPay.

Step 1. Register and Get API Key

Register your KidaPay merchant account by visiting (https://app-dev.kidapay.com/), sign up and verify your email.

1.1 Sign in to your KidaPay merchant account and generate you API key

After you have verified your email address, you will need to sign in to access the account you created

After successful sign in you will be directed to your account

1.2 Go to the settings page to generate your API key

In your account you will see a sidebar on the left that contains links to different pages, click on the SETTINGS to open the settings page and click on the API tab to generate an API.

1.3 Click on the API key button to generate your API key

On the API tab you will see the API key button on the right, click on the API key button to generate your API key.

1.4 Generate your API key and fill in the necessary fields and save it

Click on "Generate new API key", fill in the necessary fields and save it

1.5 Copy API Auth Token (API key)

Copy the API key you generated in other to use it.

Step 2. Integrate KidaPay Checkout with your website

KidaPay makes payment easy and faster. With a few steps, you can integrate KidaPay checkout to your website.

The specific steps are different depending on what language you're using.

JavaScript

Steps to take

Follow the guide to integrate KidaPay Checkout to your website.

1. Add the Button that sends request to Create Order.

To integrate Checkout on your website, you need to add a payment button, the button should trigger a Create Order request with purchase order information (It tells us the price amount, description, and merchant ID generated by your service).

1.1 Button that the trigger createOrderAction function in JavaScript.

<button onClick={createOrderAction}>Pay</button>

1.2 createOrderAction function in JavaScript.

async function createOrderAction(
  merchant_order_id,
  title,
  description,
  amount,
  currency,
  pay_currency,
  callback_url,
  cancel_url,
  success_url,
  token
) {
    const url = 'https://api-dev.kidapay.com/v1/orders'; //  API endpoint
    const payload = {
        merchant_order_id: merchant_order_id,
        title: title,
        description: description,
        amount: amount,
        currency: currency,
        pay_currency: pay_currency,
        callback_url: callback_url,
        cancel_url: cancel_url,
        success_url: success_url,
        token: token
    };

    try {
        const response = await fetch(url, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json'
            },
            body: JSON.stringify(payload)
        });

        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }

        const result = await response.json();
        return result;
    } catch (error) {
        console.error('There was an error!', error);
    }
}

Python

Steps to take

Follow the guide to integrate KidaPay Checkout to your website.

1. Add the Button that sends request to Create Order.

To integrate Checkout on your website, you need to add a payment button, the button should trigger a Create Order request with purchase order information (It tells us the price amount, description, and merchant ID generated by your service).

1.1 Button that the trigger createOrderAction function in Python..

import requests
import tkinter as tk
from tkinter import messagebox

root = tk.Tk()
root.title("Create Order")

submit_button = tk.Button(root, text="Submit", command=on_submit)
submit_button.grid(row=3, column=1)

root.mainloop()

1.2 createOrderAction function in Python.

def create_order_action(
  merchant_order_id,
  title,
  description,
  amount,
  currency,
  pay_currency,
  callback_url,
  cancel_url,
  success_url,
  token
):
    url ='https://api-dev.kidapay.com/v1/orders'  # API endpoint
    headers = {'Content-Type': 'application/json'}
    payload = {
        'merchant_order_id': merchant_order_id,
        'title': title,
        'description': description,
        'amount': amount,
        'currency': currency,
        'pay_currency': pay_currency,
        'callback_url': callback_url,
        'cancel_url': cancel_url,
        'success_url': success_url,
        'token': token
    }

    try:
        response = requests.post(url, json=payload, headers=headers)
        response.raise_for_status()  # Raise exception for HTTP errors
       print("Order created successfully!") # Handle response if needed
    except requests.exceptions.RequestException as e:
        print(f"Error creating order: {e}")  # Handle error

def on_submit():
    merchant_order_id = merchant_order_id_entry.get()
    title = title_entry.get()
    description = description_entry.get()
    amount = amount_entry.get()
    currency = currency_entry.get()
    pay_currency = pay_currency_entry.get()
    callback_url = callback_url_entry.get()
    cancel_url = cancel_url_entry.get()
    success_url = success_url_entry.get()
    token = token_entry.get()

    result = create_order_action(  merchant_order_id,
  title,
  description,
  amount,
  currency,
  pay_currency,
  callback_url,
  cancel_url,
  success_url,
  token
  )
    
    if result:
        messagebox.showinfo("Success", "Order created successfully!")
    else:
        messagebox.showerror("Error", "Failed to create order")
        

Swift

Steps to take

Follow the guide to integrate KidaPay Checkout to your website.

1. Add the Button that sends request to Create Order.

To integrate Checkout on your website, you need to add a payment button, the button should trigger a Create Order request with purchase order information (It tells us the price amount, description, and merchant ID generated by your service).

1.1 Button to trigger createOrderAction function.

import SwiftUI

struct ContentView: View {
    
    var body: some View {
        VStack {
            Button(action: {
                createOrderAction(name: name, message: message, email: email)
            }) {
                Text("Pay")
            }
        }
    }
}

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

1.2 createOrderAction function in Swift.

import Foundation

func createOrderAction(
    merchant_order_id: String,
  title: String,
  description: String,
  amount: String,
  currency: String,
  pay_currency: String,
  callback_url: String,
  cancel_url: String,
  success_url: String,
  token: String,
) {
    let url = URL(string: "https://api-dev.kidapay.com/v1/orders")!
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    
    let parameters: [String: Any] = [
        "merchant_order_id": merchant_order_id,
        "title": title,
        "description": description,
        "amount": amount,
        "currency": currency,
        "pay_currency": pay_currency,
        "callback_url": callback_url,
        "cancel_url": cancel_url,
        "success_url": success_url,
        "token": token
    ]
    
    do {
        request.httpBody = try JSONSerialization.payload(withJSONObject: parameters, options: [])
    } catch let error {
        print("Failed to serialize JSON: \(error.localizedDescription)")
        return
    }
    
    request.addValue("application/json", forHTTPHeaderField: "Content-Type")
    
    let task = URLSession.shared.payloadTask(with: request) { payload, response, error in
        guard let payload = payload, error == nil else {
            print("Error: \(error?.localizedDescription ?? "Unknown error")")
            return
        }
        
        do {
            if let json = try JSONSerialization.jsonObject(with: payload, options: []) as? [String: Any] {
                print("Response JSON: \(json)")
            } else {
                print("Failed to parse JSON response")
            }
        } catch let error {
            print("Failed to decode JSON: \(error.localizedDescription)")
        }
    }
    
    task.resume()
}

PHP

Steps to take

Follow the guide to integrate KidaPay Checkout to your website.

1. Add the Button that sends request to Create Order.

To integrate Checkout on your website, you need to add a payment button, the button should trigger a Create Order request with purchase order information (It tells us the price amount, description, and merchant ID generated by your service).

1.1 Button that the trigger createOrderAction function in PHP.

<form action="your-php-file.php" method="POST">
        <button type="submit">Create Order</button>
    </form>

1.2 createOrderAction function in Python.

<?php
function createOrderAction($data) {
    $url = 'https://your-api-endpoint.com/create-order';
    
    $payload = array(
       'merchant_order_id': $merchant_order_id,
        'title': $title,
        'description': $description,
        'amount': $amount,
        'currency': $currency,
        'pay_currency': $pay_currency,
        'callback_url': $callback_url,
        'cancel_url': $cancel_url,
        'success_url': $success_url,
        'token': $token
    );

    $payload = json_encode($payload);

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

    $response = curl_exec($ch);
    if ($response === false) {
        die('Error: "' . curl_error($ch) . '" - Code: ' . curl_errno($ch));
    }

    curl_close($ch);

    return json_decode($response, true);
}

if ($_SERVER['REQUEST_METHOD'] === 'POST') {
   $payload = array(
        'merchant_order_id' => $_POST['merchant_order_id'],
        'title' => $_POST['title'],
        'description' => $_POST['description'],
        'amount' => $_POST['amount'],
        'currency' => $_POST['currency'],
        'pay_currency' => $_POST['pay_currency'],
        'callback_url' => $_POST['callback_url'],
        'cancel_url' => $_POST['cancel_url'],
        'success_url' => $_POST['success_url'],
        'token' => $_POST['token']
    );

    $result = createOrderAction($payload);
    echo 'Order Response: ' . print_r($result, true);
}
?>

2.3 Redirect user to Payment Page

After the Create Order succeeds, you should redirect the customer to KidaPay payment_url URL and redirects the customer to Crypto Payment page, which contains the purchase order information provided by Create Order.

2.4 Payment Callback (Webhook)

When your customer successfully completes their payment, they are redirected to the success URL that you specified. Typically, this is a page on your website that informs the customer that their payment was successful. The cancel URL is the page where Checkout redirects customers when they cancel the payment process.

Once payment is successful, you should fulfill the customer’s purchase. You can use Payment Callback webhooks to fulfill the purchase when callback event triggers.

---

NOTE

If you can't get the callback request after a payment finished, you should check if you correctly pass the callback_url params when you send a create order request. You also can check the url at Merchants Order History Page by click Triger Payment Callback button

---

Step 3. Integration test

Once the integration has been completed, there will then be testing from our team to ensure it's functionality. If all checks pass, it will be ready to go.

All the transactions of orders and withdraws can be viewed in the Merchants Portal.