Breadcrumbs

Создание платежа

Метод используется для создания платежа на пополнение баланса аккаунта, к которому есть доступ у текущего пользователя. Доступность использования метода зависит от настроек реселлера (см. Получение настроек реселлера).

Метод возвращает информацию о созданном платеже. Код ответа 201 Created.

POST {reseller_domain}/internal_api/accounts/{account_id}/payments

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

Авторизация

Требуется авторизация с помощью 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_id

path

integer

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

ID аккаунта, для которого создается платеж

total

form

number

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

Сумма платежа (минимум 0.01)

purpose

form

string

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

Назначение платежа (до 200 символов)

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

Название

Тип данных

Описание

data

object

Данные ответа


id

string

ID платежа


type

string

Тип данных


attributes

object

Информация о платеже



created_at

string

Дата и время создания платежа



document_id

string

Номер платежа



status

string

Статус платежа



total

number

Сумма к оплате



amount_paid_from_balance

number

Часть суммы, оплаченная с баланса (см.

Частичная оплата платежа с баланса

)



initial_total

number

Изначальная сумма платежа



reseller_currency_iso_code

string

Код валюты



payment_model

string

Модель оплаты:

  • prepay — Предоплата. Для платежа на пополнение баланса всегда модель оплаты Предоплата.

  • postpay — Постоплата.



is_topup

bool

Признак платежа для пополнения баланса:

  • true — платеж для пополнения баланса.

  • false — платеж другого типа (см. ).



purpose

string

Назначение платежа



is_joined

bool

Признак объединенного платежа:

  • true — объединенный платеж.

  • false — отдельный платеж.



topup_sum

number

Сумма для пополнения баланса



due_date

string



closed_at

string

Дата завершения платежа



payment_method_attributes

object

Информация о связанном способе оплаты




id

integer

ID способа оплаты




name

string

Название способа оплаты




plugin_id

string

ID платежного модуля, на основе которого создан способ оплаты



invoice_data

array of objects

Информация об инвойсах, связанных с платежом




name

string

Название инвойса




url_for_download

string

Ссылка для скачивания




external_id

integer

Внешний ID




external_invoice_type

string

Тип внешнего инвойса




full_name

string

Полное название внешнего инвойса




external_total

number

Сумма внешнего инвойса. Может отличаться от суммы платежа




external_total_with_currency

string

Сумма внешнего инвойса с указанием валюты. Валюта может отличаться от валюты реселлера



external_invoice_generation

bool

Признак использования внешнего управления инвойсами (только для платежей по модели Постоплата):

  • true — внешняя система управляет инвойсами (см. ).

  • false — платформа управляет инвойсами (актами по модели Постоплата).



orders

array of objects

Список заказов, связанных с платежом. Для платежа на пополнение баланса — пустой массив




id

integer

ID заказа




document_id

string

Номер заказа




type

string

Тип заказа:

  • SalesOrder — заказ на покупку.

  • SwitchPlanOrder — заказ на переключение тарифного плана.

  • RenewalOrder — заказ на продление.

  • ProlongOrder — заказ на пролонгацию.

  • ChangeOrder — заказ на изменение количества ресурсов.




total

number

Сумма заказа в валюте реселлера




subscription

object

Информация о подписке, для которой оформлен заказ





id

integer

ID подписки





name

string

Название подписки





billing_type

string

Тип биллинга тарифного плана, на который заказана подписка (см.

)





payment_model

string

Модель оплаты подписки:

  • prepay — Предоплата.

  • postpay — Постоплата.




detail_items

array of objects

Список позиций в заказе





description

string

Описание позиции





quantity_float

string

Количество заказанных единиц услуги или ресурса





duration_float

string

Оплачиваемый период в месяцах





unit_price

string

Цена за единицу услуги или ресурса с указанием валюты реселлера





discount_amount

string

Скидка с указанием валюты реселлера





amount

string

Сумма позиции с указанием валюты реселлера



charges

array of objects

Список списаний, сформированных по заказу. Для платежа на пополнение баланса — пустой массив




id

integer

ID списаний




created_at

string

Дата создания списания




type

string

Тип списания




description

string

Описание




quantity_float

string

Количество заказанных единиц услуги или ресурса




duration_float

string

Оплачиваемый период в месяцах




operate_from

string

Дата начала оплачиваемого периода




operate_to

string

Дата окончания оплачиваемого периода




unit_price

string

Цена за единицу услуги или ресурса с указанием валюты реселлера




discount_amount

string

Скидка с указанием валюты реселлера




amount

string

Сумма списания с указанием валюты реселлера




total

number

Сумма списания в валюте реселлера




reseller_currency_iso_code

string

Код валюты реселлера




item_target_data

object

Информация о сущности из заказа, для которой сформировано списание





target_id

integer

ID сущности





target_type

string

Тип сущности





type

string

Тип списания





description

string

Название сущности




subscription

object

Информация о подписке, для которой сформировано списание





id

integer

ID подписки





name

string

Название подписки





billing_type

string

Тип биллинга тарифного плана, на который заказана подписка (см.

)





payment_model

string

Модель оплаты подписки:

  • prepay — Предоплата.

  • postpay — Постоплата.



available_operations

object

Доступные действия над платежом




cancel

bool

Отмена (см. Отмена платежа):

  • true — действие доступно.

  • false — действие недоступно.




recreate

bool

Изменение (см. Изменение платежа):

  • true — действие доступно.

  • false — действие недоступно.




pay

bool

Оплата с помощью способа оплаты (см. Оплата платежа с помощью способа оплаты):

  • true — действие доступно.

  • false — действие недоступно.




pay_from_balance

bool

Оплата с баланса аккаунта (см. Оплата платежа с баланса аккаунта):

  • true — действие доступно.

  • false — действие недоступно.




partial_pay

bool

Частичная оплата с баланса аккаунта (см. Частичная оплата платежа с баланса):

  • true — действие доступно.

  • false — действие недоступно.




separate

bool

Разъединение (см. Разъединение платежей):

  • true — действие доступно.

  • false — действие недоступно.




join

bool

Объединение (см. Объединение платежей):

  • true — действие доступно.

  • false — действие недоступно.




autopay_from_balance

bool



processing_error


Информация об ошибках обработки платежа во внешней системе



taxes_total

object

Итоговые данные налогов (см.

). Для платежа на пополнение баланса — null




total

string

Сумма все налогов по всем списаниям с указанием валюты реселлера




taxes

array of objects

Итоговые данные каждого налога





name

string

Название налога





rate

number

Ставка налога в процентах





amount

number

Сумма налога по всем списаниям в валюте реселлера





origin_id

integer

ID налога в налоговом модуле





amount_with_currency

string

Сумма налога по всем списаниям с указанием валюты реселлера


relationships

object

Перечень объектов, связанных с платежом



charges

object

Информация о списаниях




data

array of objects

Информация о связанном объекте:

Название

Тип данных

Описание

id

string

ID объекта

type

string

Тип данных

Для платежа на пополнение баланса — пустой массив

meta

object

Дополнительная информация


server_current_time

string

Текущие дата и время сервера

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

Bash
curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts/1656/payments' \
--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":
        { 
            "total" : 658.39,
            "purpose" : "applications"
        }
    }
}'

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

JSON
{
    "data": {
        "id": "2158",
        "type": "payments",
        "attributes": {
            "created_at": "2025-07-28T09:08:34.158425+0300",
            "document_id": "002014",
            "status": "waiting_for_payment",
            "total": 658.39,
            "amount_paid_from_balance": null,
            "initial_total": 658.39,
            "reseller_currency_iso_code": "USD",
            "payment_model": "prepay",
            "is_topup": true,
            "purpose": "applications",
            "is_joined": false,
            "topup_sum": 658.39,
            "due_date": "",
            "closed_at": "",
            "payment_method_attributes": null,
            "invoice_data": [],
            "external_invoice_generation": false,
            "orders": [],
            "available_operations": {
                "cancel": true,
                "recreate": true,
                "pay": true,
                "pay_from_balance": false,
                "partial_pay": false,
                "separate": false,
                "join": true,
                "autopay_from_balance": false
            },
            "processing_error": null,
            "taxes_total": null,
            "charges": []
        },
        "relationships": {
            "charges": {
                "data": []
            }
        }
    },
    "meta": {
        "server_current_time": "2025-07-28T09:08:34.186939+0300"
    }
}