• Home
  • /
  • API Documantation

API Documantation

API Documantation


"PAYKz" is a complete solution for an online payment gateway. Client can use this system for send and receive money from other clients and use this system in any website.

API Documentation

Form attributes — ACTION and METHOD

The FORM tag includes two required attributes, action and method, which always look like this:

Complete HTML Form of Express Payment

Copy and Paste the HTML code to your website to Install Web Express Payment.

<form action="https://www.paykz.it.ao/express/web" method="post">
    <input type="hidden" name="business_account" value="<Business Account>">
    <input type="hidden" name="item_name" value="<Item Name>">
    <input type="hidden" name="item_code" value="<Item Code Number>">
    <input type="hidden" name="amount" value="<Pay Amount>">
    <input type="hidden" name="notify_url" value="<IPN Notification URL>">
    <input type="hidden" name="cancel_return" value="<Cancel URL>">
    <input type="hidden" name="success_return" value="<Payment Success URL>">
    <input type="hidden" name="custom" value="<Custom Data>">
    <input type="submit" name="submit" value="Pay Now">

IPN Notification

A notification of your express payment will send to your notify_url

An Example of IPN responsepayment_status=Completed&amount=40&fee=0&txn=BREAVDSU3536SF&paid_by=buyer@gmail.com&receiver=seller@gmail.com&item_code=123456789&item_name=Item Name&custom=any_custom_value

Response Valriables

payment_status :Payment Completation Status
anmount :Total Paid Amount
fee :Payment Process Charge
txn :Transaction ID (can use in api to validate your transaction)
paid_by :Who paid the amount
receiver :Who received the paid amount
item_code :Item Code Send By Website
item_code :Item Code Send By Website
item_name :Item Name Send By website
custom :Any Custom Value


PAYKz API URL: http://www.paykz.it.ao/api

Api parameters:
api_key :Business Account Api Key Provided by website (Login to your business account and go to SETTINGS)
txn :Transaction ID to verify the transaction information
Example API URL:
http://www.example.com/api?api_key=<"API_KEY">&txn=<"TRANSACTION _ID">

Example JSON Response:

    "details": {
        "txn_id": "4NIRFJJTAUE",
        "txn_reason": "Payment Sent",
        "txn_amount": 85,
        "txn_fee": 10.5,
        "txn_type": "debit",
        "txn_reference": "Test payment",
        "txn_status": "completed",
        "txn_date": "2017-12-24 09:00:55",
        "txn_info": {
            "credit_from": null,
            "debit_to": "PayKz@PayKz.it.ao",
            "withdraw_method": null,
            "deposit_method": null
    "success": true,
    "error": false,
    "message": "Transaction Verified"


Developer Support


Email: Suporte@Paykz.it.ao