Loam Customer API · Предпросмотр

Центр разработчиков

Начните здесь, чтобы работать с Loam Customer API.

Пять минут Быстрый старт От нового API-клиента до живого ответа: выпустите токен, прочитайте урегулированные остатки, затем запросите валютную котировку. Поток маркетплейса доступен, когда эта функция включена. Следуйте «Быстрому старту» OpenAPI 3.1 Справочник API Изучите опубликованный контракт эндпоинт за эндпоинтом — все области доступа, схемы запросов и ответов и коды ошибок, с конструктором запросов для каждого маршрута. Откройте справочник API

Оба пути требуют учётных данных. Начните с создания API‑клиента.

Платёж в том виде, в каком его записывает API

Отправьте деньги с amount и currency на одобренный адрес. Запись возвращает 202 с { id, state } и Location. Нужны scope money.write и owner grant при step-up аутентификации; в preview функция закрыта.

POST /api/v1/payments
curl -X POST "$LOAM_API_BASE/payments" \  -H "Authorization: Bearer $LOAM_TOKEN" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: $(uuidgen)" \  -d '{    "destination_id": "2f4cbb59-3ab1-4b6d-8d10-9cd2236cf94e",    "amount": 2500000,    "currency": "USD"  }'// Response
HTTP/1.1 202 Accepted
Location: /api/v1/payments/<payment-id>

{
  "ok": true,
  "data": {
    "id": "<payment-id>",
    "state": "processing"
  }
}

Что покрывает API сегодня

Доступ в превью преднамеренно более ограничен, чем опубликованный контракт. Всё ниже либо доступно для вызова сейчас, либо указывает, какое разрешение ему требуется.

Открыть в предварительном просмотре Разрешения read и write

  • Расчётные балансы GET /api/v1/balances
  • Список платежей GET /api/v1/payments
  • Условия казначейского хранилища GET /api/v1/vaults
  • Котировки валютного обмена POST /api/v1/fx/quotes

Закрыто в предварительном просмотре Разрешение money.write

  • Платежи на одобренные назначения POST /api/v1/payments
  • Поступления с банковского счёта POST /api/v1/onramp
  • Вывод средств на банковский счёт POST /api/v1/offramp
  • Внесение и снятие средств из хранилища POST /api/v1/vaults/…

Перемещение средств требует, чтобы владелец организации — человек — предоставил разрешение в рамках повышенной аутентификации, установил лимит на транзакцию и заранее одобрил назначение. Эти конечные точки останутся закрытыми до окончания превью.

Поведение API

  • OAuth 2.0

    Грант «client_credentials»

    Обменяйте client id и secret на краткоживущий bearer‑токен одним запросом с form‑encoded телом. Права (scopes) читаются из клиента для каждого запроса, поэтому их ограничение применяется немедленно.

  • Конверт

    Единый формат для всех маршрутов

    Успех — это ok, затем data; ошибка — это ok: false с машинно‑читаемым кодом ошибки.

  • Идемпотентность

    Повторные попытки ничего не стоят

    Каждая операция записи требует Idempotency-Key. При использовании того же ключа и того же тела повторяется первоначальный результат вместо двойной записи.

  • Пагинация

    Курсоры, не смещения

    Маршруты списка возвращают page.next_cursor. Передавайте его обратно как cursor до тех пор, пока не вернётся null.

Выберите путь: «Быстрый старт», если вы хотите сначала получить рабочий запрос, или справочник, если вы уже знаете нужный вызов.

Следуйте «Быстрому старту» Откройте справочник API