Барои таҳиягарон ҳуҷҷатҳои API

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

Суроғаи асосӣ https://checkout.uz/api/v1

Авторизатсия

Ҳар як дархост бояд калиди API-ро дар сарлавҳаи Authorization дар шакли Bearer token дошта бошад. Калиди API-ро аз танзимоти касса гирифтан мумкин аст. Агар IP Whitelist фаъол бошад, дархост бояд танҳо аз IP-и иҷозатдодашуда фиристода шавад.

Header

Authorization: Bearer YOUR_API_KEY

Калиди API

Сервер

Калиди шумо танҳо дар браузер нигоҳ дошта мешавад, дархост мустақиман ба сервери интихобшуда фиристода мешавад.

Webhook

Вақте ки пардохт бомуваффақият тасдиқ мешавад, система маълумоти дар поён овардашударо тавассути дархости POST ба суроғаи webhook-и шумо мефиристад. Ду суроға истифода шуда метавонад: "Webhook URL"-и умумӣ дар танзимоти касса ва/ё суроғае, ки ҳангоми чақируви /create_payment дар параметри webhook_url нишон дода шудааст - агар ҳарду танзим шуда бошанд, ба ҳар кадоме алоҳида фиристода мешавад.

Маълумоти фиристодашаванда (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
}

Майдонҳо

webhook_type (string)

Версияи форматi webhook.

status (string)

Ҳамеша "success" (маънояш фиристодани муваффақ, на ҳолати пардохт).

event (string)

Навъи ҳодиса. Ҳоло танҳо "payment_confirmed".

payment_system (string)

Калиди системаи пардохт (масалан click, payme, plum).

shop_id (integer)

Идентификатори касса.

data.order_id (integer)

ID-и инвойси марбут ба пардохт (бо _id дар ҷавоби /create_payment якхела).

data.amount (number)

Маблағи пардохт.

data.currency (string)

Асъор. Ҳоло ҳамеша "UZS".

data.status (string)

Ҳамеша "paid".

data.provider_details (object)

Маълумоти хоми (raw) аз системаи пардохт - сохтор вобаста ба система фарқ мекунад.

data.perform_time (integer)

Вақти иҷрои пардохт (дар миллисония, Unix timestamp).

timestamp (integer)

Вақти фиристодани webhook (дар сония, Unix timestamp).

Сервери шумо танҳо бояд бо коди HTTP 200 ҷавоб диҳад. Кӯшиши бемуваффақият ҳоло ба таври худкор такрор фиристода намешавад.

Payment Operations

Параметрҳо

amount (number, ҳатмӣ)

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

description (string, ихтиёрӣ)

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

webhook_url (string, ихтиёрӣ)

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

return_url (string, ихтиёрӣ)

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.

Намунаи код

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

Намунаи ҷавоб

{
    "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
        }
    }
}

Санҷиш кардан

amount *

description

webhook_url

return_url

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Параметрҳо

id (integer, ихтиёрӣ)

Invoice ID raqami

uuid (string, ихтиёрӣ)

To'lovning UUID kodi

Намунаи код

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

Намунаи ҷавоб

{
    "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"
    }
}

Санҷиш кардан

uuid

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Payments

Параметрҳо

order_id (integer, ҳатмӣ)

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

card_number (string, ҳатмӣ)

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

card_expiry (string, ҳатмӣ)

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

Намунаи код

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

Намунаи ҷавоб

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

Санҷиш кардан

order_id *

card_number *

card_expiry *

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Параметрҳо

payment_token (string, ҳатмӣ)

pay_via_card javobidan olingan token (5 daqiqa amal qiladi).

sms_code (string, ҳатмӣ)

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

Намунаи код

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

Намунаи ҷавоб

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

Санҷиш кардан

payment_token *

sms_code *

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Merchant Info

Ин дархост бадан (body) талаб намекунад.

Намунаи код

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

Намунаи ҷавоб

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

Санҷиш кардан

Ин дархост бадан (body) талаб намекунад.

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Параметрҳо

limit (integer, ихтиёрӣ)

Ixtiyoriy. Qaytariladigan tranzaksiyalar soni.

Намунаи код

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

Намунаи ҷавоб

{
    "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"
        }
    ]
}

Санҷиш кардан

limit

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Ин дархост бадан (body) талаб намекунад.

Намунаи код

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

Намунаи ҷавоб

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

Санҷиш кардан

Ин дархост бадан (body) талаб намекунад.

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад

Ин дархост бадан (body) талаб намекунад.

Намунаи код

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

Намунаи ҷавоб

{
    "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"
        }
    ]
}

Санҷиш кардан

Ин дархост бадан (body) талаб намекунад.

Ҷавоб

Натиҷа дар ин ҷо намоён мешавад