API Docs
Версия API
версия 1.0

GETПричины статусов

/v1/dictionary/reasons

Возвращает справочник причин статусов заказа.

Запрос

# X-Signature: HMAC-подпись запроса секретным ключом мерчанта.
X_SIGNATURE='…'

curl -X GET '/v1/dictionary/reasons' \
  --cert client.pem --key client.key \
  -H 'X-Request-ID: string' \
  -H "X-Signature: $X_SIGNATURE"
import { readFileSync } from 'node:fs';
import { request } from 'node:https';

// X-Signature: HMAC-подпись запроса секретным ключом мерчанта.
const xSignature = '…';

const req = request('/v1/dictionary/reasons', {
  method: 'GET',
  cert: readFileSync('client.pem'),
  key: readFileSync('client.key'),
  headers: {
    'X-Request-ID': 'string',
    'X-Signature': xSignature,
  },
});

req.on('response', (res) => {
  const chunks = [];
  res.on('data', (chunk) => chunks.push(chunk));
  res.on('end', () => {
    console.log(res.statusCode, JSON.parse(Buffer.concat(chunks).toString()));
  });
});

req.end();

import requests

# X-Signature: HMAC-подпись запроса секретным ключом мерчанта.
x_signature = "…"

response = requests.request(
    "GET",
    "/v1/dictionary/reasons",
    cert=("client.pem", "client.key"),
    headers={
        "X-Request-ID": "string",
        "X-Signature": x_signature,
    },
)

print(response.status_code, response.json())

Параметры

Заголовки

X-Request-IDstring

Идентификатор запроса для трассировки. Генерируется сервером, если не передан.

Ответы

Причины

Заголовки ответа

X-Request-ID

Идентификатор запроса

200 · application/json
{
  "data": [
    {
      "code": "string",
      "name": "string",
      "is_retryable": true
    }
  ],
  "metadata": {
    "object": "string",
    "version": "v1.0"
  },
  "request_id": "string"
}
Поля ответа
dataarray<Reason>обязательное
codestringобязательное
namestringобязательное
is_retryablebooleanобязательное
metadataMetadataобязательное
objectstringобязательное

Тип объекта в data

versionstringобязательное
quantityinteger

Количество элементов (для списков; не передаётся, если 0)

has_moreboolean
next_cursorstring
request_idstringобязательное

Нет клиентского сертификата (AUTH_MTLS_REQUIRED) или подпись не прошла проверку (AUTH_HMAC_INVALID).

401 · application/json
{
  "error": {
    "code": "AUTH_MTLS_REQUIRED",
    "retryable": false
  },
  "request_id": "V1StGXR8_Z5jdHi6B-myT"
}
Поля ответа
errorobjectобязательное
codestringобязательное
"AUTH_MTLS_REQUIRED""AUTH_HMAC_INVALID""RATE_LIMIT_EXCEEDED""VALIDATION_ERROR""BAD_REQUEST""INTERNAL_ERROR"
retryablebooleanобязательное

Имеет ли смысл повторить запрос без изменений

detailstring
request_idstringобязательное

Внутренняя ошибка

500 · application/json
{
  "error": {
    "code": "INTERNAL_ERROR",
    "detail": "seek technical assistance with request_id",
    "retryable": false
  },
  "request_id": "V1StGXR8_Z5jdHi6B-myT"
}
Поля ответа
errorobjectобязательное
codestringобязательное
"AUTH_MTLS_REQUIRED""AUTH_HMAC_INVALID""RATE_LIMIT_EXCEEDED""VALIDATION_ERROR""BAD_REQUEST""INTERNAL_ERROR"
retryablebooleanобязательное

Имеет ли смысл повторить запрос без изменений

detailstring
request_idstringобязательное

Доступ

mutualTLSmutualTLS

Клиентский сертификат, выданный мерчанту при подключении.

X-SignatureapiKey

HMAC-подпись запроса секретным ключом мерчанта.

Разделы