Статусы и баланс — документация API

[01]

Два ID, одна заявка

Скачать только статусы заявок · JSON ↓ · Статусы заявок в загрузках →

Идентификатор	Источник	Используйте
`externalTransactionId`	Ваш исходный запрос создания	Поиск по ID мерчанта; восстановление после создания с неизвестным результатом.
`externalId`	Ответ PayStar на создание	Поиск принятой заявки по ID PayStar.

Значения статусов

Сценарий	В процессе	Результат и окончательность
Пополнение	Init · Created · Processing	`Success` · `Failed` ⚠️ Для пополнений P2P статус `Failed` может быть изменён после обращения.
Выплата	Created · Processing	`Success` · `Failed`

[02]

Пополнение по ID мерчанта

GEThttps://secure.paystar.uk/api/v1/integration/deposit-order/{externalTransactionId}/status-by-external-transaction-id

Получите текущий статус пополнения по вашему исходному externalTransactionId из запроса создания. Поместите этот ID заявки мерчанта в путь URL.

Запрос и пример

Параметр	Обязательность	Значение
`externalTransactionId`	Обязательно · путь	Внешний идентификатор транзакции, созданный мерчантом.

cURLВыделите текст для копирования

curl --request GET \
  --url 'https://secure.paystar.uk/api/v1/integration/deposit-order/UNIQUE_MERCHANT_ID/status-by-external-transaction-id' \
  --header 'Authorization: Bearer <PAYSTAR_DEPOSIT_PROFILE_TOKEN>'

Успешный ответ

Поле	Обязательность	Тип и значение
`externalId`	Обязательно	`string`
`orderStatus`	Обязательно	`string · Init / Created / Processing / Success / Failed` Текущее состояние заявки на пополнение. Исключение P2P (P2P-STATE-001, подтверждено владельцем API 2026-09-10): Failed не является безусловно окончательным; та же заявка с неизменными идентификаторами может быть исправлена на Success, обычно по инициативе поддержки мерчанта. Мерчант должен обработать соответствующее обновление callback. Обратный бизнес-переход Success-to-Failed реализовывать не требуется. Это не меняет другие сценарии пополнения, не вводит новые статусы, не определяет гарантии доставки callback и не требует бесконечного опроса.
`amount`	Необязательно	`number` Сумма в основных единицах валюты. Нормативный тип — JSON number; числовые строки в кавычках сохраняются для обратной совместимости. Обычные запросы и показанные примеры используют два знака после запятой. Минимумы/максимумы конкретного сценария задаются в маршрутизации. exclusiveMinimum: 0 Amount
`externalParams`	Необязательно	`object` Объект зависит от сценария; может отсутствовать или содержать поля null. ExternalParams
`currency`	Необязательно	`string` Ключ валюты пополнения, например ARS. Поле ответа подтверждено примерами владельца API; универсальное наличие отдельно не установлено. Ограничение только alpha-3 не вводится. CurrencyCode
`orderHistory`	Обязательно	`array of object` Обязательная непустая история платежа: минимум один элемент в ответах статуса пополнения по ID мерчанта или PayStar (подтверждено владельцем API 2026-09-11). Текущее состояние определяйте по orderStatus. Непустая история не гарантирует полный след событий. minItems: 1 Справочник истории платежей →

Оба метода возвращают одинаковую структуру ответа пополнения. Примеры ниже включают валюту и непустую историю. Время — UTC; в переданных значениях протокола отсутствует суффикс часового пояса. См. примечание о формате времени.

Пополнение Success — пример ответаОт владельца API · обезличено

JSONВыделите текст для копирования

{
  "externalId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "orderStatus": "Success",
  "externalParams": {
    "cardToken": null,
    "cardStorageToken": null,
    "cardHolder": null,
    "cardNumber": null
  },
  "amount": 10000.00,
  "currency": "ARS",
  "orderHistory": [
    {
      "time": "2026-09-11T10:52:47.141614",
      "action": "1.1.2.0",
      "newCode": "1.1.2.00"
    },
    {
      "time": "2026-09-11T10:52:49.157749",
      "action": "2.1.0.0",
      "newCode": "2.1.1.00"
    },
    {
      "time": "2026-09-11T10:55:05.563194",
      "action": "4.1.0.0",
      "newCode": "4.1.3.XX"
    }
  ]
}

Пополнение Failed — пример ответаОт владельца API · обезличено

JSONВыделите текст для копирования

{
  "externalId": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
  "orderStatus": "Failed",
  "externalParams": {
    "cardToken": null,
    "cardStorageToken": null,
    "cardHolder": null,
    "cardNumber": null
  },
  "amount": 26250.00,
  "currency": "ARS",
  "orderHistory": [
    {
      "time": "2026-09-11T10:30:43.941409",
      "action": "1.2.1.1",
      "newCode": "1.1.4.32"
    }
  ]
}

HTTP-результаты

HTTP	Значение
`200`	Текущее состояние заявки.
`401`	Отсутствует или недействителен Bearer-токен.
`403`	Ключ действителен, но не имеет доступа к этому ресурсу.
`404`	Заявка не найдена. BusinessError и обработка
`500`	Внутренняя ошибка сервера.

Технические сведения

Operation ID: getDepositStatusByMerchantId

Это имя операции OpenAPI для инструментов разработки и генераторов кода. Оно не является ID заявки или параметром запроса: не передавайте его в URL, заголовках или теле запроса.

[03]

Пополнение по ID PayStar

GEThttps://secure.paystar.uk/api/v1/integration/deposit-order/{externalId}/status

Получите текущий статус пополнения по идентификатору PayStar externalId из ответа создания заявки. Поместите этот ID заявки PayStar в путь URL.

Запрос и пример

Параметр	Обязательность	Значение
`externalId`	Обязательно · путь	Идентификатор заявки PayStar, возвращённый при создании.

cURLВыделите текст для копирования

curl --request GET \
  --url 'https://secure.paystar.uk/api/v1/integration/deposit-order/PAYSTAR_ORDER_ID/status' \
  --header 'Authorization: Bearer <PAYSTAR_DEPOSIT_PROFILE_TOKEN>'

Успешный ответ

Поле	Обязательность	Тип и значение
`externalId`	Обязательно	`string`
`orderStatus`	Обязательно	`string · Init / Created / Processing / Success / Failed` Текущее состояние заявки на пополнение. Исключение P2P (P2P-STATE-001, подтверждено владельцем API 2026-09-10): Failed не является безусловно окончательным; та же заявка с неизменными идентификаторами может быть исправлена на Success, обычно по инициативе поддержки мерчанта. Мерчант должен обработать соответствующее обновление callback. Обратный бизнес-переход Success-to-Failed реализовывать не требуется. Это не меняет другие сценарии пополнения, не вводит новые статусы, не определяет гарантии доставки callback и не требует бесконечного опроса.
`amount`	Необязательно	`number` Сумма в основных единицах валюты. Нормативный тип — JSON number; числовые строки в кавычках сохраняются для обратной совместимости. Обычные запросы и показанные примеры используют два знака после запятой. Минимумы/максимумы конкретного сценария задаются в маршрутизации. exclusiveMinimum: 0 Amount
`externalParams`	Необязательно	`object` Объект зависит от сценария; может отсутствовать или содержать поля null. ExternalParams
`currency`	Необязательно	`string` Ключ валюты пополнения, например ARS. Поле ответа подтверждено примерами владельца API; универсальное наличие отдельно не установлено. Ограничение только alpha-3 не вводится. CurrencyCode
`orderHistory`	Обязательно	`array of object` Обязательная непустая история платежа: минимум один элемент в ответах статуса пополнения по ID мерчанта или PayStar (подтверждено владельцем API 2026-09-11). Текущее состояние определяйте по orderStatus. Непустая история не гарантирует полный след событий. minItems: 1 Справочник истории платежей →

Оба метода возвращают одинаковую структуру ответа пополнения. Примеры ниже включают валюту и непустую историю. Время — UTC; в переданных значениях протокола отсутствует суффикс часового пояса. См. примечание о формате времени.

Пополнение Success — пример ответаОт владельца API · обезличено

JSONВыделите текст для копирования

{
  "externalId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "orderStatus": "Success",
  "externalParams": {
    "cardToken": null,
    "cardStorageToken": null,
    "cardHolder": null,
    "cardNumber": null
  },
  "amount": 10000.00,
  "currency": "ARS",
  "orderHistory": [
    {
      "time": "2026-09-11T10:52:47.141614",
      "action": "1.1.2.0",
      "newCode": "1.1.2.00"
    },
    {
      "time": "2026-09-11T10:52:49.157749",
      "action": "2.1.0.0",
      "newCode": "2.1.1.00"
    },
    {
      "time": "2026-09-11T10:55:05.563194",
      "action": "4.1.0.0",
      "newCode": "4.1.3.XX"
    }
  ]
}

Пополнение Failed — пример ответаОт владельца API · обезличено

JSONВыделите текст для копирования

{
  "externalId": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
  "orderStatus": "Failed",
  "externalParams": {
    "cardToken": null,
    "cardStorageToken": null,
    "cardHolder": null,
    "cardNumber": null
  },
  "amount": 26250.00,
  "currency": "ARS",
  "orderHistory": [
    {
      "time": "2026-09-11T10:30:43.941409",
      "action": "1.2.1.1",
      "newCode": "1.1.4.32"
    }
  ]
}

HTTP-результаты

HTTP	Значение
`200`	Текущее состояние заявки.
`401`	Отсутствует или недействителен Bearer-токен.
`403`	Ключ действителен, но не имеет доступа к этому ресурсу.
`404`	Заявка не найдена. BusinessError и обработка
`500`	Внутренняя ошибка сервера.

Технические сведения

Operation ID: getDepositStatusByPayStarId

Это имя операции OpenAPI для инструментов разработки и генераторов кода. Оно не является ID заявки или параметром запроса: не передавайте его в URL, заголовках или теле запроса.

[04]

Выплата по ID мерчанта

GEThttps://secure.paystar.uk/api/v1/integration/withdrawal-order/{externalTransactionId}/status-by-external-transaction-id

Получите текущий статус выплаты по вашему исходному externalTransactionId из запроса создания. Поместите этот ID заявки мерчанта в путь URL.

Запрос и пример

Параметр	Обязательность	Значение
`externalTransactionId`	Обязательно · путь	Внешний идентификатор транзакции, созданный мерчантом.

cURLВыделите текст для копирования

curl --request GET \
  --url 'https://secure.paystar.uk/api/v1/integration/withdrawal-order/UNIQUE_MERCHANT_ID/status-by-external-transaction-id' \
  --header 'Authorization: Bearer <PAYSTAR_PAYOUT_TOKEN>'

Успешный ответ

Поле	Обязательность	Тип и значение
`externalId`	Обязательно	`string`
`orderStatus`	Обязательно	`string · Created / Processing / Success / Failed`
`amount`	Необязательно	`number` Сумма в основных единицах валюты. Нормативный тип — JSON number; числовые строки в кавычках сохраняются для обратной совместимости. Обычные запросы и показанные примеры используют два знака после запятой. Минимумы/максимумы конкретного сценария задаются в маршрутизации. exclusiveMinimum: 0 Amount
`externalParams`	Необязательно	`object` Объект зависит от сценария; может отсутствовать или содержать поля null. ExternalParams
`orderHistory`	Необязательно	`array of object` Заполнение не гарантируется и может запаздывать.

JSONВыделите текст для копирования

{
  "externalId": "<PAYSTAR_ORDER_ID>",
  "orderStatus": "Success",
  "amount": 100,
  "orderHistory": []
}

Описание полей orderHistory и кодов истории: Справочник истории платежей →.

HTTP-результаты

HTTP	Значение
`200`	Текущее состояние заявки.
`401`	Отсутствует или недействителен Bearer-токен.
`403`	Ключ действителен, но не имеет доступа к этому ресурсу.
`404`	Заявка не найдена. BusinessError и обработка
`500`	Внутренняя ошибка сервера.

Технические сведения

Operation ID: getPayoutStatusByMerchantId

Это имя операции OpenAPI для инструментов разработки и генераторов кода. Оно не является ID заявки или параметром запроса: не передавайте его в URL, заголовках или теле запроса.

[05]

Выплата по ID PayStar

GEThttps://secure.paystar.uk/api/v1/integration/withdrawal-order/{externalId}/status

Получите текущий статус выплаты по идентификатору PayStar externalId из ответа создания заявки. Поместите этот ID заявки PayStar в путь URL.

Запрос и пример

Параметр	Обязательность	Значение
`externalId`	Обязательно · путь	Идентификатор заявки PayStar, возвращённый при создании.

cURLВыделите текст для копирования

curl --request GET \
  --url 'https://secure.paystar.uk/api/v1/integration/withdrawal-order/PAYSTAR_ORDER_ID/status' \
  --header 'Authorization: Bearer <PAYSTAR_PAYOUT_TOKEN>'

Успешный ответ

Поле	Обязательность	Тип и значение
`externalId`	Обязательно	`string`
`orderStatus`	Обязательно	`string · Created / Processing / Success / Failed`
`amount`	Необязательно	`number` Сумма в основных единицах валюты. Нормативный тип — JSON number; числовые строки в кавычках сохраняются для обратной совместимости. Обычные запросы и показанные примеры используют два знака после запятой. Минимумы/максимумы конкретного сценария задаются в маршрутизации. exclusiveMinimum: 0 Amount
`externalParams`	Необязательно	`object` Объект зависит от сценария; может отсутствовать или содержать поля null. ExternalParams
`orderHistory`	Необязательно	`array of object` Заполнение не гарантируется и может запаздывать.

JSONВыделите текст для копирования

{
  "externalId": "<PAYSTAR_ORDER_ID>",
  "orderStatus": "Success",
  "amount": 100,
  "orderHistory": []
}

Описание полей orderHistory и кодов истории: Справочник истории платежей →.

HTTP-результаты

HTTP	Значение
`200`	Текущее состояние заявки.
`401`	Отсутствует или недействителен Bearer-токен.
`403`	Ключ действителен, но не имеет доступа к этому ресурсу.
`404`	Заявка не найдена. BusinessError и обработка
`500`	Внутренняя ошибка сервера.

Технические сведения

Operation ID: getPayoutStatusByPayStarId

Это имя операции OpenAPI для инструментов разработки и генераторов кода. Оно не является ID заявки или параметром запроса: не передавайте его в URL, заголовках или теле запроса.

[06]

Баланс мерчанта и pipeline

GEThttps://secure.paystar.uk/api/v1/balance/merchant?currency={currency}

currency — обязательный строковый query-параметр без ограничения длины или шаблона alpha-3. Balance — запрос только на чтение, а не маршрутизация платежа. Используйте стандартный хост secure.paystar.uk и профиль с доступом к балансу.

Запрос и пример

cURLВыделите текст для копирования

curl --request GET \
  --url 'https://secure.paystar.uk/api/v1/balance/merchant?currency=RUB' \
  --header 'Authorization: Bearer <PAYSTAR_PROFILE_TOKEN>'

Поля ответа

Поле	Обязательность	Тип и значение
`currency`	Обязательно	`string`
`merchantBalance`	Обязательно	`number`
`merchantOverdraft`	Обязательно	`number`
`pipelineBalance`	Обязательно	`number`
`pipelineAvailableBalance`	Обязательно	`number`
`pipelineProcessingOrdersDeposit`	Обязательно	`number`
`pipelineProcessingOrdersWithdrawals`	Обязательно	`number`

HTTP-результаты

HTTP	Значение
`200`	Данные баланса.
`400`	Валюта отсутствует или некорректна. BusinessError и обработка
`401`	Отсутствует или недействителен Bearer-токен.
`403`	Ключ действителен, но не имеет доступа к балансу.

[07]

Читайте историю без догадок

Элементы истории могут содержать time, action и newCode. Сохраняйте неизвестные коды; не выводите их смысл из соседних значений.

Время в истории заявок указано в UTC. В ответах статуса пополнений и выплат трактуйте orderHistory[].time как UTC, даже если в значении нет Z или числового смещения. Не трактуйте его как местное время.

Схема элемента истории

Поле	Обязательность	Тип и значение
`time`	Необязательно	`string · date-time` Время записи истории в UTC для ответов статуса пополнений и выплат. Если возвращается без Z или смещения, считайте поле временем UTC, а не местным (подтверждено владельцем API 2026-09-08). Отсутствующий суффикс остаётся расхождением формата date-time в протоколе; уточнение не ослабляет схему.
`action`	Необязательно	`string \| null` Код действия Payment History.
`newCode`	Необязательно	`string \| null` Дополнительный код Payment History, возвращаемый текущим API.

Чувствительные externalParams

Поле	Обязательность	Тип и значение
`cardToken`	Необязательно	`string \| null` Чувствительные данные; доступ и журналирование нужно ограничить.
`cardStorageToken`	Необязательно	`string \| null` Чувствительные данные; доступ и журналирование нужно ограничить.
`cardHolder`	Необязательно	`string \| null`
`cardNumber`	Необязательно	`string \| null` При возврате требуется маскирование.

Справочник истории платежей → Опрос и восстановление →