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Идентификатор запроса
{
"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"
}Нет клиентского сертификата (AUTH_MTLS_REQUIRED)
или подпись не прошла проверку (AUTH_HMAC_INVALID).
{
"error": {
"code": "AUTH_MTLS_REQUIRED",
"retryable": false
},
"request_id": "V1StGXR8_Z5jdHi6B-myT"
}Превышен лимит запросов, повторите позже
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"retryable": true
},
"request_id": "V1StGXR8_Z5jdHi6B-myT"
}Внутренняя ошибка
{
"error": {
"code": "INTERNAL_ERROR",
"detail": "seek technical assistance with request_id",
"retryable": false
},
"request_id": "V1StGXR8_Z5jdHi6B-myT"
}Доступ
mutualTLSmutualTLSКлиентский сертификат, выданный мерчанту при подключении.
X-SignatureapiKeyHMAC-подпись запроса секретным ключом мерчанта.