LogoLogo
  • Ishni boshlash
  • Internet-ekvayering bilan integratsiya
  • Checkout API — to‘lov freymi
    • Prepare — buyurtma yaratish
    • Payment — kartadan yechish
    • Verify — kod bilan tasdiqlash
    • Get Service Info — xizmat ma’lumotlari
    • Get Order Info — buyurtma ma’lumotlari
    • Receipt — fiskal chek
    • Invoys bo‘yicha to‘lov
    • Operatsiya holatlari
  • Acquiring API — kartalar va to‘lovlar
  • Billing API integratsiyasi uchun talablar
  • Ichki API (xizmat uchun)

Prepare — buyurtma yaratish

  1. Checkout api — to‘lov freymi
  2. Prepare — buyurtma yaratish

Prepare — buyurtma yaratish

1. Prepare request

POST- api/v1/checkout/prepare

Request header

Field

Optional

Description

Content-Type

false

application/json

X-Lang

true

RU

Request Body

Field

Optional

Description

hash

false

kerakli ma’lumotlar asosida yaratilgan xesh

serviceId

false

xizmat ID

amount

false

to‘lov summasi, tiyinda

currency

false

To‘lov valyutasi

returnUrl

true

to‘lovdan keyingi redirekt URL

items

false

Tranzaksiya parametrlari

billingIdentifier

true

Hisob-kitob identifikatori

Request sample

curl --location '{baseUrl}/api/v1/checkout/prepare' \
--header 'Content-Type: application/json' \
--data '{
    "hash": "e171ebda5d69a97fa8ed271e85db159124ab403922bc70b5204a2ede73f2c625",
    "serviceId": "c655a18f-73c3-4abe-a0c8-bf7df7a3697e",
    "amount": 5000,
    "currency": "UZS",
    "returnUrl": "redirect",
    "billingIdentifier": "order1",
    "items": {
        "billingIdentifier": "ZE1239123"
    }
}'

Hash build example

создание хеша:

связывать все параметры transactionParams с "."
value = transactionParams.value1.transactionParams.value2 ....

и после этого идеть создание хеша
sha256(secretKey.serviceId.amount.value.returnUrl)

secretKey - передедим добавляется в проект  фронтенда статически соль

в нашем примере будеть
{secretKey}.c655a18f-73c3-4abe-a0c8-bf7df7a3697e.5000.value1.redirectt

и шифруем с sha256
e171ebda5d69a97fa8ed271e85db159124ab403922bc70b5204a2ede73f2c625

получаем этого хеша


Если status:
SUCCESS
REVERSED
FAILED
PENDING
REJECTED
WAITING
CANCELED
просто надо показать что заказ уже конечном статусе

CREATED
HOLD_SUCCESS
VERIFICATION_FAILED
можно оплатит заказа клиент может оплатить если заказ только в этих статусах

PROCESS
BALANCE_WAITING
WARNED
то показать что оплата в процессе

Response sample (HTTP 200)

{
    "data": {
        "orderId": "5bea5474-8f5d-4454-b20d-f0a334343d1f",
        "serviceId": "43ddbe17-2aa1-4b99-8a9d-9fc83ed9dba5",
        "serviceName": "Smartcast Business1",
        "amount": 5000,
        "feeAmount": 0,
        "currency": "UZS",
        "serviceImageUrl": "https://s3.xonsaroypay.uz/ecom/business-1-1141661b-e35e-4f3b-bdb5-44f1e6ddf326.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ecom-user%2F20251017%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20251017T192545Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=de7f02a590a3bf80236b4ea33de6a577a6c022358a32496d710bf77d8457f811",
        "generatedPayUrl": "https://staging-checkout.xonsaroypay.uz/checkout/5bea5474-8f5d-4454-b20d-f0a334343d1f",
        "billingIdentifier": "order-1505",
        "lang": "RU",
        "returnUrl": "https://www.kun.uz",
        "paymentData": {
            "param": "value1"
        },
        "items": [
            {
                "id": 3,
                "fieldOrder": 0,
                "key": "billingIdentifier",
                "title": "Contract number",
                "isRequired": false,
                "type": "STRING",
                "fieldRegex": "^[a-zA-Z]+$",
                "placeholder": "BBxxxxxxx",
                "value": "ZE1239123"
            }
        ],
        "status": "CREATED"
    },
    "timestamp": 1760729145947
}

Response sample (HTTP 400)

{
    "data": {
        "message": "Операция запрещена.Для уточнения обратитесь в поддержку"
    },
    "timestamp": 1751276143988
}

OldingiCheckout API — to‘lov freymi
KeyingiPayment — kartadan yechish