Files
alfa-bank-sdk/_docs/alfabank/endpoints.md

17 KiB
Raw Blame History

Карта эндпоинтов Alfa API

Метод Путь Файл Описание
GET /api/endpoint Управление API Key
GET /api/endpoint TLS-сертификат
POST /api/gd/v1/crypto-service/certificates Добавление нового сертификата
GET /api/gd/v1/crypto-service/certificates Получение сертификатов
PATCH /api/gd/v1/crypto-service/certificates/{id} Обновление сертификата
POST /api/na/jp/v1/beneficiaries Создание запроса на регистрацию бенефициара
GET /api/na/jp/v1/beneficiaries/requests/{requestId}/status Получение статуса запроса
GET /api/na/jp/v1/beneficiaries/{beneficiaryId} Получение информации о бенефициаре H2H
PUT /api/na/jp/v1/beneficiaries/{beneficiaryId} Создание запроса на изменение информации о бенефициаре
GET /api/na/jp/v1/beneficiaries/{beneficiaryId}/balance Получение информации о балансе бенефициара
POST /api/na/jp/v1/beneficiaries/{beneficiaryId}/requisites Добавление платёжных реквизитов бенефициара
GET /api/na/jp/v1/beneficiaries/{beneficiaryId}/requisites Получение платёжных реквизитов бенефициара
PATCH /api/na/jp/v1/beneficiaries/{beneficiaryId}/requisites/{requisiteId} Изменение признаков платёжных реквизитов бенефициара
POST /api/na/jp/v1/beneficiaries/{beneficiaryId}/scoring Создание запроса на проверку бенефициара
GET /api/na/jp/v1/beneficiaries/{beneficiaryId}/transactions Получение списка денежных операций бенефициара
POST /api/na/jp/v1/deals Регистрация сделки
PATCH /api/na/jp/v1/deals/action Выполнение действия по сделке
POST /api/na/jp/v1/deals/steps Выполнение действия по этапам сделки
PATCH /api/na/jp/v1/deals/steps/contractors Выполнение действия по участникам этапа сделки
GET /api/na/jp/v1/deals/{dealId} Получение информации о сделке
PATCH /api/na/jp/v1/deals/{dealId}/is-valid Проверка возможности осуществления выплат по сделке
GET /api/na/jp/v1/deals/{dealId}/payoffs Получение списка платежей по сделке
GET /api/na/jp/v1/deals/{dealId}/requests/{requestId}/status Получение статуса запроса на завершение этапа сделки
GET /api/na/jp/v1/deals/{dealId}/steps Получение списка этапов сделки
GET /api/na/jp/v1/deals/{dealId}/steps/{stepId} Получение информации об этапе сделки
GET /api/na/jp/v1/deals/{dealId}/steps/{stepId}/contractors Получение информации об участниках этапа сделки
GET /api/na/jp/v1/nominal-accounts Получение списка номинальных счетов
POST /api/na/jp/v1/payoffs Создание запроса на выплату с номинального счёта
GET /api/na/jp/v1/unidentified-transactions Получение списка неидентифицированных пополнений номинального счёта
POST /api/na/jp/v1/unidentified-transactions/{id}/identify Создание запроса на идентификацию пополнения номинального счёта
GET /api/na/jp/v1/unidentified-transactions/{id}/identify/{identifyId} Получение статуса запроса на идентификацию пополнения номинального счёта
POST /api/na/jp/v1/unidentified-transactions/{id}/refunds Создание запроса на возврат неидентифицированного пополнения
GET /api/na/jp/v1/unidentified-transactions/{id}/refunds/{refundId} Получение статуса запроса на возврат неидентифицированного пополнения
POST /api/na/jp/v1/universal-recipients Создание запроса на регистрацию универсального реципиента
GET /api/na/jp/v1/universal-recipients Получение списка универсальных реципиентов номинального счёта
GET /api/na/jp/v1/universal-recipients/{universalRecipientId} Получение информации об универсальном реципиенте
POST /api/na/jp/v1/universal-recipients/{universalRecipientId}/requisites Добавление платёжных реквизитов универсального реципиента
GET /api/na/jp/v1/universal-recipients/{universalRecipientId}/requisites Получение платёжных реквизитов универсального реципиента
PATCH /api/na/jp/v1/universal-recipients/{universalRecipientId}/requisites/{requisiteId} Изменение признаков платёжных реквизитов универсального реципиента
POST /api/signature-encryption-tests/json Формат исходного сообщения JSON
POST /api/signature-encryption-tests/text Формат исходного сообщения TXT
POST /api/signature-encryption-tests/xml Формат исходного сообщения XML
GET /api/v1/endpoint Начало работы в песочнице
POST /api/v1/webhook-events Партнёрский метод для получения вебхуков
POST /api/v1/webhooks Создание вебхука
POST /api/v1/webhooks-events Проверка работы вебхука
DELETE /api/v1/webhooks/f9f8c674-7a2a-4297-bdb8-ddd3013de3a3?object=ul_transaction_default Удаление вебхука
DELETE /api/v1/webhooks/{id} Удаление вебхука
PUT /api/v2/webhooks/f9f8c674-7a2a-4297-bdb8-ddd3013de3a3 Редактирование вебхука
GET /api/v2/webhooks/f9f8c674-7a2a-4297-bdb8-ddd3013de3a3?object=ul_transaction_default Получение вебхука
GET /api/v2/webhooks/{id} Получение вебхука
PUT /api/v2/webhooks/{id} Редактирование вебхука
GET /api/v2/webhooks?offset=20&limit=10&object=ul_transaction_default Получение списка вебхуков
PUT /filebox/secure-file-transfer.incoming-files.to-processing/12345678-90AB-CDEF-1234-1234567890AB?X-Amz-Date=20230608T152952Z&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fbaas%2Fs3%2Faws4_request&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8 Загрузка файла
GET /filebox/secure-file-transfer.incoming-files.to-processing/12345678-90ab-cdef-1234-1234567890ab?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=e78c051fcff1017a68795620c20e50db33126ab8374c2ee9644ef4743b3625c6 Скачивание файла
GET /oidc/authorize?response_type=code&client_id=0cee0683-85ae-49f2-a63d-29f97aad1911&redirect_uri=https%3A%2F%2Fwwww.partner.ru%2Fcode&scope=openid&state=abcdef Получение кода авторизации
GET /oidc/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope={scope}&state={state} Получение кода авторизации
GET /oidc/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope={scope}&state={state} Получение кода авторизации
GET /oidc/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope={scope}&state={state} Получение кода авторизации
GET /oidc/client-consents Данные по согласиям пользователей
POST /oidc/clients/{clientId}/client-secret Client secret
POST /oidc/revoke Отзыв токена доступа
POST /oidc/token Обновление токена доступа
POST /oidc/token Как использовать CCF (Client Credentials Flow)
POST /oidc/token Обновление токена доступа
POST /oidc/token Получение токена доступа H2H POST
GET /oidc/userinfo Получение профиля представителя пользователя B2B B2C