ToAPIsToAPIs
Платежи

Список заказов пополнения

Постраничный список собственных заказов пополнения основного аккаунта

GET
/api/v1/billing/topups

Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.

Аутентификация, пагинация и ошибки описаны в разделе Подключение.

Поведение

Возвращает список пополнений аккаунта — для сверки платежей и зачислений. Только основной аккаунт может запрашивать свои счета: суб-аккаунт получает HTTP 403, а основной аккаунт не может запрашивать счета участников через этот эндпоинт.

Возвращает заказы пополнения по убыванию времени создания и ID заказа, по умолчанию последние 31 день, максимум 366 дней. recorded_payment_amount и payment_currency фиксируют сумму и валюту платежа и не используются для вычисления кредитов.

planned_credits — планируемое зачисление, credited_credits — подтверждённое, refunded_credits — возвраты отдельно, без вычитания из зачисления. У неуспешных заказов credited_credits="0". Исторически неподтверждаемые суммы — null (причины в meta).

Включаются только заказы TopUp. Ручные начисления и отдельные офлайн-возвраты исключены. refund=null не гарантирует отсутствие других возвратов, а локальный снимок возврата не означает поступление на карту. Эндпоинт не запрашивает платёжную платформу и не сверяет заказы.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. API-ключ модели не подходит. Заголовок X-User-Id не требуется.

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

fromstringзапрос

Начало диапазона включительно, RFC 3339 с часовым поясом. Передавайте вместе с to.

Ограничения: date-time.

tostringзапрос

Конец диапазона не включается, RFC 3339 с часовым поясом. Должен быть позже from.

Ограничения: date-time.

cursorstringзапрос

Передавайте предыдущий next_cursor без изменений и сохраняйте фильтры. При изменении условий начните заново.

Ограничения: maxLength=2048.

limitintegerзапроспо умолчанию: 20

Максимальное число элементов на странице.

Ограничения: minimum=1; maximum=100; По умолчанию: 20.

providerstringзапрос

Платежный провайдер.

Ограничения: stripe, wechat, alipay, creem, nowpayments, offline.

statusstringзапрос

Статус заказа: pending, success, superseded, expired, failed, partially_paid.

Ограничения: pending, success, superseded, expired, failed, partially_paid.

Примеры запросов

Пример запроса

curl --request GET \
  --url 'https://api.toapis.com/api/v1/billing/topups?from=2026-11-01T00:00:00Z&to=2026-11-02T00:00:00Z&provider=stripe&limit=20' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'
import requests

response = requests.get(
    "https://api.toapis.com/api/v1/billing/topups",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    params={
        "from": "2026-11-01T00:00:00Z",
        "to": "2026-11-02T00:00:00Z",
        "provider": "stripe",
        "limit": "20"
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())
const url = new URL("https://api.toapis.com/api/v1/billing/topups");
url.search = new URLSearchParams({
  "from": "2026-11-01T00:00:00Z",
  "to": "2026-11-02T00:00:00Z",
  "provider": "stripe",
  "limit": "20"
}).toString();

const response = await fetch(url, {
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Поля ответа

Данные примеров вымышлены и предполагают credits_per_usd="100". Используйте коэффициент из ответа API.

Результаты находятся в data.items. Используйте has_more и next_cursor для пагинации. Последний курсор равен null. Общее число записей не возвращается.

codeinteger

Числовой код результата; 0 означает успех.

messagestring

Сообщение ответа; пустое при успехе. Сообщения об ошибках локализуются.

dataobject

Объект результата текущего запроса.

data.itemsobject[]

Записи текущей страницы; [] при отсутствии результатов.

data.items[].idstring

Внутренний ID заказа пополнения. Для деталей используйте trade_no. Возвращается как десятичная строка ID.

data.items[].trade_nostring

Номер заказа пополнения платформы для деталей, не ID внешней платежной системы.

data.items[].providerstring

Провайдер платежных услуг.

data.items[].statusstring

Статус заказа пополнения. Подтвержденное зачисление относится только к успешным заказам.

data.items[].trigger_typestring | null

Способ запуска пополнения, например ручной или автоматический. Исторические значения могут быть null.

data.items[].created_atstring | null

Время создания. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.items[].completed_atstring | null

Время завершения заказа. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.items[].recorded_payment_amountstring | null

Сумма платежа в исходной валюте локального заказа. Валюта в payment_currency; credits из нее не выводятся. Десятичная строка для сохранения точности. null, если значение неизвестно или неприменимо.

data.items[].payment_currencystring | null

Исходная валюта платежа в заказе. null, если значение неизвестно или неприменимо.

data.items[].planned_creditsstring | null

Запланированные credits, не подтвержденное зачисление. Десятичная строка для сохранения точности. null, если значение неизвестно или неприменимо.

data.items[].credited_creditsstring | null

Подтвержденные credits. Неуспешные заказы дают "0", непроверенные исторические суммы равны null. Десятичная строка для сохранения точности.

data.items[].refunded_creditsstring | null

Возвращенные credits по заказу, отдельно без уменьшения исходного зачисления. Десятичная строка для сохранения точности. null, если значение неизвестно или неприменимо.

data.items[].refundobject | null

Локальный снимок возврата заказа. null не исключает отдельные офлайн-возвраты и не подтверждает получение на карту.

data.items[].refund.statusstring

Статус возврата, записанный в заказе.

data.items[].refund.recorded_amountstring | null

Сумма локального возврата в исходной валюте из поля currency. Десятичная строка для сохранения точности. null, если значение неизвестно или неприменимо.

data.items[].refund.currencystring | null

Исходная валюта сумм. null, если значение неизвестно или неприменимо.

data.items[].refund.recorded_atstring | null

Время локальной записи возврата. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.items[].metaobject

Метаданные об источнике, диапазоне и принципах учета.

data.items[].meta.sourcestring

Источник данных. Локальная конфигурация или реестр не означают актуальное состояние Stripe. Фиксированное значение: "local_ledger".

data.items[].meta.refund_coveragestring

Охват возвратов, ограниченный снимком возврата заказа. Фиксированное значение: "order_snapshot_only".

data.items[].meta.standalone_offline_refunds_includedboolean

Включены ли отдельные офлайн-возвраты. Сейчас false.

data.items[].meta.payment_amount_basisstring

Основа платежной суммы: локальный снимок заказа. Фиксированное значение: "local_order_snapshot".

data.items[].meta.consistencystring

Модель согласованности. eventual означает, что записи могут обновляться позже.

data.items[].meta.payment_amount_sourcestring

Источник записи для подтверждения суммы платежа.

data.items[].meta.credit_amount_sourcestring

Источник записи для подтверждения зачисленных средств.

data.has_moreboolean

Есть ли следующая страница.

data.next_cursorstring | null

Передавайте без изменений как cursor с теми же фильтрами. На последней странице равен null.

data.metaobject

Метаданные об источнике, диапазоне и принципах учета.

data.meta.sourcestring

Источник данных. Локальная конфигурация или реестр не означают актуальное состояние Stripe.

data.meta.scopestring

Область владельца данных: сам аутентифицированный аккаунт.

data.meta.fromstring

Начало временного диапазона включительно.

data.meta.tostring

Конец временного диапазона не включается.

data.meta.consistencystring

Модель согласованности. eventual означает, что записи могут обновляться позже.

data.meta.refund_coveragestring

Охват возвратов, ограниченный снимком возврата заказа.

data.meta.standalone_offline_refunds_includedboolean

Включены ли отдельные офлайн-возвраты. Сейчас false.

Примеры ответов

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "items": [
      {
        "id": "501",
        "trade_no": "trade_example_01",
        "provider": "stripe",
        "status": "success",
        "trigger_type": "manual",
        "created_at": "2026-11-01T08:00:00Z",
        "completed_at": "2026-11-01T08:01:00Z",
        "recorded_payment_amount": "10",
        "payment_currency": "USD",
        "planned_credits": "1000",
        "credited_credits": "1000",
        "refunded_credits": "0",
        "refund": null,
        "meta": {
          "source": "local_ledger",
          "consistency": "eventual",
          "payment_amount_basis": "local_order_snapshot",
          "refund_coverage": "order_snapshot_only",
          "standalone_offline_refunds_included": false,
          "payment_amount_source": "paid_amount",
          "credit_amount_source": "credited_credits"
        }
      }
    ],
    "has_more": false,
    "next_cursor": null,
    "meta": {
      "source": "local_ledger",
      "scope": "self",
      "from": "2026-11-01T00:00:00Z",
      "to": "2026-11-02T00:00:00Z",
      "consistency": "eventual",
      "refund_coverage": "order_snapshot_only",
      "standalone_offline_refunds_included": false
    }
  }
}