Получение списка платежей по сделке

Песочница

GET https://sandbox.alfabank.ru/api/na/jp/v1/deals/{dealId}/payoffs

Пром

GET https://baas.alfabank.ru/api/na/jp/v1/deals/{dealId}/payoffs

Scope

deals

Описание

Метод позволяет получить список выплат по сделке по dealId.

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

PATH

Атрибут

Описание

dealId

stringrequired

Идентификатор сделки

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

Язык

1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/deals/{dealId}/payoffs' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

Пример ответа 200 (OK)

1[
2  {
3    "stepId": "f099f9dd-d5e7-4ab3-89f5-24932aa808ad",
4    "payoffId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5    "payoffType": "EXTERNAL",
6    "deponents": [
7      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
8    ],
9    "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10    "amount": "100.01",
11    "status": "PENDING"
12  }
13]

BODY

атрибут

описание

stepId

stringoptional

Идентификатор этапа сделки

payoffId

stringoptional

Идентификатор платежа (внутреннего или внешнего)

payoffType

stringoptional

Тип платежа. Принимает возможные значения:

•

EXTERNAL - внешний (выплата с номинального счёта);
•

INTERNAL - внутренний (выплата внутри номинального счёта)

deponents

array of stringsoptional

Список идентификаторов депонентов

recipientId

stringoptional

Идентификатор реципиента

amount

numberoptional

Сумма в рублях

status

stringoptional

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

•

PENDING - запрос в процессе обработки;
•

MANUAL_ACCEPTANCE - ожидание ручного подтверждения отправки запроса-дубля на обработку;
•

AWAIT_EXTERNAL - ожидание исполнения внешнего платежа;
•

FAILED - обработка запроса завершилась ошибкой;
•

FAILED_DUPLICATE - обработка запроса-дубля отклонена;
•

READY - обработка запроса завершилась успешно

Пример ответа 200 (OK)

1[
2  {
3    "stepId": "f099f9dd-d5e7-4ab3-89f5-24932aa808ad",
4    "payoffId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5    "payoffType": "EXTERNAL",
6    "deponents": [
7      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
8    ],
9    "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10    "amount": "100.01",
11    "status": "PENDING"
12  }
13]

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 - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent

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}

Нет тела ответа