ApiScoring APIСправочник
Схемы
Поля запросов и ответов — сводка; источник истины openapi.yaml
Схемы
Источник истины — openapi.yaml (OpenAPI 3.1). Эта страница — сводка полей для быстрого поиска.
ScoreRequest
POST /v1/client/score
| Поле | Тип | Обяз. | Ограничения |
|---|---|---|---|
sellPointKey | string | да | 1..256 |
clientIdKey | string | да | 1..256 |
amountRequested | decimal-string | да | ^\d+(\.\d+)?$ |
toPayCurrency | string | нет | 3..4 символа |
selectedMethodKey | string | да | 1..256 |
fingerprint | string | нет | ≤256 |
ip | string | нет | ≤64 |
userAgent | string | нет | ≤512 |
clientHints | object | нет | {jsOk?, honeypotTriggered?} |
ScoreResponse
| Поле | Тип | Обяз. | Примечание |
|---|---|---|---|
clientGroup | enum | да | NEW, STICKY, PAYING, TRUSTED, BLOCKED |
paymentScore | string | да | 4 знака, 0.5000 для нового |
isBot | boolean | да | |
preferredAcceptorKey | string[] | нет | только STICKY |
payLimitValue | array | нет | score-based лимиты платформы |
VerdictRequest
POST /v1/client/verdict
| Поле | Тип | Обяз. | Ограничения |
|---|---|---|---|
sellPointKey | string | да | 1..256 |
clientIdKey | string | да | 1..256 |
method | string | да | 1..256 |
amountRequested | decimal-string | да | ^\d+(\.\d+)?$ |
toPayCurrency | string | нет | 3..4 символа |
orderRef | string | да | 1..256 |
VerdictResponse
| Поле | Тип | Обяз. | Примечание |
|---|---|---|---|
verdict | enum | да | GET_SAME_STICKY, GET_NEW, WAIT, BLOCK |
waitSeconds | int64 | нет | только с WAIT |
stickyRequisiteRef | string | нет | только с GET_SAME_STICKY |
reason | string | да | свободная форма, не для матчинга |
ruleVersion | string | да | сейчас p2.v10 |
isBot | boolean | да |
ErrorEnvelope
Любой неуспешный ответ (обёртка RFC 9457 точки публикации):
| Поле | Тип | Обяз. | Примечание |
|---|---|---|---|
title | string | да | короткая HTTP-причина |
status | integer | да | дублирует код ответа |
detail | string | да | JSON-строка с KA-текстом {"message": "..."} |
type | string | нет | |
instance | string | нет | путь публикации |