B2BH2H

Отмена заявки на резервирование счета эскроу

Пром POST https://baas.alfabank.ru/api/jp/v1/escrow-orders/{referenceID}/cancel

Песочница POST https://sandbox.alfabank.ru/api/jp/v1/escrow-orders/{referenceID}/cancel

Scope

escrow

Описание

Метод позволяет отменять заявку на резервирование счета эскроу в статусе "На подписании".

Параметры запроса

HEADER
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

PATH
Атрибут
Описание
referenceID
stringrequired

Номер заявки на резервирование счета эскроу

Пример запроса
curl -X POST https://baas.alfabank.ru/api/jp/v1/escrow-orders/{referenceID}/cancel \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json'

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

Пример ответа 200 (OK)
{
  "referenceID": "EA1311022000001",
  "status": "CLIENT_CANCELLED"
}
referenceID
stringrequired

Номер заявки на резервирование счета эскроу

status
stringoptional

Статус заявки. Принимает возможные значения: CLIENT_CANCELLED - Заявка отменена

Пример ответа 200 (OK)
{
  "referenceID": "EA1311022000001",
  "status": "CLIENT_CANCELLED"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Request is missing a required parameter: amount"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope ;
  • •
    access_denied - Доступ к счёту запрещён
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - Эндпоинт не найден или неактивен;
  • •
    not_found - Платёж не найден или пока не исполнен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Пример ответа 429 (Too Many Requests)
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Пример ответа 503 (Service Unavailable)
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.

Удаление черновика заявки на резервирование счета эскроуСоздание заявки на резервирование счета эскроу c расширенными параметрами