API Documentation
Русский
Русский
  • Авторизация
  • Подпись запросов
  • Список кодов ошибок
  • Webhooks
  • IFrame ордер
  • Виджет приема оплаты
  • Telegram MiniApp
  • API Reference
    • Базовый функционал
      • Проверка корректности подписи x-api-signature
      • Получение монет доступных для приема/отправки транзакций
      • Запрос текущей цены
      • Поиск операции по TX-хешу
      • Проверка корректности адреса
      • Получение истории транзакций
    • Авансовый счет
      • Получение аккаунтов текущего пользователя
      • Получение аккаунта по его ID
      • Получение адреса для пополнения баланса аккаунта
    • Блокчейн-адреса
      • Поиск по ID
      • Отслеживание транзакций
      • Поиск по адресу
      • Мета-данные
      • Транзакции адреса
      • Последняя транзакция адреса
      • Получение списка PayIn адресов
      • Получение списка бизнес адресов
      • Получение рекуррентных адресов
      • Получение списка PayOut адресов
      • Создание нового адрес бизнес кошелька
      • Создание нового адрес PayOut кошелька
    • Персональные адреса
      • Создание пользователя
      • Получение адреса
      • Получение списка адресов
      • Получение пользователя
      • Добавление доверенного адреса
      • Получение списка доверенных адресов
      • Удаление доверенного адреса
    • Ордера
      • Создание ордера
      • Получение информации об ордере
      • Получение списка ордеров
    • Выводы
      • Получение комиссии для проведения вывода
      • Синхронный вывод
      • Асинхронный вывод
      • Получение информации о выводе
    • Счета
      • Создание счета на оплату
      • Запрос получения информации об инвойсе
      • Получение списка счетов
    • Авто обмены
      • Создание авто-обмена
      • Поиск авто-обмена по ID
    • Выплаты 2.0
      • Создание авто-вывода
      • Поиск авто-вывода по ID
      • Дополнительное подтверждение вывода
    • Мост
      • Получение лимиов для кроссчейн перевода
      • Получение информации о кроссчейн переводе
      • Формирование токена комисси
      • Создание кроссчейн перевода
    • Обмены
      • Получение лимитов для кроссчейн обмена
      • Получение информации о кроссчейн обмене
      • Формирование токена комисси
      • Создание кроссчейн обмена
    • Рекуррентные платежи
      • Создание платежной связки
      • Получение платежной связки
      • Получение платежных связок по пользователю
      • Отключение платежной связки
      • Создание подписки
      • Получение подписки
      • Отключение подписки
      • Создание платежа
    • KYT
      • Проверка рисков транзакции
      • Проверка рисков вывода
      • Проверка риска вывода на указанный адрес
    • Партнерское API
      • Создание пользователя
      • Получение пользователя
      • Получение всех пользователей
      • Создание организации
      • Получение списка организаций
      • Получение авансовых балансов пользователя
      • Пополнение авансового баланса пользователя
      • Получение общих тарифов
      • Создание/обновление индивидуального тарифа
      • Получение индвидуальных тарифов
      • Создание API ключа
      • Получение API ключей
      • Удаление API ключа
    • Вебхуки
      • Получение вебхука
      • Получение вебхука (расширенный)
    • Сиротские транзакции
      • Получение транзакции
      • Получение списка транзакций
      • Получение токена комиссии
      • Вывод
    • Адресная книга
      • Добавление адреса
      • Удаление адреса
      • Обновление адреса
      • Получение списка адресов
Powered by GitBook
On this page
  1. API Reference
  2. Персональные адреса

Создание пользователя

PreviousПерсональные адресаNextПолучение адреса

Last updated 8 months ago

Метод позволяет:

  • создать пользователя персональных адресов.

  • обновить данные ранее созданного пользователя при указании того же clientId. Присланные значения параметров перезаписывают предыдущие данные.

При депозите на персональный адрес пользователя присылается , на указанный в запросе depositWebhookUrl. При выводе (общий метод "Создание вывода" /make-withdrawal) с персонального адреса ответ со статусом приходит сразу.

вебхук

Создание пользователя

post
Header parameters
x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json
Body

Тело запроса создания пользователя

clientIdstringRequired

Идентификатор пользвателя в системе мерчанта

Example: user12345
clientEmailstringOptional

Почта пользователя

Example: user@domain.com
clientNamestringOptional

Имя пользователя

Example: John Doe
depositWebhookUrlstringOptional

URL для уведомлений о новых пополнений

Example: https://merchant.domain/webhooks/user12345
createAddressesbooleanOptional

Создать все адреса для пользователя

groupByBlockchainbooleanOptional

Сгруппировать адреса по блокчейн сетям (например, 1 адрес для сетей bsc, fantom, ethereum). Данный параметр имеет эффект только при createAddresses: true

checkRisksbooleanOptional

Проверять риски каждой входящей транзакции на персональные адреса пользователя. Информация о рисках будет приходить в вебхуке на указанный depositWebhookUrl в поле risks

Responses
200Success
application/json
post
POST /api-gateway/personal-addresses/create-user HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "clientId": "user12345",
  "clientEmail": "user@domain.com",
  "clientName": "John Doe",
  "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
  "createAddresses": true,
  "groupByBlockchain": true,
  "checkRisks": true
}
200Success
{
  "success": true,
  "response": {
    "id": "c886f2dd-669a-4657-ba10-9ad7700cc8e5",
    "clientId": "user12345",
    "clientEmail": "user@domain.com",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2024-12-26T08:21:33.226Z",
    "updatedAt": "2024-12-26T08:21:33.226Z",
    "addresses": {
      "id": "2361c9b9-8c89-40b0-ab90-1ade882cf756",
      "userId": "a4aaa006-0fd1-4413-8433-d0fe45c15f89",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "tag": null,
      "balance": "1234.1234",
      "isActive": true
    }
  }
}