Breadcrumbs

Создание аккаунта

Метод используется для создания нового аккаунта. Текущий пользователь автоматически назначается его Владельцем (основным контактным лицом), а также контактным лицом по техническим и финансовым вопросам. Аккаунт создается с параметром Разрешение на работу по постоплате = Проверка не проводилась (см. ). Метод возвращает информацию о созданном аккаунте. Код ответа 201 Created. 

POST {reseller_domain}/internal_api/accounts

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

Content-Type

header

string

Обязательный

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

Обязательный

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

Опциональный

Двухбуквенный код языка данных в ответе

Authorization 

header

string

Обязательный

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

Обязательный

Доменное имя реселлера

account_type_id

form

integer

Обязательный

ID типа аккаунта

agreement_confirmed

form

bool

Опциональный

Признак принятия соглашения Правила продаж (см. согласие с общими условиями работы в Соглашения с клиентами в ):

  • true — аккаунт принимает соглашение. В зависимости от настроек реселлера принятие соглашения может быть обязательным.

  • false — аккаунт не принимает соглашение.

См. также Принятие соглашения для аккаунта

primary_name

form

string

Опциональный

Основное имя аккаунта. Например, название компании для юридического лица

first_name

form

string

Обязательный

Имя уполномоченного лица

last_name

form

string

Обязательный

Фамилия уполномоченного лица

middle_name

form

string

Опциональный

Отчество уполномоченного лица

email

form

string

Обязательный

Email уполномоченного лица

country

form

string

Обязательный

Код страны. Реселлер может ограничить список доступных стран

region

form

string

Обязательный

Регион (Область). Реселлер может запретить указание отдельных регионов

city

form

string

Обязательный

Город

street

form

string

Обязательный

  • Улица — если используется вместе с building и office.

  • Адрес — если building и office не используются. Чтобы подставить данные о доме и помещении, полученные с помощью метода Поиск организации в сервисе автозаполнения, объедините их с названием улицы в одну строку через запятую.

building

form

string

Опциональный

Дом

office

form

string

Опциональный

Офис (помещение)

zip

form

string

Обязательный

Почтовый индекс

phone

form

string

Обязательный

Номер телефона в международном формате

custom_attributes

form

object

Опциональный

Список пар ключ-значение дополнительных атрибутов аккаунта, значения которых нужно задать (см. Получение списка атрибутов для создания аккаунта):

  • Если указан несуществующий ключ, значение атрибута игнорируется.

  • Если указано значение для ключа атрибута, недоступного для редактирования, значение атрибута игнорируется.

  • Чтобы задать пустое значение атрибута, укажите "".

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

Допустимые значения ограничены в зависимости от типа атрибута:

  • Для атрибутов типа checkbox:

    • true — флажок установлен.

    • false — флажок не установлен.

  • Для атрибутов типа list — ключ одного из предустановленных значений.

manager_key

form

string

Опциональный

Ключ менеджера, к которому нужно привязать аккаунт. Параметр игнорируется, если указан менеджер в статусе Неактивный или пустое значение.

Модель ответа

Модель ответа аналогична методу Получение информации об аккаунте.

Пример запроса

Bash
curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
    "data": {
        "attributes": {
            "account_type_id": 1562,
            "primary_name": "",
            "first_name": "Florine",
            "last_name": "Hintz",
            "middle_name": "Kailyn",
            "email": "Hermina.Reichert@example.net",
            "country": "BO",
            "region": "Hillsmouth",
            "city": "Edmondview",
            "street": "Brendon Roads",
            "building": "",
            "office": "",
            "zip": "220100",
            "phone": "+703-479-5509",
            "agreement_confirmed": true,
            "custom_attributes": {
                "bank_account": "2300000000000"
            },
            "manager_key": ""
        }
    }
}'

Пример ответа

JSON
{
    "data": {
        "id": "1945",
        "type": "accounts",
        "attributes": {
            "created_at": "2023-01-17 T15:20:42.802410+0300",
            "name": "Florine Kailyn Hintz",
            "primary_name": "",
            "status": "active",
            "user_status": "active",
            "user_role": "owner",
            "trial": false,
            "account_type": {
                "id": 1562,
                "key": "personal",
                "name": "Personal"
            },
            "terms_and_conditions": {
                "confirmed": true,
                "url": "https://test.activeplatform.com/terms"
            },
            "usable_balance": 0,
            "reseller_currency_iso_code": "USD",
            "account_class": {
                "id": 3726,
                "key": "postpay",
                "name": "postpay",
                "payment_model": "prepay",
                "buy_with_negative_balance": false,
                "guaranteed_payment_limit": 1000,
                "guaranteed_payment_period": 7
            },
            "financial_blocking_threshold": 0,
            "finance_lock_date": null,
            "current_consumption": 0,
            "user_contract": {
                "last_name": "Hintz",
                "first_name": "Florine",
                "middle_name": "Kailyn",
                "email": "Hermina.Reichert@example.net"
            },
            "contact_data": {
                "country": "BO",
                "zip": "220100",
                "region": "Hillsmouth",
                "city": "Edmondview",
                "street": "Brendon Roads",
                "building": "",
                "office": "",
                "phone": "+703-479-5509"
            },
            "contact_users": {
                "main": {
                    "id": 2477,
                    "last_name": "Legros",
                    "first_name": "Kristopher",
                    "middle_name": "Herbert",
                    "email": "cielo.rowe@yahoo.com"
                },
                "tech": {
                    "id": 2477,
                    "last_name": "Legros",
                    "first_name": "Kristopher",
                    "middle_name": "Herbert",
                    "email": "cielo.rowe@yahoo.com"
                },
                "bill": {
                    "id": 2477,
                    "last_name": "Legros",
                    "first_name": "Kristopher",
                    "middle_name": "Herbert",
                    "email": "cielo.rowe@yahoo.com"
                }
            },
            "custom_attributes": {
                "bank_account": "2300000000000"
            },
            "manager": null,
            "available_operations": {
                "join_payments": true,
                "top_up_balance": true,
                "create_guaranteed_payment": false,
                "invite_user": true
            },
            "work_permit_for_postpaid": "verification_not_performed"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}