Dasturchilar uchun API hujjatlari

To'lovlarni yaratish, balansni tekshirish va kassa statistikasini boshqarish uchun yagona API tizimi.

Asosiy manzil https://checkout.uz/api/v1

llm.txt sifatida ko’rish Tayyor plaginlar

Avtorizatsiya

Har bir so’rov Authorization sarlavhasida Bearer token ko’rinishida API kalitini o’z ichiga olishi kerak. API kalitni kassa sozlamalaridan olishingiz mumkin. Agar IP Whitelist yoqilgan bo’lsa, so’rov faqat ruxsat etilgan IP manzildan yuborilishi shart.

Header

Authorization: Bearer YOUR_API_KEY

API kalit

Server

Kalitingiz faqat brauzeringizda saqlanadi va so’rov to’g’ridan-to’g’ri tanlangan serverga yuboriladi.

Webhook

To’lov muvaffaqiyatli tasdiqlanganda, tizim quyidagi ma’lumotni POST so’rovi orqali sizning webhook manzilingizga yuboradi. Ikki manzil ishlatilishi mumkin: kassa sozlamalaridagi umumiy "Webhook URL" va/yoki /create_payment chaqirilganda webhook_url parametri orqali ko’rsatilgan manzil — ikkalasi ham sozlangan bo’lsa, ikkalasiga alohida-alohida yuboriladi.

Yuboriladigan ma’lumot (payload)

{
    "webhook_type": "version_1_1",
    "status": "success",
    "event": "payment_confirmed",
    "payment_system": "click",
    "shop_id": 3,
    "data": {
        "order_id": 45180,
        "amount": 5000,
        "currency": "UZS",
        "status": "paid",
        "provider_details": {
            "...": "provayderga xos xom (raw) maydonlar"
        },
        "perform_time": 1784393083895
    },
    "timestamp": 1784393083
}

Maydonlar

webhook_type (string)

Webhook formatining versiyasi.

status (string)

Har doim "success" (yuborish muvaffaqiyatli amalga oshirilgani, to’lovning holati emas).

event (string)

Hodisa turi. Hozircha faqat "payment_confirmed".

payment_system (string)

To’lov amalga oshirilgan tizim kaliti (masalan click, payme, plum).

shop_id (integer)

Kassa identifikatori.

data.order_id (integer)

To’lovga tegishli invoys ID raqami (/create_payment javobidagi _id bilan bir xil).

data.amount (number)

To’lov summasi.

data.currency (string)

Valyuta. Hozircha har doim "UZS".

data.status (string)

Har doim "paid".

data.provider_details (object)

To’lov tizimidan kelgan xom (raw) ma’lumot - tizimga qarab tarkibi farq qiladi.

data.perform_time (integer)

To’lov amalga oshirilgan vaqt (millisekundlarda, Unix timestamp).

timestamp (integer)

Webhook yuborilgan vaqt (sekundlarda, Unix timestamp).

Serveringiz HTTP 200 kod bilan javob qaytarishi kifoya. Hozircha muvaffaqiyatsiz urinish avtomatik qayta yuborilmaydi.

Payment Operations

Parametrlar

amount (number, majburiy)

To'lov summasi (so'mda). Minimal: 1000, maksimal: 10 000 000.

description (string, ixtiyoriy)

Ixtiyoriy. Buyurtma haqida qisqacha izoh, to'lov sahifasida mijozga ko'rsatiladi.

webhook_url (string, ixtiyoriy)

Ixtiyoriy. To'lov tasdiqlangach, natija shu manzilga ham yuboriladi (kassaning umumiy webhook manziliga qo'shimcha ravishda).

return_url (string, ixtiyoriy)

Ixtiyoriy. To'lov muvaffaqiyatli yakunlangach, mijoz avtomatik shu manzilga qaytariladi (masalan, do'koningizning "buyurtma qabul qilindi" sahifasi). Ko'rsatilmasa, mijoz checkout.uz'ning o'z "to'landi" sahifasida qoladi.

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/create_payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 50000,
    "description": "Buyurtma #12345",
    "webhook_url": "https://mysite.uz/webhooks/checkout",
    "return_url": "https://mysite.uz/order-received/12345"
}'

fetch("https://checkout.uz/api/v1/create_payment", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "amount": 50000,
    "description": "Buyurtma #12345",
    "webhook_url": "https://mysite.uz/webhooks/checkout",
    "return_url": "https://mysite.uz/order-received/12345"
})
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/create_payment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"amount":50000,"description":"Buyurtma #12345","webhook_url":"https://mysite.uz/webhooks/checkout","return_url":"https://mysite.uz/order-received/12345"}');
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "payment": {
        "_id": 152,
        "_uuid": "550e8400-e29b-41d4-a716-446655440000",
        "_url": "https://checkout.uz/pay/550e8400-e29b-41d4-a716-446655440000",
        "_amount": 50000,
        "_status": "pending",
        "_pay_via": {
            "click": "https://checkout.uz/pay/550e8400-e29b-41d4-a716-446655440000/click",
            "payme": "https://checkout.uz/pay/550e8400-e29b-41d4-a716-446655440000/payme"
        },
        "_return_url": "https://mysite.uz/order-received/12345",
        "_lifteme": {
            "_second": 3600,
            "_hour": 1
        }
    }
}

Sinab ko’rish

amount *

description

webhook_url

return_url

Javob

Natija shu yerda ko’rinadi

Parametrlar

id (integer, ixtiyoriy)

Invoice ID raqami

uuid (string, ixtiyoriy)

To'lovning UUID kodi

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/status_payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 0,
    "uuid": ""
}'

fetch("https://checkout.uz/api/v1/status_payment", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "id": 0,
    "uuid": ""
})
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/status_payment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"id":0,"uuid":""}');
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "data": {
        "id": 152,
        "amount": 50000,
        "status": "paid",
        "created_at": "2026-01-31 10:00:00",
        "paid_at": "2026-01-31 10:05:22"
    }
}

Sinab ko’rish

uuid

Javob

Natija shu yerda ko’rinadi

Payments

Parametrlar

order_id (integer, majburiy)

create_payment javobidagi payment._id (to'lanishi kerak bo'lgan invoys ID'si).

card_number (string, majburiy)

Karta raqami (16 xonali, bo'sh joysiz yoki bo'sh joy bilan - ikkalasi ham qabul qilinadi).

card_expiry (string, majburiy)

Kartaning amal qilish muddati, OY/YIL (MM/YY) formatida.

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/pay_via_card" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": 12345,
    "card_number": "8600123456789012",
    "card_expiry": "12/28"
}'

fetch("https://checkout.uz/api/v1/pay_via_card", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "order_id": 12345,
    "card_number": "8600123456789012",
    "card_expiry": "12/28"
})
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/pay_via_card");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"order_id":12345,"card_number":"8600123456789012","card_expiry":"12/28"}');
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "message": "Tasdiqlash kodi hamyoningiz ulangan telefonga yuborildi.",
    "payment_token": "2Q85LemHnysZBQWSgubRX6hL7h8ZfuaXKP-ma2CNZlZVyBtCPwlGsMZTGUfiJWWdQmzVSB5a3Wfeuu..."
}

Sinab ko’rish

order_id *

card_number *

card_expiry *

Javob

Natija shu yerda ko’rinadi

Parametrlar

payment_token (string, majburiy)

pay_via_card javobidan olingan token (5 daqiqa amal qiladi).

sms_code (string, majburiy)

Kartaga bog'langan telefonga kelgan tasdiqlash kodi (odatda 6 xonali).

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/confirm_card_payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_token": "2Q85LemHnysZBQWSgubRX6hL7h8ZfuaXKP-ma2CNZlZVyBtCPwlGsMZTGUfiJWWdQmzVSB5a3Wfeuu...",
    "sms_code": "123456"
}'

fetch("https://checkout.uz/api/v1/confirm_card_payment", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "payment_token": "2Q85LemHnysZBQWSgubRX6hL7h8ZfuaXKP-ma2CNZlZVyBtCPwlGsMZTGUfiJWWdQmzVSB5a3Wfeuu...",
    "sms_code": "123456"
})
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/confirm_card_payment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"payment_token":"2Q85LemHnysZBQWSgubRX6hL7h8ZfuaXKP-ma2CNZlZVyBtCPwlGsMZTGUfiJWWdQmzVSB5a3Wfeuu...","sms_code":"123456"}');
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "type": "success"
}

Sinab ko’rish

payment_token *

sms_code *

Javob

Natija shu yerda ko’rinadi

Merchant Info

Ushbu so’rov tana (body) talab qilmaydi.

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/get_balance" \
  -H "Authorization: Bearer YOUR_API_KEY"

fetch("https://checkout.uz/api/v1/get_balance", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/get_balance");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "balance": {
        "uzs": 2500000,
        "usd": 120,
        "ton": 15.5
    }
}

Sinab ko’rish

Ushbu so’rov tana (body) talab qilmaydi.

Javob

Natija shu yerda ko’rinadi

Parametrlar

limit (integer, ixtiyoriy)

Ixtiyoriy. Qaytariladigan tranzaksiyalar soni.

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/get_history" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 10
}'

fetch("https://checkout.uz/api/v1/get_history", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "limit": 10
})
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/get_history");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"limit":10}');
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "data": [
        {
            "id": 152,
            "amount": 50000,
            "status": "paid",
            "created_at": "2026-01-31 10:00:00",
            "paid_at": "2026-01-31 10:05:22"
        },
        {
            "id": 151,
            "amount": 120000,
            "status": "paid",
            "created_at": "2026-01-30 18:22:11",
            "paid_at": "2026-01-30 18:23:40"
        }
    ]
}

Sinab ko’rish

limit

Javob

Natija shu yerda ko’rinadi

Ushbu so’rov tana (body) talab qilmaydi.

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/get_stats" \
  -H "Authorization: Bearer YOUR_API_KEY"

fetch("https://checkout.uz/api/v1/get_stats", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/get_stats");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "stats": {
        "total_orders": 450,
        "total_amount": 12500000.5
    }
}

Sinab ko’rish

Ushbu so’rov tana (body) talab qilmaydi.

Javob

Natija shu yerda ko’rinadi

Ushbu so’rov tana (body) talab qilmaydi.

Kod namunasi

curl -X POST "https://checkout.uz/api/v1/get_payment_methods" \
  -H "Authorization: Bearer YOUR_API_KEY"

fetch("https://checkout.uz/api/v1/get_payment_methods", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
})
  .then(res => res.json())
  .then(data => console.log(data));

$ch = curl_init("https://checkout.uz/api/v1/get_payment_methods");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_API_KEY",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Javob namunasi

{
    "status": "success",
    "data": [
        {
            "key": "click",
            "name": "Click - O'zbekiston",
            "logo_light": "https://example.com/click-light.png",
            "logo_dark": "https://example.com/click-dark.png"
        },
        {
            "key": "payme",
            "name": "Payme - O'zbekiston",
            "logo_light": "https://example.com/payme-light.png",
            "logo_dark": "https://example.com/payme-dark.png"
        }
    ]
}

Sinab ko’rish

Ushbu so’rov tana (body) talab qilmaydi.

Javob

Natija shu yerda ko’rinadi