For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

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

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

  • обновить данные ранее созданного пользователя при указании того же 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

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

successbooleanRequired

Признак успешности запроса

post/api-gateway/personal-addresses/create-user
POST /api-gateway/personal-addresses/create-user HTTP/1.1
Host: app.apollopayment.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": "ed75b68d-28ca-49c8-bb7d-1da3c0379239",
    "clientId": "user12345",
    "clientEmail": "user@domain.com",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2026-01-29T11:16:59.963Z",
    "updatedAt": "2026-01-29T11:16:59.963Z",
    "addresses": {
      "id": "26490c5f-ab6f-4e4d-acb4-1ec5e3ea24d7",
      "userId": "bf19dd8d-ac4c-4450-90d1-56b94b33bd68",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "tag": null,
      "balance": "1234.1234",
      "isActive": true
    }
  }
}

Last updated