Метод используется для объединения платежей аккаунта, к которому есть доступ у текущего пользователя. Можно объединять только платежи на пополнение баланса и платежи по заказу для подписки по модели Предоплата, которые находятся в статусе Ожидает оплаты (см. также use_to_join в Получение статистики платежей).
При объединении платежей, среди которых есть хотя бы один частично оплаченный с баланса (см. Частичная оплата платежа с баланса), информация о частичной оплате переносится в объединенный платеж.
Метод возвращает информацию о объединенном платеже, созданном по стандартной логике платформы. Код ответа 201 Created.
POST {reseller_domain}/internal_api/accounts/{account_id}/payments/join
В этой статье:
Авторизация
Требуется авторизация с помощью 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 пользователя. Формат: |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
account_id |
path |
integer |
Обязательный |
ID аккаунта |
|
payment_ids |
form |
array |
Обязательный |
Список ID платежей, которые нужно объединить (минимум 2) |
Модель ответа
Модель ответа соответствует методу Создание платежа.
Пример запроса
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": {
"payment_ids": [
2448,
2487
]
}
}
}'
Пример ответа
{
"data": {
"id": "2518",
"type": "payments",
"attributes": {
"created_at": "2023-03-02T07:29:58.427981+0000",
"document_id": "002413",
"status": "waiting_for_payment",
"total": 147.83,
"amount_paid_from_balance": null,
"initial_total": 147.83,
"reseller_currency_iso_code": "EUR",
"payment_model": "prepay",
"is_topup": true,
"purpose": "",
"is_joined": true,
"topup_sum": 143.54,
"due_date": "2023-05-01",
"closed_at": "",
"payment_method_attributes": null,
"invoice_data": [],
"external_invoice_generation": false,
"orders": [
{
"id": 3539,
"document_id": "PO001032",
"type": "ProlongOrder",
"total": 4.29,
"subscription": {
"id": 1687,
"name": "Plan1 For AB-33696",
"billing_type": "csp_monthly",
"payment_model": "prepay"
},
"detail_items": [
{
"description": "Prolongation resource (recurring fee) \"Licenses\" for Subscription\n #1687 \"Office\" from 01.05.2023 to 10.05.2023",
"quantity_float": "1.0",
"duration_float": "0.323",
"unit_price": "11.00 €",
"discount_amount": "0.00 €",
"amount": "4.29 €"
}
]
}
],
"available_operations": {
"cancel": true,
"recreate": false,
"pay": true,
"pay_from_balance": false,
"partial_pay": true,
"separate": true,
"join": true,
"autopay_from_balance": false
},
"processing_error": null,
"taxes_total": {
"total": "0.74 €",
"taxes": [
{
"name": "Tax1",
"rate": 2,
"amount": 0.07,
"origin_id": 18,
"amount_with_currency": "0.07 €"
},
{
"name": "Tax2",
"rate": 11,
"amount": 0.39,
"origin_id": 20,
"amount_with_currency": "0.39 €"
},
{
"name": "Tax3",
"rate": 8,
"amount": 0.28,
"origin_id": 38,
"amount_with_currency": "0.28 €"
}
]
},
"charges": []
},
"relationships": {
"charges": {
"data": [
{
"id": "6927",
"type": "charge_recurrings"
}
]
}
}
},
"meta": {
"server_current_time": "2023-06-30 T12:34:56.199973+0300"
}
}