Создать Hold
Метод:
POST
URL: BASE_URL/merchant/payment/hold/create/
Заголовок:
http
Authorization: Bearer <ACCESS_TOKEN>Тело запроса
| Поле | Пример данных | Тип | Требуется | Описание |
|---|---|---|---|---|
| amount | 1000 | int | Да | Сумма в SUM (1000 = 1000 SUM) |
| userId | 123 | string | Нет | Пользователь ID заявлен мерчантом |
| account | {"field_name": "sample data"} | dict | Нет | Отправьте пустой dict {}, если нет дополнительных данных |
| cardId | 9f877739-bc25-4f0f-a13f-ec485fd04250 | string | Да | Карта ID создана в системе Paylov |
| time | 10 | int | Да | Время выдержки в минутах. Макс.: 40320 (28 дней) |
| externalId | externalId1 | string | Нет | Внешний ID. Максимальная длина: 64 символа |
| serviceId | 9f877739-bc25-4f0f-a13f-ec485fd04250 | string | Нет | Предоставлено Платежной системой |
json
{
"userId": "string",
"cardId": "string",
"amount": 10, # 10 = 10 Sum
"account": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"time": 10,
"externalId": "string", # max_chars: 64
"serviceId": "uuid"
}| Поле | Тип | Требуется | Описание |
|---|---|---|---|
| userId | string | Да | Уникальный идентификатор пользователя. |
| cardId | string | Да | Уникальный идентификатор карты, используемой в удержании. |
| amount | integer | Да | Сумма, которую необходимо удерживать. (сумма в сумме) |
| account | object | Нет | Содержит дополнительные свойства учетной записи. |
account.additionalProp1 | string | Необязательно | Данные пользовательского аккаунта. |
account.additionalProp2 | string | Необязательно | Данные пользовательского аккаунта. |
account.additionalProp2 | string | Необязательно | Данные пользовательского аккаунта. |
| time | integer | Да | Продолжительность удержания в минутах. Максимально допустимое значение — 28 дней (40320 минут). |
Успешный ответ
json
{
"result": {
"transactionId": "uuid4"
}
}| Поле | sample_data | Тип | Описание |
|---|---|---|---|
| transactionId | uuid4 | string | Уникальный идентификатор пользователя. |