Hisobotlar
Umumiy API qoidalari¶
Barcha so'rovlar HTTPS protokoli orqali POST usuli yordamida yuboriladi.
So'rovlar va javoblar formati JSON.
JSON javobining tuzilishi har doim dict (assotsiativ massiv) bo'ladi.
err_code yoki error kaliti mavjud bo'lsa, so'rov yakunlanmagan hisoblanadi. Bunday holda javobdagi err_code va error parametrlari xatolikni tavsiflovchi xabarni bildiradi.
Asosiy xato kodlari:
Authorization token required–tokenparametri so'rov boshlig'iga kiritilmaganInvalid auth token–tokenURLi noto'g'ri yoki eskirganMerchant not found– Sotuvchi topilmadiyou have no access to this report– yokireport_idhaqiqiy emas, yoki sizda hisobotga kirish huquqi yo'q
Xatolik holatidagi javob misoli
{
"error": "Authorization token required",
"err_code": "Authorization token required"
}
Avtorizatsiya tokeni so'rovingizning HTTP bosh sarlavhasidagi Authorization bo'limiga yuborilishi kerak.
Access token sarlavhasi bilan so'rov misoli
curl 'https://pay.payme.uz/api/extend/company/report/' \
-H "Authorization: Token 4cDY6LgviVN85g70eDHXygrmYTourFAT"
Avtentifikatsiya¶
Hisobotdan ma'lumot olishdan oldin, siz kirish tokenini olishingiz kerak.
JSON POST so'rovi quyidagi manzilga yuborilishi kerak: https://pay.payme.uz/authorizer/token/application/get
Parameters of authentication request
| Parametr | Majburiy | Tur | Tavsif | Misol |
|---|---|---|---|---|
application_id |
majburiy | string(20) | Kompaniya ID. ID va maxfiy kalitingizni olish uchun Payme uo'llab-quvvatlash xizmatiga murojaat qiling. | 1234 |
date |
majburiy | string(1024) | Sanani istalgan formatda ko'rsating. Sana sha512 imzo xeshining tuzi hisoblanadi. | 2020-04-06 11:15:27 yoki 1586171872 yoki boshqa istalgan satr |
signature |
majburiy | string(128) | Imzo | 7eec02ed1088b47da639549a109c0e98 a75e2d8c76dfa33db4ee18359b2ea677 dda37516abc0e439b286261a48d49d3e 2fd885d9f09c8ff5c7308afe4180688a |
signature vertikal chiziq (|) yordamida ilovaning xususiy kaliti, ilova identifikatori va sana parametrini birlashtirish orqali hosil qilinadi (UTF-8 kodlashda).
Natijada hosil bo'lgan satrga SHA-512 xesh funksiyasi qo'llanilishi kerak.
Imzo yaratish misoli
from datetime import datetime
import hashlib
date = str(datetime.now())
company_id = str(%your_company_id%)
signature = hashlib.sha512('|'.join(['%your_company_private_key%', company_id, date]).encode('utf-8')).hexdigest()
<?php
$date = strtotime("now");
$company_id = %application_id%;
$signature = hash('sha512', join('|',array('%your_company_private_key%', $company_id, $date)));
Agar so'rov muvaffaqiyatli bo'lsa, token JSON javobidagi token parametrida bo'ladi va 1 soatdan so'ng amal qilish muddati tugaydi.
Aks holda, javobda error_code va error_message kalitlari bo'ladi.
curl so'rovi misoli
curl 'https://pay.payme.uz/authorizer/token/application/get' \
-H "Content-Type: application/json; charset=utf-8" \
-X POST --data-binary @- <<EOF
{
"signature": "5124cef4e69a015c1662f0ff963adc9f85ff60e365445ffcf6688737da726becb298211e5040c9ac74e3f56ff1065b42c281e300370436bec539f6b2679b91ee",
"application_id": "2",
"date": "2024-04-06 11:15:27"
}
EOF
Xatolik holatidagi javob misoli
{
"request_id": "SuVhZRMS7JDD2iGS",
"token": "Yq0GXWeOZ1m8BsiCa4iQPDB84Wjw346",
"expires_in": 3602
}
{
"error_code": 403,
"error_message": "Incorrect signature",
"request_id": "cGeC7PH59ESqQw30"
}
Hisobot ma'lumotlarini olish¶
So'rov POST usulidan foydalangan holda quyidagi manzilga yuborilishi kerak: https://pay.payme.uz/api/extend/company/report/
Hisobot ma'lumotlarini olish so'rovi misoli
| Parametr | Majburiy | Tur | Tavsif | Misol |
|---|---|---|---|---|
filters |
majburiy | JSON objects[] | Har bir hisobotga (report_id) xos filtrlar to'plami | "filters": [ { "s": "settlement_date", "m": "dateis", "v": "2019-01-24" } ] |
merchant_id |
majburiy | butun son(12) | Yagona savdogar identifikatori. Savdogar ro'yxatdan o'tkazilganda Payme tomonidan yaratiladi. | 4056281 |
report_id |
majburiy | butun son(12) | Yagona hisobot identifikatori (mavjud hisobotlar ro'yxatiga qarang) | 688 |
on_page |
majburiy | butun son(12) | Har bir so'rov bo'yicha qaytariladigan yozuvlar soniga cheklov (tavsiya etilgan diapazon: 10 dan 500 gacha) | 500 |
page |
majburiy | butun son(12) | Sahifa ofsetini qayd etadi. Masalan, agar on_page = 50 bo'lsa, 51 dan 100 gacha ma'lumotni olish uchun page = 2 ni o'tkazishingiz kerak. | 2 |
| Parametr | Majburiy | Tur | Tavsif | Misol |
|---|---|---|---|---|
data |
majburiy | JSON ob'ektlari[][] | Tartiblangan ikki o'lchovli JSON massiv shaklidagi ma'lumotlar to'plami | "data": [ [ 1234567890, 10000000001 ], [ 1234567891, 10000000002 ] ] |
fields |
majburiy | string[] | Qaytish maydonlari ro'yxati | "fields": [ "payment_id", "order_time", "order_status", "actual_amount", "currency", "fee", "order_id", "settlement_amount", "settlement_currency", "settlement_date", "settlement_status", "odb_ref", "tran_time", "settlement_type", "payment_system", "sender_email", "order_desc", "merchant_data", "settlement_desc", "transaction_id" ] |
rows_count |
majburiy | butun son(12) | To'liq ma'lumotlar to'plamidagi yozuvlar soni | 500 |
rows_on_page |
majburiy | butun son(12) | Ushbu so'rov kontekstida qaytarilgan yozuvlar soni | 50 |
rows_page |
majburiy | butun son(12) | To'liq ma'lumotlar to'plamidagi diapazon siljishi. Masalan, agar rows_on_page = 50 va rows_page = 2 bo'lsa, ushbu so'rov kontekstida 51-dan 100-gacha bo'lgan yozuvlar qaytariladi. | 2 |
So'rov va javob misoli
curl 'https://pay.payme.uz/api/extend/company/report/' \
-H "Authorization: Token k1y0qXZ6KgO4GIfkeRlEznao0zbzYdhf" \
-d @- << EOF
{
"on_page": 10,
"page": 1,
"filters": [
{
"s": "settlement_date",
"m": "from",
"v": "2019-01-24"
},
{
"s": "settlement_date",
"m": "to",
"v": "2019-01-27"
},
{
"s": "actual_amount",
"m": "=",
"v": "630.00"
}
],
"merchant_id": 1398432,
"report_id": "403"
}
EOF
{
"data": [
[
1234567890,
"2025-01-23 10:58:38",
"approved",
"630.00",
"UZS",
"11.97",
"test-25697841-1",
"618.03",
"EUR",
"2025-01-24 08:00:00",
"completed",
"2426012568",
"2025-01-23 10:58:38",
"purchase",
"Visa/MC",
"test@test.com",
"Test order 1",
"[]",
"Test payment 1",
10000000001
],
[
1234567891,
"2025-01-23 10:56:51",
"approved",
"572.86",
"UZS",
"10.88",
"test-94341241-1",
"561.98",
"EUR",
"2025-01-24 08:00:00",
"completed",
"2426012568",
"2025-01-23 10:56:51",
"purchase",
"Visa/MC",
"test2@test.com",
"Test order 2",
"[]",
"Test payment 2",
10000000002
]
],
"rows_count": 2,
"fields": [
"payment_id",
"order_time",
"order_status",
"actual_amount",
"currency",
"fee",
"order_id",
"settlement_amount",
"settlement_currency",
"settlement_date",
"settlement_status",
"odb_ref",
"tran_time",
"settlement_type",
"payment_system",
"sender_email",
"order_desc",
"merchant_data",
"settlement_desc",
"transaction_id"
],
"rows_page": 1,
"rows_on_page": 10
}
Filtrlardan foydalaning¶
filter — bu JSON obyektlari massividir.
Har bir filter ob'ekti quyidagi atributlarni o'z ichiga olishi kerak:
s – filtr qo'llaniladigan maydon nomi
m – qidiruv operatori (=, <, > va hokazo, maydon turiga qarab)
v – filtrlanadigan maydon qiymati
Filtr misoli
[
{
"s": "settlement_date",
"m": "dateis",
"v": "2019-01-24"
}
]
Operandlar maydon turiga qarab¶
Example
float: '=', '>', '<', '!=', 'isnull', 'notnull'
int: '=', '>', '<', '!=', 'any', 'isnull', 'notnull'
sana: 'dateis', 'from', 'to', 'isnull', 'notnull', 'notdate'
matn: '=', '!=', 'like', '!like', 'start', 'empty', 'any', 'notnull'
bool: istrue
select: '=', '!=', 'any'
array: in_array
daterange: 'daterange'
Ochiq bo'lmagan qidiruv rejimlari¶
Example
any:
{“s”: “id”, “m”: “=”, “v”: “10,20,30”} – filter values specified with comma separator
Filtr (10,20,30) ichida ID sifatida qo'llanadi
Manba:
{“s”: “timestart”, “m”: “from”, “v”: “2020-01-10”} - filter is applied as timestart >= ‘2020-01-10’
{“s”: “timestart”, “m”: “from”, “v”: “-2”} - filter is applied as timestart >= now() – 2 days
ga:
{“s”: “timestart”, “m”: “to”, “v”: “2020-01-10”} - filter is applied as timestart < ‘2020-01-11‘
dateis – 'daye equal' – ko'rsatilgan kun boshidan (00:00) keyingi kun boshigacha (00:00) filtrlangan ma'lumot (keyingi kunni o'z ichiga olmaydi)
like – fragmentlarning qisman mos kelishlarini filtrlaydi
!like – qisman fragment mos kelmasligi kerak
start – 'boshlanishidan'
Mavjud hisobotlar ro'yxati¶
Hisobot ma'lumotlarini olish uchun so'rov parametrlari
| Hisobot ID | Maydonlar & & | Majburiy filtr maydonlari | Namuna bo'yicha filtrlash | Tavsif |
|---|---|---|---|---|
| 500 | chargeback_createtime - datetime(YYYY-MM-DD HH24:MI:SS)tran_id - integer(12)sender_email - string(1000)status - string(1000)tran_timestart - datetime(YYYY-MM-DD HH24:MI:SS)tran_timeend - datetime(YYYY-MM-DD HH24:MI:SS)tran_type - string(1000)protocol - string(1000)currency - string(3)amount - decimal(19,2)payout_date - datetime(YYYY-MM-DD HH24:MI:SS)payout_amoun - datetime(YYYY-MM-DD HH24:MI:SS) |
tran_id YOKI chargeback_createtime |
[ { "on_page": 5, "page": 1, "filters": [ { "s": "chargeback_createtime", "m": "from", "v": "2019-12-11" }, { "s": "chargeback_createtime", "m": "to", "v": "2019-12-13" } ], "merchant_id": 4056281, "report_id": "500" } ] |
Qaytarib berish to'lovlari bo'yicha hisobot |
| 528 | tran_id - integer(12)parent_tran_id - integer(12)sender_email - string(1000)status - string(1000)tran_timestart - datetime(YYYY-MM-DD HH24:MI:SS)tran_timeend - datetime(YYYY-MM-DD HH24:MI:SS)tran_type - string(1000)currency - string(3)actual_amount - decimal(19,2)payout_date - datetime(YYYY-MM-DD HH24:MI:SS)payout_amoun - decimal(19,2)order_desc - string(1000)checkout_url - string(1000) |
tran_id YOKI tran_timestart |
[ { "on_page": 5, "page": 1, "filters": [ { "s": "tran_timestart", "m": "from", "v": «2019-12-11» }, { "s": «tran_timeend», "m": «to», "v": «2019-12-13» } ], "merchant_id": 4056281, "report_id": '528' } ] |
Muvaffaqiyatli tranzaksiyalar bo'yicha hisobot |
| 745 | payment_id - integer(12)order_timestart - datetime(YYYY-MM-DD HH24:MI:SS)order_timeend - datetime(YYYY-MM-DD HH24:MI:SS)order_status - string(1000)amount - decimal(19,2)actual_amount - decimal(19,2)transaction_id - integer(19)currency - string(3)actual_currency - string(3)order_type - string(1000)approval_code - string(6)card_bin - string(6)eci - string(2)fee - decimal(19,2)masked_card - string(19)order_id - string(1000)payment_system - string(1000)response_code - integer(4)response_description - string(1000)reversal_amount - decimal(19,2)rrn - string(1000)sender_email - string(1000)settlement_amount - decimal(19,2)settlement_currency - string(3)settlement_date - datetime(YYYY-MM-DD HH24:MI:SS)merchant_data - string(1000)order_desc - string(1000)payer_country - string(1000)bank_name - string(1000)bank_country - string(3)card_expire_date - datetime(MM/YYYY)card_brand - string(1000)fee_name - string(1000)fee_type - string(1000)fee_percent_value - decimal(19,3)fee_fix_value - decimal(19,3) |
order_timestart Yoki order_timeend Yoki payment_id Yoki order_id |
[ { "on_page": 5, "page": 1, "filters": [ { "s": "order_timestart", "m": "from", "v": "2019-12-11" }, { "s": "order_timestart", "m": "to", "v": "2019-12-13" } ], "merchant_id": 4056281, "report_id": "745" } ] |
Barcha tranzaksiyalar bo'yicha hisobot |
| 969 | payment_id - integer(12)tran_id - integer(12)order_id - string(1000)tran_timeend - datetime(YYYY-MM-DD HH24:MI:SS)actual_amount - decimal(19,2)settlement_currency - string(3)fee - decimal(19,2)settlement_amount - decimal(19,2)settlement_date - datetime(YYYY-MM-DD HH24:MI:SS)batch_id - integer(12)order_type - string(1000)order_status - string(1000)card_brand - string(1000)payment_system - string(1000)masked_card - string(19)rrn - integer(12)approval_code - string(6)order_desc - string(1000)merchant_data - string(1000)payer_country - string(1000)bank_name - string(1000)card_expire_date - sanasi va vaqti (MM/YYYY)card_brand - string(1000)fee_name - string(1000)fee_type - string(1000)fee_percent_value - o'nlik son (19.3)fee_fix_value - o'nlik son (19.3) |
settlement_date Yoki tran_timeend Yoki payment_id Yoki order_id |
[ { "on_page": 5, "page": 1, "filters": [ { "s": "settlement_date", "m": "from", "v": "2025-03-11" }, { "s": "settlement_date", "m": "to", "v": "2025-03-12" } ], "merchant_id": 4056281, "report_id": "969" } ] |
Xarajatlarni qoplash hisobot |