GET /api/agent-payments/{id}Возвращает текущее состояние платежа, созданного авторизованным агентом.
Авторизация
Используйте ту же Basic Authentication агента, что и при создании платежа.
Параметры пути
| Параметр | Тип/формат | Обязательно | Описание |
|---|---|---|---|
id | Строка, UUID | Да | id из ответа на создание платежа, не orderId и не agentOrderId. |
Пример запроса
Настройте переменные окружения для авторизации и замените UUID в примере
на
id своего платежа:bashcurl --request GET \ --url "${RB_API_BASE_URL%/}/api/agent-payments/d325725f-6c73-4dab-910f-88e3274b66d7" \ --user "${AGENT_USERNAME}:${AGENT_PASSWORD}" \ --header 'Accept: application/json'
Ответ
Успешный запрос возвращает HTTP 200 и JSON-объект без обёртки
data:| Поле | Тип/формат | Описание |
|---|---|---|
id | Строка, UUID | Идентификатор платежа. |
agentOrderId | Строка | Номер заказа в вашей системе, переданный при создании. |
status | Строка, перечисление | Текущее состояние платежа; см. ниже. |
amount | Десятичная строка | Сумма получателю в рублях, без комиссий. |
modifiedAmount | Десятичная строка | Полная сумма к оплате клиентом в рублях, включая комиссии. |
json{ "id": "d325725f-6c73-4dab-910f-88e3274b66d7", "agentOrderId": "order-2026-001", "status": "WITHDRAWN", "amount": "100.00", "modifiedAmount": "101.78" }
paymentUrl и orderId эквайринга не возвращаются. Сохраняйте их из ответа на создание.Статусы платежа
| Статус | Значение | Действие при интеграции |
|---|---|---|
PENDING | Оплата клиента ещё не подтверждена. Включает регистрацию в процессе или с неопределённым результатом. | Продолжайте проверять существующий платёж. |
WITHDRAWN | Эквайринг подтвердил оплату клиента; полное распределение банком ещё не подтверждено. | Считайте оплату клиента подтверждённой; продолжайте проверять распределение. |
DISTRIBUTED | Банк подтвердил все ожидаемые перечисления получателю и на комиссии. | Распределение завершено; остановите опрос. |
FAILED | Регистрация явно отклонена либо эквайринг сообщил о неуспешном, отменённом или возвращённом платеже до привязки записи об оплате. | Остановите опрос и согласуйте дальнейшие действия с поддержкой. |
Успешный путь:
PENDING → WITHDRAWN → DISTRIBUTED.
Неуспешный путь: PENDING → FAILED.
При ошибке распределения оплаченный платёж остаётся WITHDRAWN для повторной обработки, а не становится неоплаченным.Внимание:FAILEDне гарантирует отсутствия списания: эквайринг мог отменить или вернуть платёж.DISTRIBUTEDподтверждает распределение, но не описывает последующие возвраты. По вопросам возврата и отмены обращайтесь в поддержку; этих операций в API нет.
Опрос и задержки обновления
Статусы обновляются асинхронно по уведомлениям эквайринга или при фоновой проверке.
Возврат клиента, успешный ответ на создание и наличие ссылки на оплату не подтверждают оплату.
Не создавайте новый платёж только из-за задержки статуса.
Если платёж неожиданно долго остаётся
PENDING или WITHDRAWN, обратитесь в поддержку с его id и номером своего заказа.Коды ошибок
Ошибки используют общий формат.
| HTTP | extensions.code | extensions.type | Причина и действие |
|---|---|---|---|
| 401 | UNAUTHENTICATED | AUTHORIZATION_REQUIRED | Проверьте учётные данные и включён ли агент. |
| 404 | NOT_FOUND | PAYMENT_NOT_FOUND | Некорректный, неизвестный, удалённый или чужой ID платежа. Проверьте id, учётные данные и среду. |
| 500 | INTERNAL_ERROR | PAYMENT_QUERY_FAILED | Ошибка получения статуса. Повторите GET позже. |
| 500 | INTERNAL_ERROR | INTERNAL_SERVER_ERROR | Непредвиденная ошибка сервиса. Повторите GET позже; при повторении обратитесь в поддержку. |
Ошибка запроса статуса не меняет состояние платежа. Повторите GET позже, а не POST.