Tarkibga o'tish

API ma'lumotnomasiga murojaat

Payme API onlayn to'lov ssenariylarini amalga oshirish uchun kuchli vositalarni taqdim etadi. Siz o'zingizning to'lov jarayoningizni ishlab chiqishingiz mumkin Payme API yordamida har qanday murakkablikdagi narsalarni oddiy usulda: karta to'lovlari, 3DSecure, obunalar, bo'linma to'lovlar, elektron fiskallash, va boshqalar.

API FORM formatida kodlangan so'rovlar <-> javoblar yoki JSON formatida kodlangan so'rovlar <-> javoblar oqimi atrofida tashkil etilgan. Shunday qilib, siz So'rov tanasi uchun FORM yoki JSON ni tanlang; javob tanasi ham xuddi shu formatda bo'ladi.

sinov rejimi manzilida Payme API-dan funksionallik bo'yicha hech qanday cheklovlarsiz foydalanishingiz mumkin. Savdo nuqtasining holatiga qarab, barcha so'rovlar tegishli sinov yoki ishlab chiqarish rejimida bajariladi. Sinov rejimi hech qachon haqiqiy moliyaviy holatingizga ta'sir qilmaydi.

Avtentifikatsiya

Barcha API so'rovlari POST usulidan foydalangan holda HTTPS protokoli orqali yuborilishi kerak. Payme har bir so'rovni autentifikatsiya qilish uchun signature parametridan foydalanadi. Imzo — bu sotuvchi tomonidan yaratilgan SHA1 xesh funksiyasining natijasidir. to'lov kalitingizdan foydalangan holda.

Har bir API so'rovi uchun Imzo yaratish bo'limiga muvofiq esignaturedan foydalaning. API so'rovi misoli:

curl -L 'https://pay.payme.uz/api/checkout/url' \
-H 'Content-Type: application/json' \
-d '{
    "request": {
        "server_callback_url": "...",
        "order_id": "test_order1231",
        "currency": "UZS",
        "merchant_id": 4056281,
        "order_desc": "Test payment",
        "amount": 100,
        "signature": "487690517384b11725ac02d37f79fe677174291f"
    }
}'
'To'lov kalitlari' bo'limida ( saytining 'Testing mode' bo'limidagi test to'lov kaliti, savdogar identifikatori va kartalardan foydalaning.

Eslatma

Sotuvchingiz sinov rejimida bo'lganda, javobda qo'shimcha parametr response_signature_string bo'lishi mumkin, u esa yo'q bo'ladi haqiqiy vaqtda. Bu so'rovga noto'g'ri imzo qo'yilgani uchun rad etilgan sabablarni tahlil qilishda foydali.

Ogohlantirish

Veb-saytdagi 'Test rejimi' bo'limidan olingan test to'lov kaliti va savdogar identifikatoridan foydalanib, Payme APIga maxfiy ma'lumot yubormang.

Rad etishlar va xatoliklar

Oddiy javob so'rov muvaffaqiyatli qayta ishlanganligini anglatadi. Oddiy javob quyidagilarni o'z ichiga oladi "response_status": "success"

Standart javob

{
    "response": {
        "checkout_url": "https://pay.payme.uz/merchants/..../index.html?token=...",
        "payment_id": "738303484",
        "response_status": "success"
    }
}

Rad etish — bu so'rov muvaffaqiyatli qayta ishlangan, lekin to'lov qandaydir sababga ko'ra rad etilgan holatda beriladigan normal javobdir. Javob rad etilgan to'lov parametrlari response_code va response_description ni o'z ichiga oladi. Iltimos, Veb-saytdagi 'Javob kodlari' bo'limiga qarang (](response-codes.md)).

Standart javob with decline

{
   "response": {
       "rrn": "",
       "masked_card": "444411XXXXXX6666",
       "sender_cell_phone": "",
       "sender_account": "",
       "currency": "UZS",
       "fee": "",
       "reversal_amount": "0",
       "settlement_amount": "0",
       "actual_amount": "",
       "response_description": "General decline",
       "sender_email": "",
       "order_status": "declined",
       "response_status": "success",
       "order_time": "27.09.2022 22:43:38",
       "actual_currency": "",
       "order_id": "TestOrder238947272719",
       "tran_type": "purchase",
       "eci": "",
       "settlement_date": "",
       "payment_system": "card",
       "approval_code": "",
       "merchant_id": 4056281,
       "settlement_currency": "",
       "payment_id": 526886172,
       "card_bin": 444411,
       "response_code": 1000,
       "card_type": "VISA",
       "amount": "200",
       "signature": "fd5d3d61698ad80e91415eea42180db91b90fddd",
       "product_id": "",
       "merchant_data": "",
       "rectoken": "",
       "rectoken_lifetime": "",
       "verification_status": "",
       "parent_order_id": ""
   }
}

Error javobda qaytariladi, agar Payme to'lov shlyuzasi so'rovni qayta ishlay olmasa. Bu holda, javob error_message va error_code parametrlarini, shuningdek "response_status": "failure" ni o'z ichiga oladi.

Response with error

{
    "response": {
        "error_code": 1011,
        "error_message": "Parameter `amount` is missing",
        "request_id": "eZIT2An0VLAY2",
        "response_status": "failure"
    }
}