Холдирование

Холдирование — это временная блокировка определённой суммы на карте без фактического её списания. Захолдированные средства могут быть использованы в качестве способа оплаты для совершения покупки.


Структура

  • Name
    id
    Type
    string
    Description

    Идентификатор холдирования.

  • Name
    created_at
    Type
    string
    Description

    Дата холдирования в формате ISO-8601.

  • Name
    amount
    Type
    integer
    Description

    Захолдированная сумма в тийинах.

  • Name
    dismissed
    Type
    boolean
    Description

    Флаг снятия холдирования. Равен true, когда:

    • захолдированные средства были списаны
    • холдирование было отменено по запросу
    • холдирование было отменено по истечении срока холдирования (30 дней)
{
  "id": "035033da-4065-4c5b-adac",
  "amount": 4000000,
  "created_at": "2023-08-04T08:34:52Z",
  "dismissed": false
}

POST/hold

Холдирование

Холдирует (замораживает) указанную сумму средств на карте.

Параметры

  • Name
    id
    Type
    string
    Description

    Уникальный (для клиента API) идентификатор операции. Используется в дальнейшем при покупке с помощью захолдированных средств.

  • Name
    amount
    Type
    integer
    Description

    Холдируемая сумма в тийинах.

  • Name
    token
    Type
    string
    Description

    Токен карты.

Запрос

{
  "id": "035033da-4065-4c5b-adac",
  "amount": 4000000,
  "token": "62d602f4-115d-46ce-a385"
}

Ответ

{
  "id": "035033da-4065-4c5b-adac",
  "amount": 4000000,
  "created_at": "2023-08-04T08:34:52Z",
  "dismissed": false
}

POST/dismissHold

Отмена холдирования

Отменяет осуществлённое ранее холдирование средств.

Параметры

  • Name
    id
    Type
    string
    Description

    Идентификатор осуществлённого ранее холдирования.

Запрос

POST
/dismissHold
{
  "id": "035033da-4065-4c5b-adac"
}

Ответ

{
  "id": "035033da-4065-4c5b-adac",
  "amount": 4000000,
  "created_at": "2023-08-04T08:34:52Z",
  "dismissed": true
}

POST/getHold

Информация о холдировании

Возвращает актуальную информацию о холдировании.

Параметры

  • Name
    id
    Type
    string
    Description

    Идентификатор осуществлённого ранее холдирования.

Запрос

POST
/getHold
{
  "id": "035033da-4065-4c5b-adac"
}

Ответ

{
  "id": "035033da-4065-4c5b-adac",
  "amount": 4000000,
  "created_at": "2023-08-04T08:34:52Z",
  "dismissed": false
}