B2BH2H

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

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

escrow

Описание

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

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

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

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

Пример запроса
Язык
1curl --location --globoff --request POST 'https://baas.alfabank.ru/api/jp/v1/escrow-orders/{referenceID}/cancel' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "referenceID": "EA10509220000013",
3  "status": "EA10509220000013"
4}
BODY
атрибут
описание
referenceID
stringrequired

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

status
stringoptional

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

  • CLIENT_CANCELLED - заявка отменена
Пример ответа 200 (OK)
1{
2  "referenceID": "EA10509220000013",
3  "status": "EA10509220000013"
4}
BODY
атрибут
описание
error
stringrequired

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

  • invalid_request - неверные входные параметры запроса
error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

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

  • invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

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

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

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

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

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

  • unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

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

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

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

  • internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

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

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

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