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

GETСписок заказов мерчанта

/v1/order/list

Возвращает заказы мерчанта постранично. Параметр status оставляет только заказы в указанном текущем статусе.

Запрос

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

curl -X GET '/v1/order/list?limit=20&offset=0' \
  --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/order/list?limit=20&offset=0', {
  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/order/list?limit=20&offset=0",
    cert=("client.pem", "client.key"),
    headers={
        "X-Request-ID": "string",
        "X-Signature": x_signature,
    },
)

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

Параметры

Параметры запроса

statusinteger

Фильтр по коду текущего статуса (см. /v1/dictionary/statuses)

int16
limitinteger

Размер страницы. При некорректном значении, значении <= 0 или превышении максимума (100) применяется значение по умолчанию.

≥ 1≤ 100по умолчанию 20
offsetinteger

Смещение. Отрицательное или некорректное значение трактуется как 0.

≥ 0по умолчанию 0

Заголовки

X-Request-IDstring

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

Ответы

Список заказов

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

X-Request-ID

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

200 · application/json
{
  "data": [
    {
      "id": "string",
      "merchant_id": 0,
      "payment_type": 0,
      "country": "string",
      "currency": "string",
      "method": "string",
      "bank_code": "string",
      "amount": "1500.00",
      "account_number": "string",
      "params": null,
      "last_status_code": 0,
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "metadata": {
    "object": "string",
    "version": "v1.0"
  },
  "request_id": "string"
}
Поля ответа
dataarray<Order>обязательное
idstringобязательное
uuid
merchant_idintegerобязательное
int64
payment_typeintegerобязательное
int32
countrystringобязательное
currencystringобязательное
methodstringобязательное
bank_codestringобязательное
amountMoneyобязательное

Сумма строкой, разделитель — точка, не более 2 знаков после неё. Запятая не допускается.

/^-?\d+(\.\d{1,2})?$/
account_numberstringобязательное
paramsobject | nullобязательное
last_status_codeintegerобязательное
int16
created_atUnixTimeобязательное

Unix-время в секундах

int64
updated_atUnixTimeобязательное

Unix-время в секундах

int64
order_idstring
descriptionstring
statusesarray<OrderStatus>
codeintegerобязательное
int16
created_atstringобязательное
date-time
reasonstring
last_status_reasonstring
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обязательное

Превышен лимит запросов, повторите позже

429 · application/json
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "retryable": true
  },
  "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-подпись запроса секретным ключом мерчанта.

Разделы