Developer API Documentation

1. Authentication Security Parameters

Every API transaction executing against production hooks routes through server validating schemas using your personal gateway profile signature. Send this signature in your transaction execution payloads:

2. Initialize Payment Prompt (`stk_push`)

Triggers an automated transaction interface directly on your user's smartphone handset screen matching standard merchant billing routines.

<?php
$gatewayUrl = "https://printpay.site/api/stk_push";

$payload = [
    'x_api_key'    => 'YOUR_MERCHANT_X_API_KEY',
    'phone_number' => '0712345678',
    'amount'       => 10
];

$ch = curl_init($gatewayUrl);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($payload));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
curl_close($ch);

echo $result;
?>

const axios = require('axios');
const querystring = require('querystring');

const url = 'https://printpay.site/api/stk_push';
const data = {
    x_api_key: 'YOUR_MERCHANT_X_API_KEY',
    phone_number: '0712345678',
    amount: 10
};

axios.post(url, querystring.stringify(data), {
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

import requests

url = "https://printpay.site/api/stk_push"
payload = {
    "x_api_key": "YOUR_MERCHANT_X_API_KEY",
    "phone_number": "0712345678",
    "amount": 10
}

response = requests.post(url, data=payload)
print(response.json())

curl -X POST "https://printpay.site/api/stk_push" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "x_api_key=YOUR_MERCHANT_X_API_KEY" \
  -d "phone_number=0712345678" \
  -d "amount=10"

{
  "status": "success",
  "checkout_id": "ws_CO_070720261234567890"
}

3. Transaction Verification Polling (`check_status`)

Allows external script nodes to dynamically audit structural data parameters on demands via native handshake transaction reference channels.

<?php
$checkoutID = "ws_CO_070720261234567890";
$queryUrl = "https://printpay.site/api/stk_push?check_status=" . $checkoutID;

$response = file_get_contents($queryUrl);
echo $response;
?>

const axios = require('axios');

const checkoutID = 'ws_CO_070720261234567890';
const queryUrl = `https://printpay.site/api/stk_push?check_status=${checkoutID}`;

axios.get(queryUrl)
.then(response => console.log(response.data))
.catch(error => console.error(error));

import requests

checkout_id = "ws_CO_070720261234567890"
query_url = f"https://printpay.site/api/stk_push?check_status={checkout_id}"

response = requests.get(query_url)
print(response.json())

curl -X GET "https://printpay.site/api/stk_push?check_status=ws_CO_070720261234567890"

{
  "id": "241",
  "status": "SUCCESS",
  "phone_number": "254712345678",
  "amount": "10.00",
  "mpesa_receipt_number": "TGR7XYZ890"
}

{
  "id": "241",
  "status": "PENDING",
  "phone_number": "254712345678",
  "amount": "10.00",
  "mpesa_receipt_number": null
}

4. Instant Callback Notifications (`Webhooks`)

Provide a dynamic URL listener target path within your dashboard configuration pane. The transaction engine will execute an external automated inbound JSON POST payload the moment confirmation values resolve from Safaricom API endpoints.

{
  "checkout_id": "ws_CO_070720261234567890",
  "status": "SUCCESS",
  "mpesa_receipt": "TGR7XYZ890",
  "amount": 10.00,
  "phone": "254712345678",
  "result_code": 0
}

5. Standard Result Code