Other APIs for Agent | Bill Master Documentation

Получите все параметры агента.

get

Query parameters

agentId.equalsinteger · int64Optional

agentId.greaterThaninteger · int64Optional

agentId.greaterThanOrEqualinteger · int64Optional

agentId.ininteger · int64[]Optional

agentId.lessThaninteger · int64Optional

agentId.lessThanOrEqualinteger · int64Optional

agentId.notEqualsinteger · int64Optional

agentId.notIninteger · int64[]Optional

agentId.specifiedbooleanOptional

bankAccountPrefix.containsstringOptional

bankAccountPrefix.doesNotContainstringOptional

bankAccountPrefix.equalsstringOptional

bankAccountPrefix.instring[]Optional

bankAccountPrefix.notEqualsstringOptional

bankAccountPrefix.notInstring[]Optional

bankAccountPrefix.specifiedbooleanOptional

bankClientId.containsstringOptional

bankClientId.doesNotContainstringOptional

bankClientId.equalsstringOptional

bankClientId.instring[]Optional

bankClientId.notEqualsstringOptional

bankClientId.notInstring[]Optional

bankClientId.specifiedbooleanOptional

callBackUrl.containsstringOptional

callBackUrl.doesNotContainstringOptional

callBackUrl.equalsstringOptional

callBackUrl.instring[]Optional

callBackUrl.notEqualsstringOptional

callBackUrl.notInstring[]Optional

callBackUrl.specifiedbooleanOptional

id.equalsinteger · int64Optional

id.greaterThaninteger · int64Optional

id.greaterThanOrEqualinteger · int64Optional

id.ininteger · int64[]Optional

id.lessThaninteger · int64Optional

id.lessThanOrEqualinteger · int64Optional

id.notEqualsinteger · int64Optional

id.notIninteger · int64[]Optional

id.specifiedbooleanOptional

offsetinteger · int64Optional

pagedbooleanOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

password.containsstringOptional

password.doesNotContainstringOptional

password.equalsstringOptional

password.instring[]Optional

password.notEqualsstringOptional

password.notInstring[]Optional

password.specifiedbooleanOptional

sort.sortedbooleanOptional

sort.unsortedbooleanOptional

unpagedbooleanOptional

username.containsstringOptional

username.doesNotContainstringOptional

username.equalsstringOptional

username.instring[]Optional

username.notEqualsstringOptional

username.notInstring[]Optional

username.specifiedbooleanOptional

Responses

200

200 -> Список агентских параметров в теле.

*/*

401

Unauthorized

403

Forbidden

404

404 -> АгентПарамсДТО не найден

500

500 -> Внутренняя ошибка сервера

get

/api/agent-params

GET /api/agent-params HTTP/1.1
Host: localhost/
Accept: */*

[
  {
    "agent": {
      "active": true,
      "amountRatio": 1,
      "apiKey": "text",
      "createdBy": "text",
      "createdDate": "2026-01-28T05:34:25.943Z",
      "currencies": [
        1
      ],
      "email": "text",
      "id": 1,
      "inn": "text",
      "ipAddresses": [
        "text"
      ],
      "lastModifiedBy": "text",
      "lastModifiedDate": "2026-01-28T05:34:25.943Z",
      "logo": "text",
      "logoContentType": "text",
      "ord": 1,
      "orgName": "text",
      "phoneNumber": "text",
      "shortName": "text",
      "state": "ACTIVE",
      "titles": [
        {
          "id": 1,
          "lang": "EN",
          "text": "text"
        }
      ]
    },
    "bankAccountPrefix": "text",
    "bankClientId": "text",
    "callBackUrl": "text",
    "id": 1,
    "password": "text",
    "username": "text"
  }
]

Создайте новый агентParams

post

Body

Настройки для обратной связи с агентом

bankAccountPrefixstring · max: 64Optional

bankClientIdstring · min: 7 · max: 20Optional

callBackUrlstring · max: 512Required

Agent url to callback

idinteger · int64Optional

passwordstring · max: 128Optional

password

usernamestring · max: 128Optional

Username

Responses

200

OK

*/*

201

201 -> Указывает, что был создан новый AgentParams

400

400 -> Или со статусом 400, если у agentParams уже есть идентификатор

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent-params

POST /api/agent-params HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

Подсчитайте все параметры агента.

get

Query parameters

agentId.equalsinteger · int64Optional

agentId.greaterThaninteger · int64Optional

agentId.greaterThanOrEqualinteger · int64Optional

agentId.ininteger · int64[]Optional

agentId.lessThaninteger · int64Optional

agentId.lessThanOrEqualinteger · int64Optional

agentId.notEqualsinteger · int64Optional

agentId.notIninteger · int64[]Optional

agentId.specifiedbooleanOptional

bankAccountPrefix.containsstringOptional

bankAccountPrefix.doesNotContainstringOptional

bankAccountPrefix.equalsstringOptional

bankAccountPrefix.instring[]Optional

bankAccountPrefix.notEqualsstringOptional

bankAccountPrefix.notInstring[]Optional

bankAccountPrefix.specifiedbooleanOptional

bankClientId.containsstringOptional

bankClientId.doesNotContainstringOptional

bankClientId.equalsstringOptional

bankClientId.instring[]Optional

bankClientId.notEqualsstringOptional

bankClientId.notInstring[]Optional

bankClientId.specifiedbooleanOptional

callBackUrl.containsstringOptional

callBackUrl.doesNotContainstringOptional

callBackUrl.equalsstringOptional

callBackUrl.instring[]Optional

callBackUrl.notEqualsstringOptional

callBackUrl.notInstring[]Optional

callBackUrl.specifiedbooleanOptional

id.equalsinteger · int64Optional

id.greaterThaninteger · int64Optional

id.greaterThanOrEqualinteger · int64Optional

id.ininteger · int64[]Optional

id.lessThaninteger · int64Optional

id.lessThanOrEqualinteger · int64Optional

id.notEqualsinteger · int64Optional

id.notIninteger · int64[]Optional

id.specifiedbooleanOptional

password.containsstringOptional

password.doesNotContainstringOptional

password.equalsstringOptional

password.instring[]Optional

password.notEqualsstringOptional

password.notInstring[]Optional

password.specifiedbooleanOptional

username.containsstringOptional

username.doesNotContainstringOptional

username.equalsstringOptional

username.instring[]Optional

username.notEqualsstringOptional

username.notInstring[]Optional

username.specifiedbooleanOptional

Responses

200

200 -> Считай в теле

*/*

Responseinteger · int64

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

404 -> АгентПарамсДТО не найден

500

500 -> Внутренняя ошибка сервера

get

/api/agent-params/count

GET /api/agent-params/count HTTP/1.1
Host: localhost/
Accept: */*

Получите «id» agentParams

get

Path parameters

idinteger · int64Required

идентификатор agentParamsDTO для получение

Responses

200

200 -> со статусом 200 и с телом agentParamsDTO

*/*

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

404 -> АгентПарамсДТО не найден

500

500 -> Внутренняя ошибка сервера

get

/api/agent-params/{id}

GET /api/agent-params/{id} HTTP/1.1
Host: localhost/
Accept: */*

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

Обновляет существующий файл agentParams.

put

Path parameters

idinteger · int64Required

ид agentParamsDTO для обновления

Body

Настройки для обратной связи с агентом

bankAccountPrefixstring · max: 64Optional

bankClientIdstring · min: 7 · max: 20Optional

callBackUrlstring · max: 512Required

Agent url to callback

idinteger · int64Optional

passwordstring · max: 128Optional

password

usernamestring · max: 128Optional

Username

Responses

200

OK

*/*

201

200 -> указывает, что agentParamsDTO был обновлен

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

put

/api/agent-params/{id}

PUT /api/agent-params/{id} HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

Удалите «id» agentParams

delete

Path parameters

idinteger · int64Required

идентификатор agentParamsDTO для удаление

Responses

200

200 -> АгентПарамсДТО для удаления

No content

204

204 -> Со статусом нет контента

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

500

500 -> Внутренняя ошибка сервера

delete

/api/agent-params/{id}

DELETE /api/agent-params/{id} HTTP/1.1
Host: localhost/
Accept: */*

No content

Частичные обновления заданных полей существующего агентаParams, поле будет игнорироваться, если оно равно нулю

patch

Path parameters

idinteger · int64Required

идентификатор checkVerifierParam для обновления

Body

Настройки для обратной связи с агентом

bankAccountPrefixstring · max: 64Optional

bankClientIdstring · min: 7 · max: 20Optional

callBackUrlstring · max: 512Required

Agent url to callback

idinteger · int64Optional

passwordstring · max: 128Optional

password

usernamestring · max: 128Optional

Username

Responses

200

200 -> указывает, что agentParamsDTO был обновлен

*/*

204

No Content

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

404 -> АгентПарамсДТО не найден

500

500 -> Внутренняя ошибка сервера

patch

/api/agent-params/{id}

PATCH /api/agent-params/{id} HTTP/1.1
Host: localhost/
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 542

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

{
  "agent": {
    "active": true,
    "amountRatio": 1,
    "apiKey": "text",
    "createdBy": "text",
    "createdDate": "2026-01-28T05:34:25.943Z",
    "currencies": [
      1
    ],
    "email": "text",
    "id": 1,
    "inn": "text",
    "ipAddresses": [
      "text"
    ],
    "lastModifiedBy": "text",
    "lastModifiedDate": "2026-01-28T05:34:25.943Z",
    "logo": "text",
    "logoContentType": "text",
    "ord": 1,
    "orgName": "text",
    "phoneNumber": "text",
    "shortName": "text",
    "state": "ACTIVE",
    "titles": [
      {
        "id": 1,
        "lang": "EN",
        "text": "text"
      }
    ]
  },
  "bankAccountPrefix": "text",
  "bankClientId": "text",
  "callBackUrl": "text",
  "id": 1,
  "password": "text",
  "username": "text"
}

Отмена транзакции (V3)

post

Body

agentTranIdstringOptional

billIdinteger · int64Optional

tranIdinteger · int64Optional

Responses

200

200 -> Указывает, что транзакция была отменена (V3)

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/cancel/v3

POST /api/agent/cancel/v3 HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "agentTranId": "text",
  "billId": 1,
  "tranId": 1
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка счета перед оплатой, создаст чек

post

Body

accountstringOptional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentParamsobjectOptional

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

paramsobjectOptional

Доп. параметры

recipientIdinteger · int64Optional

Ид. получателя

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Перед оплатой счет был проверен, создана квитанция

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check

POST /api/agent/check HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentParams": {},
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "params": {},
  "recipientId": 1,
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка счета перед оплатой, создаст чек (V3)

post

Body

accountstringOptional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentNamestringOptional

agentParamsobjectOptional

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

paramsobjectOptional

Доп. параметры

recipientIdinteger · int64Optional

Ид. получателя

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Перед оплатой счет был проверен, создана квитанция (V3)

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check/sub

POST /api/agent/check/sub HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentName": "text",
  "agentParams": {},
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "params": {},
  "recipientId": 1,
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка номера карты для снятие средств

post

Создается чек и отправляется код подтверждение

Body

accountstring · max: 64Optional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

expirystringOptional

Срок действие карты, формат : yyMM

paramsobjectOptional

Доп. параметры

Example: {"myCustomId":"123"}

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Указывает, что номер карты подтвержден, Указывает, что чек был создан и проверочный код был отправлен

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check/uzcard-debit

POST /api/agent/check/uzcard-debit HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "expiry": "text",
  "params": {
    "myCustomId": "123"
  },
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка счета перед оплатой, создаст чек (V2)

post

Body

accountstringOptional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentParamsobjectOptional

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

paramsobjectOptional

Доп. параметры

recipientIdinteger · int64Optional

Ид. получателя

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Перед оплатой счет был проверен, создана квитанция (V2)

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check/v2

POST /api/agent/check/v2 HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentParams": {},
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "params": {},
  "recipientId": 1,
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка счета перед оплатой, создаст чек (V3)

post

Body

accountstringOptional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentNamestringOptional

agentParamsobjectOptional

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

paramsobjectOptional

Доп. параметры

recipientIdinteger · int64Optional

Ид. получателя

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Перед оплатой счет был проверен, создана квитанция (V3)

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check/v3

POST /api/agent/check/v3 HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentName": "text",
  "agentParams": {},
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "params": {},
  "recipientId": 1,
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка счета перед оплатой, создаст чек (V4)

post

Body

accountstringOptional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentParamsobjectOptional

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

paramsobjectOptional

Доп. параметры

recipientIdinteger · int64Optional

Ид. получателя

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Перед оплатой счет был проверен, создана квитанция (V4)

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check/v4

POST /api/agent/check/v4 HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentParams": {},
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "params": {},
  "recipientId": 1,
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Проверка счета перед оплатой, создаст чек

post

Path parameters

recipientNamestringRequired

recipientName

Body

accountstring · max: 64Optional

Лицевой счет

Example: Номер телефона, номер кошелка, ...

agentTranIdstringOptional

Ид. транзакции агента

amountinteger · int64Optional

Сумма платежа

currencyinteger · int32Optional

Валюта, трёхзначный цифровой ISO 4217

Example: 860 - Узбекский сум, 840 - Доллар США

paramsobjectOptional

Доп. параметры

Example: {"myCustomId":"123"}

requestGroupstringOptional

Группа транзакции

requestSubGroupstringOptional

Под группа транзакции

Responses

200

200 -> Перед оплатой счет был проверен, создана квитанция

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/check/{recipientName}

POST /api/agent/check/{recipientName} HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "account": "Номер телефона, номер кошелка, ...",
  "agentTranId": "text",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "params": {
    "myCustomId": "123"
  },
  "requestGroup": "text",
  "requestSubGroup": "text"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Баланс агента

post

Responses

200

200 -> Возвращает баланс агента

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/deposit/agent

POST /api/agent/deposit/agent HTTP/1.1
Host: localhost/
Accept: */*

{
  "balance": 1,
  "contactGroup": "text",
  "limitDisable": 1,
  "limitInform": 1,
  "overdraftLimit": 1
}

Баланс агента 2

get

Path parameters

shortNamestringRequired

должно быть указано краткое имя агента

Responses

200

200 -> Возвращает баланс агента V2

*/*

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

get

/api/agent/deposit/agent/{shortName}

GET /api/agent/deposit/agent/{shortName} HTTP/1.1
Host: localhost/
Accept: */*

{
  "balance": 1,
  "contactGroup": "text",
  "limitDisable": 1,
  "limitInform": 1,
  "overdraftLimit": 1
}

Список ошибок

post

Responses

200

200 -> Указывает, что получен список ошибок

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/errors

POST /api/agent/errors HTTP/1.1
Host: localhost/
Accept: */*

[
  {
    "detail": "text",
    "instance": "https://example.com",
    "status": "ACCEPTED",
    "title": "text",
    "type": "https://example.com"
  }
]

Список ошибок

post

Responses

200

200 -> Указывает, что получен список ошибок

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/errors/v3

POST /api/agent/errors/v3 HTTP/1.1
Host: localhost/
Accept: */*

[
  {
    "detail": "text",
    "instance": "https://example.com",
    "status": "ACCEPTED",
    "title": "text",
    "type": "https://example.com"
  }
]

Получение лого поставщика

get

Path parameters

fileUuidstringRequired

UUID файла

Responses

200

200 -> Указывает на получение логотипа поставщика

*/*

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

get

/api/agent/file/{fileUuid}

GET /api/agent/file/{fileUuid} HTTP/1.1
Host: localhost/
Accept: */*

{
  "description": "text",
  "file": "text",
  "filename": "text",
  "inputStream": {},
  "open": true,
  "readable": true,
  "uri": "https://example.com",
  "url": "text"
}

Получение истории карт Uzcard юр. лиц (V3)

post

Body

cardIdsstring[]Optional

Массив идентификаторов карт

Example: 1.2345678901234569e+27

pageNumberinteger · int32Optional

Номер страницы

pageSizeinteger · int32Optional

Количество транзакций на странице

Example: 20

Responses

200

200 -> Uzcard относится к легальному приобретению карточной истории

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/history/trusted

POST /api/agent/history/trusted HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "cardIds": 1.2345678901234569e+27,
  "pageNumber": 0,
  "pageSize": 20,
  "range": {
    "endDate": 20200310,
    "startDate": 20200310
  }
}

{
  "code": 1,
  "data": {
    "content": [
      {
        "acctbal": 11093,
        "actamt": 7114146,
        "bankDate": 20200413,
        "city": "Ташкент",
        "createDate": "2026-01-28T05:34:25.943Z",
        "currency": 860,
        "desc": "Оплата за коммунальные услуги",
        "hpan": 8600123456781234,
        "isCredit": true,
        "mcc": 6010,
        "merchant": 552488,
        "merchantName": "OOO Devops",
        "orgdev": 45678,
        "reqamt": 7114146,
        "resp": 0,
        "reversal": false,
        "stan": 123456,
        "street": "Амир Темур 107",
        "terminal": 23456,
        "tranDate": "2026-01-28T05:34:25.943Z",
        "tranType": "DEBIT",
        "transType": 683,
        "udate": 20200428,
        "utime": 164148,
        "utrnno": 65234354524323
      }
    ],
    "first": true,
    "last": true,
    "number": 1,
    "numberOfElements": 1,
    "size": 1,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "totalCredit": 1,
    "totalDebit": 1,
    "totalElements": 1,
    "totalPages": 1
  },
  "details": {},
  "message": "text",
  "success": true,
  "timeout": true
}

Получение истории карт Uzcard юр. лиц (V3)

post

Body

cardIdsstring[]Optional

Массив идентификаторов карт

Example: 1.2345678901234569e+27

pageNumberinteger · int32Optional

Номер страницы

pageSizeinteger · int32Optional

Количество транзакций на странице

Example: 20

Responses

200

200 -> Uzcard относится к легальному приобретению карточной истории (V2)

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/history2/trusted

POST /api/agent/history2/trusted HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "cardIds": 1.2345678901234569e+27,
  "pageNumber": 0,
  "pageSize": 20,
  "range": {
    "endDate": 20200310,
    "startDate": 20200310
  }
}

{
  "code": 1,
  "data": {
    "content": [
      {
        "acctbal": 11093,
        "actamt": 7114146,
        "bankDate": 20200413,
        "city": "Ташкент",
        "createDate": "2026-01-28T05:34:25.943Z",
        "currency": 860,
        "desc": "Оплата за коммунальные услуги",
        "hpan": 8600123456781234,
        "isCredit": true,
        "mcc": 6010,
        "merchant": 552488,
        "merchantName": "OOO Devops",
        "orgdev": 45678,
        "reqamt": 7114146,
        "resp": 0,
        "reversal": false,
        "stan": 123456,
        "street": "Амир Темур 107",
        "terminal": 23456,
        "tranDate": "2026-01-28T05:34:25.943Z",
        "tranType": "DEBIT",
        "transType": 683,
        "udate": 20200428,
        "utime": 164148,
        "utrnno": 65234354524323
      }
    ],
    "first": true,
    "last": true,
    "number": 1,
    "numberOfElements": 1,
    "size": 1,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "totalCredit": 1,
    "totalDebit": 1,
    "totalElements": 1,
    "totalPages": 1
  },
  "details": {},
  "message": "text",
  "success": true,
  "timeout": true
}

Холдирование

post

Body

agentParamsobjectOptional

Доп. агентские параметры. Не сохраняются

amountinteger · int64Optional

Сумма платежа

billIdinteger · int64Optional

Номер платежа в системе

paramsobjectOptional

Доп. параметры

tingIdinteger · int64Optional

typestring · enumOptional

Тип платежа

Possible values:

Responses

200

200 -> Указывает, что он находится на удержании для агента

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/hold/v2/

POST /api/agent/hold/v2/ HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "agentParams": {},
  "amount": 1,
  "billId": 1,
  "params": {},
  "tingId": 1,
  "type": "AGENT"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Подтверждений холдирование

post

Body

agentParamsobjectOptional

Доп. агентские параметры. Не сохраняются

amountinteger · int64Optional

Сумма платежа

billIdinteger · int64Optional

Номер платежа в системе

paramsobjectOptional

Доп. параметры

tingIdinteger · int64Optional

typestring · enumOptional

Тип платежа

Possible values:

Responses

200

200 -> Холдирование подтвержденный

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/hold/v2/confirm

POST /api/agent/hold/v2/confirm HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "agentParams": {},
  "amount": 1,
  "billId": 1,
  "params": {},
  "tingId": 1,
  "type": "AGENT"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

Холдирование сверху

post

Body

agentParamsobjectOptional

Доп. агентские параметры. Не сохраняются

amountinteger · int64Optional

Сумма платежа

billIdinteger · int64Optional

Номер платежа в системе

paramsobjectOptional

Доп. параметры

tingIdinteger · int64Optional

typestring · enumOptional

Тип платежа

Possible values:

Responses

200

200 -> Указывает на большее удержани

*/*

201

Created

400

400 -> АгентПарамсДТО недействителен

401

Unauthorized

403

Forbidden

404

Not Found

500

500 -> Внутренняя ошибка сервера

post

/api/agent/hold/v2/more

POST /api/agent/hold/v2/more HTTP/1.1
Host: localhost/
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "agentParams": {},
  "amount": 1,
  "billId": 1,
  "params": {},
  "tingId": 1,
  "type": "AGENT"
}

{
  "account": "Номер телефона, номер кошелка, ...",
  "amount": 1,
  "currency": "860 - Узбекский сум, 840 - Доллар США",
  "data": {
    "задолжность": "123"
  },
  "extId": "abc123",
  "gatewayName": "text",
  "id": 1,
  "receiver": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "recipientShortName": "text",
  "requestTime": "2026-01-28T05:34:25.943Z",
  "responseText": "text",
  "responseTime": "2026-01-28T05:34:25.943Z",
  "sender": {
    "amount": 1,
    "commission": 1,
    "commissionAmount": 1,
    "currency": 1,
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text"
  },
  "sessionId": "text",
  "status": "CANCELLED",
  "success": true
}

hashtagПолучите все параметры агента.

hashtagСоздайте новый агентParams

hashtagПодсчитайте все параметры агента.

hashtagПолучите «id» agentParams

hashtagОбновляет существующий файл agentParams.

hashtagУдалите «id» agentParams

hashtagЧастичные обновления заданных полей существующего агентаParams, поле будет игнорироваться, если оно равно нулю

hashtagОтмена транзакции (V3)

hashtagПроверка счета перед оплатой, создаст чек

hashtagПроверка счета перед оплатой, создаст чек (V3)

hashtagПроверка номера карты для снятие средств

hashtagПроверка счета перед оплатой, создаст чек (V2)

hashtagПроверка счета перед оплатой, создаст чек (V3)

hashtagПроверка счета перед оплатой, создаст чек (V4)

hashtagПроверка счета перед оплатой, создаст чек

hashtagБаланс агента

hashtagБаланс агента 2

hashtagСписок ошибок

hashtagСписок ошибок

hashtagПолучение лого поставщика

hashtagПолучение истории карт Uzcard юр. лиц (V3)

hashtagПолучение истории карт Uzcard юр. лиц (V3)

hashtagХолдирование

hashtagПодтверждений холдирование

hashtagХолдирование сверху

Получите все параметры агента.

Создайте новый агентParams

Подсчитайте все параметры агента.

Получите «id» agentParams

Обновляет существующий файл agentParams.

Удалите «id» agentParams

Частичные обновления заданных полей существующего агентаParams, поле будет игнорироваться, если оно равно нулю

Отмена транзакции (V3)

Проверка счета перед оплатой, создаст чек

Проверка счета перед оплатой, создаст чек (V3)

Проверка номера карты для снятие средств

Проверка счета перед оплатой, создаст чек (V2)

Проверка счета перед оплатой, создаст чек (V3)

Проверка счета перед оплатой, создаст чек (V4)

Проверка счета перед оплатой, создаст чек

Баланс агента

Баланс агента 2

Список ошибок

Список ошибок

Получение лого поставщика

Получение истории карт Uzcard юр. лиц (V3)

Получение истории карт Uzcard юр. лиц (V3)

Холдирование

Подтверждений холдирование

Холдирование сверху