Справочник API
Все методы API v2
Удобство наших партнёров — приоритетная задача Parallel. Ниже перечислены все доступные методы API. Контракт API вы также можете найти на TypeScript и в стандарте OpenAPI.
POST /api/v2/invoices. Создать заявкуGET /api/v2/invoices. Список заявокGET /api/v2/invoices/{invoice_id}. Получить заявкуPOST /api/v2/invoices/{invoice_id}/attachments. Загрузить чек или видео оплатыPOST /api/v2/invoices/{invoice_id}/take_financial_responsibility. Взять заявку под финансовую ответственностьPOST /api/v2/invoices/{invoice_id}/cancel. Отменить заявкуPOST /api/v2/invoices/{invoice_id}/dispute. Открыть диспутGET /api/v2/balance. БалансPOST /api/v2/withdrawals. Вывести USDTGET /api/v2/balance/operations. История пополнений и выводовGET /api/v2/sla. Условия магазина и курсGET /api/v2/banks. Список банковPUT /api/v2/webhook. Указать адрес для WebhookGET /api/v2/webhook. Текущие адрес и ключ подписиPOST /api/v2/webhook/secret. Сменить ключ подписи
Адрес и токен
Адрес API один: https://api.parallel-pay.com. Передавайте токен в заголовке каждого запроса:
curl https://api.parallel-pay.com/api/v2/sla \
-H "Authorization: Bearer $PARALLEL_TOKEN"Токен выпускается в личном кабинете, в настройках магазина. Он показывается один раз. Храните его на своём сервере и не передавайте в браузер или приложение клиента. Чтобы проверить интеграцию без настоящих денег, используйте тестовый токен.
Ошибки
Любой ответ с кодом не 2xx выглядит одинаково:
{
"error": {
"code": "INVALID_STATUS",
"message": "Загрузить файл нельзя: заявка в статусе PAID"
}
}Стройте логику на error.code. Поле error.message написано для человека. Лишнее поле в теле запроса,
которого нет в описании метода, тоже ошибка: 400 с кодом VALIDATION_ERROR.
| HTTP | code | Когда |
|---|---|---|
| 400 | VALIDATION_ERROR | тело или параметры запроса не прошли проверку |
| 401 | UNAUTHORIZED | нет токена или токен неверный |
| 403 | SHOP_NOT_ACTIVATED | магазин ещё не активирован |
| 403 | DIRECTION_DISABLED | заявки этого направления (на вход или на выход) магазину не подключены |
| 403 | RECEIPT_DELIVERY_DISABLED | этот способ получения чека не подключён магазину |
| 403 | BANK_CHOICE_DISABLED | выбор банка реквизитов (bank) вашему магазину не подключён |
| 403 | METHOD_CHOICE_DISABLED | выбор способа оплаты (method) вашему магазину не подключён |
| 403 | DISPUTE_DISABLED | диспуты по заявкам на выход вашему магазину не подключены |
| 403 | PROOF_OPTION_DISABLED | этот вид дополнительного доказательства оплаты не подключён магазину |
| 404 | NOT_FOUND | заявки или адреса нет |
| 404 | WEBHOOK_NOT_SET | подписки на события ещё нет |
| 405 | METHOD_NOT_ALLOWED | этот метод у адреса не поддерживается |
| 409 | INVALID_STATUS | действие недоступно в текущем статусе заявки |
| 409 | RECEIPT_DELIVERY_IS_BANK_EMAIL | чек по этой заявке клиент присылает на почту, загрузка недоступна |
| 409 | FINANCIAL_RESPONSIBILITY_ALREADY_TAKEN | под финансовую ответственность по этой заявке уже взята другая сумма |
| 409 | INSUFFICIENT_BALANCE | на балансе не хватает доступных USDT |
| 409 | DISPUTE_ALREADY_OPENED | диспут по этой заявке уже открывался |
| 409 | DISPUTE_WINDOW_CLOSED | срок, в который можно открыть диспут, вышел: dispute_days в GET /api/v2/sla |
| 413 | FILE_TOO_LARGE | файл больше допустимого |
| 415 | UNSUPPORTED_FILE | формат файла не поддерживается |
| 503 | NO_REQUISITES | сейчас нет реквизитов на эту сумму, повторите запрос позже с тем же internal_id. Бывает у магазина, заявки которого не ждут реквизиты: requisites_wait_minutes: 0 в GET /api/v2/sla |
| 503 | UNAVAILABLE | временный сбой, повторите запрос позже |
Любой метод может вернуть UNAUTHORIZED, SHOP_NOT_ACTIVATED и UNAVAILABLE. Какие коды возвращает конкретный
метод, указано на его странице.