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

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

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

POST {reseller_domain}/internal_api/accounts/{account_id}/guaranteed_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)

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

Название			Тип данных	Описание
data			object	Данные ответа
	id		string	ID обещанного платежа
	type		string	Тип данных
	attributes		object	Информация об обещанном платеже
		created_at	string	Дата и время создания обещанного платежа
		document_id	string	Номер обещанного платежа
		status	string	Статус обещанного платежа (см. ): provided — Предоставлен — обещанный платеж создан, баланс аккаунта увеличен на его сумму. revoked — Отозван — обещанный платеж отозван вручную менеджером, или автоматически в дату истечения, или в результате пополнения баланса аккаунта на сумму, равную или большую сумме обещанного платежа. revoked_because_of_top_up — Отозван в связи с пополнением баланса — обещанный платеж отозван автоматически в результате пополнения баланса аккаунта на сумму, меньшую суммы обещанного платежа. provided because_of_top_up — Предоставлен в связи с пополнением баланса — новый обещанный создан автоматически в результате пополнения баланса аккаунта на сумму, меньшую суммы обещанного платежа.
		total	number	Сумма обещанного платежа в валюте реселлера
		reseller_currency_iso_code	string	Код валюты реселлера
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts/1938/guaranteed_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" : 708.52
        }
    }
}'

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

JSON

{
    "data": {
        "id": "201",
        "type": "guaranteed_payments",
        "attributes": {
            "document_id": "GP000187",
            "created_at": "2023-01-25T11:32:34.573340+0300",
            "expiration_date": "2023-02-01",
            "revoke_date": null,
            "status": "provided",
            "total": 708.52,
            "reseller_currency_iso_code": "USD"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}