app.swaggerhub.com Open in urlscan Pro
52.204.7.246  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Log In


EBANQ REST API

 1.34.0 

OAS 3.0


INTRODUCTION:

The EBANQ REST API permits applications to connect securely to the EBANQ
software to carry out a multitude of operations. Depending on the operations in
question, authentication and token-based access control is enforced.

To interact with your EBANQ system via the EBANQ API you need to send requests
to the backend (API) URL. This base URL can be determined by prepending “api-“
to your EBANQ system’s URL. If your EBANQ system is hosted at
https://login.mydomain.com then the base API URL will be
https://api-login.mydomain.com .

The documentation that follows is intended for developers, providing an
introduction to using the API and additionally describing all currently
available endpoints. We recommend you read the documentation to familarise
yourself with conventions, parameters and response structure. A dedicated
sandbox for testing purposes can be made available to clients upon request.

Please contact help@ebanq.com should you have additional questions or require
support.


TOKENS:

NameToken typeDescriptionDefault lifetime Access tokenJWT., Bearer tokenUsed to
make requests to the API30m Refresh tokenJWT tokenUsed to update access and
refresh tokens pair30d


ACCESS TOKEN USAGE

API requests (where authorisation is required) must include the bearer access
token in the header.

Once the access token expires it should be refreshed.

In order to prevent JWT token sidejacking, a signature token_signature is
provided as a cookie. This cookie should be sent with each request to the
private route along with the JWT token. For an application that can’t use
cookies, the auth service provides the header X-Token-Signature that contains
the signature. The application is in charge of storing this value and updating
along with refreshing the JWT token. This value should be attached to each
request to the private route as a header X-Token-Signature.


HOW TO DETERMINE IF THE TOKEN HAS EXPIRED

 1. The API returns a 401 error.
 2. Check the exp field in the token payloads.


REFRESH TOKEN USAGE

Refresh token is only used to update access and refresh tokens.

After completing the request, old tokens (access and refresh) are invalidated
and new tokens must be saved and used in subsequent requests.


TOKEN STRUCTURE:

Key nameDescription subSubject: access or refresh expExpiration date and time in
UNIX format uidToken owner ID firstNameFirst name of the token owner
lastNameLast name of the token owner usernameUsername of the token owner
roleNameRole name of the token owner


TIMESTAMPS:

RFC3339 is used for the time in requests and responses.

Authorize



ACCOUNTS

POST
/accounts/private/v1/accounts
Create a new account as admin.
GET
/accounts/private/v1/accounts
Show list of accounts belonging to the user.
PUT
/accounts/private/v1/accounts/{id}
Update an existing account by ID as admin.
GET
/accounts/private/v1/accounts/{id}
Shows an account by passed ID.
GET
/accounts/private/v1/admin/accounts
Show list of accounts for admins.
GET
/accounts/private/v1/admin/accounts/corporate/{userID}
Returns a list of accounts for admins.
GET
/accounts/private/v1/admin/accounts-list/corporate/profile-id/{profileID}
Returns a list of accounts for admins.
GET
/accounts/private/v1/admin/accounts-list
Returns a file with accounts.
GET
/accounts/private/v1/accounts-list
Returns a list of accounts associated with the current end user.
GET
/accounts/private/v1/admin/export/accounts/async
Responds with a file with accounts via the queue.
GET
/accounts/private/v1/admin/export/accounts
Returns a file with accounts.
POST
/accounts/private/v1/generate/accounts/number
Get a new account number.


CARDS

GET
/accounts/private/v1/admin/export/cards/async
Responds with a file with cards for admins via the queue.
POST
/accounts/private/v1/cards
Create a new card as admin.
GET
/accounts/private/v1/cards
Show list of cards for admin.
GET
/accounts/private/v1/card/availability
Check if Cards feature is enabled and available for corporate users according to
the settings.
GET
/accounts/private/v1/own-cards
Show list of cards for current user.
GET
/accounts/private/v1/cards/{id}
Shows a card by passed ID.
PUT
/accounts/private/v1/cards/{id}
Update a card as an admin by passed id.
PATCH
/accounts/private/v1/cards/{id}
Update a card as an admin by passed id.
GET
/accounts/private/v1/admin/export/cards
Responds with a file with cards for admins.


TRANSACTIONS

GET
/accounts/private/v1/user/export/transactions-report/async
Responds with a file with transactions for account via the queue.
GET
/accounts/private/v1/user/transactions/{id}
Fetch transaction by transaction ID.
GET
/accounts/private/v1/user/transactions
Shows list of transactions for current user.
GET
/accounts/private/v1/user/export/transactions-report
Returns a file with transactions for account.
GET
/accounts/private/v1/user/info/transactions
Shows list of transactions for current user.


ACCOUNT TYPES

POST
/accounts/private/v1/account-types
Create a new account type as admin.
GET
/accounts/private/v1/account-types
Show list of account types.
PUT
/accounts/private/v1/account-types/{id}
Update an existing account type as an admin by passed id.
GET
/accounts/private/v1/account-types/{id}
Shows an account type by passed id.
DELETE
/accounts/private/v1/account-types/{id}
Delete an existing account type as an admin by passed id.


REVENUE ACCOUNTS

GET
/accounts/private/v1/revenue-accounts
Show list of revenue accounts.
GET
/accounts/private/v1/revenue-accounts/{id}
Get a revenue account by passed ID.


CARD TYPES

POST
/accounts/private/v1/card-types
Create a card type as admin.
GET
/accounts/private/v1/card-types
Show list of card types.
GET
/accounts/private/v1/admin/card-types/categories
Show list of card type categories.
GET
/accounts/private/v1/admin/card-types/formats
Show list of card type formats.
GET
/accounts/private/v1/card-types/{id}
Show a card type by passed ID.
PUT
/accounts/private/v1/card-types/{id}
Update card type as admin by passed ID.
PATCH
/accounts/private/v1/card-types/{id}
Update card type as admin by passed ID.
DELETE
/accounts/private/v1/card-types/{id}
Delete a card type by ID as admin.


TRANSFER FEE

POST
/accounts/private/v1/admin/fee/transfer
Creates new transfer fee.
GET
/accounts/private/v1/admin/fee/transfer/id/{id}
Get transfer fee.
DELETE
/accounts/private/v1/admin/fee/transfer/id/{id}
Delete transfer fee
POST
/accounts/private/v1/admin/fee/transfer/id/{id}
Update transfer fee.
GET
/accounts/private/v1/admin/fee/transfer/subject/{requestSubject}
Get transfer fees list.
GET
/accounts/private/v1/user/fee/transfer/subject/{requestSubject}
Get transfer fees list.
GET
/accounts/private/v1/admin/fee/transfer/parameters/{id}
Get transfer fee parameters list.


SETTINGS

GET
/accounts/private/v1/settings
Get settings list.
POST
/accounts/private/v1/settings
Updates settings.
GET
/accounts/private/v1/settings/{name}
Retrieve setting by name.
POST
/accounts/private/v1/settings/{name}
Updates setting by name.
GET
/currencies/private/v1/admin/settings/main
Shows current settings.
PUT
/currencies/private/v1/admin/settings/main
Updates settings.
PATCH
/currencies/private/v1/admin/settings/main
Updates settings.
GET
/notifications/private/v1/settings
Shows a list of all settings.
PUT
/notifications/private/v1/settings
Updates settings.
GET
/notifications/private/v1/settings/tokens
Returns notification tokens list.
GET
/notifications/public/v1/settings/email-from
Shows email-from setting.


TANS

GET
/accounts/private/v1/user/tan/count
Counts active TANs for current logged user.
POST
/accounts/private/v1/user/tan
Request new TAN by SMS
GET
/accounts/private/v1/user/tan/request/availability
Check if TAN by SMS request feature is enabled and available.
GET
/accounts/private/v1/admin/tan/tan-by-sms/activity
Retrieves "TAN by SMS" extension activity status.
GET
/accounts/private/v1/admin/tan/count/{userId}
Counts active TANs by user ID.


OTPS

POST
/accounts/private/v1/admin/tan/{userId}
Generates OTPs for user.


USER REQUEST TEMPLATES

GET
/accounts/private/v1/user/templates/TBU
Shows list of saved TBU templates
GET
/accounts/private/v1/user/templates
Shows list of saved templates
GET
/accounts/private/v1/user/templates/CFT
Shows list of saved CFT templates
GET
/accounts/private/v1/user/templates/OWT
Shows list of saved OWT templates
DELETE
/accounts/private/v1/user/templates/{id}
Deletes a request template by id.


COUNTRIES

GET
/accounts/public/v1/countries
Shows list of all countries.
GET
/accounts/public/v1/countries/{id}
Shows a country by passed id.


SEPA

GET
/accounts/private/v1/iban/validate/{countryCode}/{ibanNumber}
Validates the IBAN number.
GET
/accounts/private/v1/bic/validate/{countryCode}/{bicCode}
Validates the BIC code.


PAYMENT PERIODS

GET
/accounts/private/v1/payment-periods
Shows list of all payment periods.


PAYMENT METHODS

GET
/accounts/private/v1/payment-methods
Shows a list of the interest calculation methods available.


IWT BANK ACCOUNTS

POST
/accounts/private/v1/iwt-bank-accounts
Create a new IWT bank account as an admin.
GET
/accounts/private/v1/iwt-bank-accounts
Show list of IWT bank accounts.
PUT
/accounts/private/v1/iwt-bank-accounts/{id}
Update an existing IWT bank account as an admin by passed id.
GET
/accounts/private/v1/iwt-bank-accounts/{id}
Shows an IWT bank account by passed id.
DELETE
/accounts/private/v1/iwt-bank-accounts/{id}
Delete a IWT bank account by id as an admin.
GET
/accounts/private/v1/iwt-bank-accounts/{id}/by-account-id
Shows an IWT bank account by an account id.
GET
/accounts/private/v1/iwt-bank-accounts/{id}/pdf-for-account/{iwtId}
Shows an IWT bank account by an account id.


FORMS

GET
/accounts/private/v1/form/{model}/{type}
Return list of fields with validators for requested model


REQUESTS

GET
/accounts/private/v1/requests/{requestId}
Show a request details.
GET
/accounts/private/v1/corporate/requests/{requestId}
Returns the details for the transfer request related to the corporate account.
PATCH
/accounts/private/v1/admin/requests/{requestId}
Update convertion rate as an admin.
POST
/accounts/private/v1/admin/requests/execute/{requestId}
Executes pending request.
POST
/accounts/private/v1/admin/requests/cancel/{requestId}
Cancels pending request.
POST
/accounts/private/v1/corporate/requests/approve/{requestId}
Approves a request that is pending internal approval.
POST
/accounts/private/v1/corporate/requests/cancel/{requestId}
Cancels a request that is pending internal approval.
POST
/accounts/private/v1/admin/requests/csv/update
Updates requests from csv file.
POST
/accounts/private/v1/admin/requests/csv/update/async
Updates requests from csv file via the queue.
POST
/accounts/private/v1/admin/requests/csv/import
Imports requests from csv file.
POST
/accounts/private/v1/admin/requests/csv/import/async
Imports requests from csv file via the queue.
GET
/accounts/private/v1/requests
Show list of requests.
GET
/accounts/private/v1/user/requests
Shows list of requests for user.
GET
/accounts/private/v1/corporate/requests
Returns a list of requests related to the corporate accounts.
GET
/accounts/private/v1/admin/export/transfer-requests
Responds with a file with requests for admins.
GET
/accounts/private/v1/admin/export/transfer-requests/async
Responds with a file with requests for admins via the queue.
GET
/accounts/private/v1/corporate/export/requests
Returns a file with requests for corporate users according to their assigned
role’s privileges.


EXPORT PDF

GET
/accounts/private/v1/user/export/transactions/pdf
Responds with a file with transactions for clients.
GET
/accounts/public/v1/user/export/transactions/pdf/{filename}
Preview a file with transactions for clients.
GET
/accounts/public/v1/user/export/corporate/requests/pdf/{filename}
Preview a file with requests related to the corporate accounts.
GET
/accounts/private/v1/admin/export/transactions/pdf
Responds with a file with transactions for admins.
GET
/accounts/private/v1/admin/export/manual-transactions/pdf
Responds with a file with manual transactions for admins.
GET
/accounts/private/v1/admin/export/outgoing-transfer/pdf
Responds with a file with OWT transactions for admins.
GET
/accounts/private/v1/admin/export/interests/pdf
Responds with a file with Interests report for admins.
GET
/accounts/private/v1/admin/export/revenue/pdf
Responds with a file with Revenue report for admins.
GET
/accounts/private/v1/admin/export/accounts/pdf
Responds with a file with accounts for admins.
GET
/accounts/private/v1/admin/export/maturity/pdf
Responds with a file with maturity accounts for admins.
GET
/accounts/public/v1/admin/export/transactions/pdf/{filename}
Preview a file with transactions for admins.
GET
/accounts/public/v1/admin/export/manual-transactions/pdf/{filename}
Preview a file with manual transactions for admins.
GET
/accounts/public/v1/admin/export/outgoing-transfer/pdf/{filename}
Preview a file with OWT transactions for admins.
GET
/accounts/public/v1/admin/export/interests/pdf/{filename}
Preview a file with interests for admins.
GET
/accounts/public/v1/admin/export/revenue/pdf/{filename}
Preview a file with revenue transactions for admins.
GET
/accounts/public/v1/admin/export/accounts/pdf/{filename}
Preview a file with accounts for admins.
GET
/accounts/public/v1/admin/export/maturity/pdf/{filename}
Preview a file with maturity accounts for admins.


CORPORATE MODULE

GET
/accounts/private/v1/corporate/availability
Get corporate module availability.
GET
/accounts/private/v1/corporate/my-roles
Get the list of the corporate roles assigned to the current user.
GET
/accounts/private/v1/corporate/my-accounts
Get the list of the corporate accounts assigned to the current user.
GET
/accounts/private/v1/corporate/my-profiles
Get the list of the corporate profiles where the current user is a member.
GET
/accounts/private/v1/corporate/user/info
Get the corporate user information.
GET
/accounts/private/v1/corporate/profile/{id}
Get corporate profile.
GET
/accounts/private/v1/admin/corporate/profiles
Get the list of the corporate profiles.
POST
/accounts/private/v1/admin/corporate/profiles
Create a new corporate profile.
GET
/accounts/private/v1/admin/export/corporate/profiles
Export the list of the corporate profiles to CSV file.
GET
/accounts/private/v1/admin/corporate/profile/{id}
Get corporate profile.
POST
/accounts/private/v1/admin/corporate/profile/{id}
Edit corporate profile.
GET
/accounts/private/v1/admin/corporate/roles
Get the list of the corporate roles.
POST
/accounts/private/v1/admin/corporate/roles
Create a new corporate role.
GET
/accounts/private/v1/admin/corporate/unassign/validation/{id}
Get a list of corporate accounts with approval flow enabled where the user is
assigned.
POST
/accounts/private/v1/admin/corporate/role/{id}
Edit corporate profile.


IMPORT OWT REQUESTS

POST
/accounts/private/v1/owt-requests/import/csv/async
Import OWT requests via the queue.
GET
/accounts/private/v1/admin/owt-requests/import/permissions/corporate-user
/{ownerID}
Get permission by owner ID for importing OWT requests in bulk.
POST
/accounts/private/v1/admin/owt-requests/import/permissions/corporate-user
/{typeId}
Set corporate member permission for OWT importing.


TBA(TRANSFER BETWEEN ACCOUNTS) REQUESTS

POST
/accounts/private/v1/tba-requests/preview
Makes request evaluation for TBA.
POST
/accounts/private/v1/tba-requests
Creates a new request between accounts.
POST
/accounts/private/v1/admin/tba-requests/preview/user/{userId}
Makes evaluation of TBA request.
POST
/accounts/private/v1/admin/tba-requests/user/{userId}
Creates a new TBA request.


TBU(TRANSFER BETWEEN USERS) REQUESTS

POST
/accounts/private/v1/tbu-requests/preview
Makes evaluation request for transfer between users.
POST
/accounts/private/v1/tbu-requests
Creates a new request between users.
POST
/accounts/private/v1/admin/tbu-requests/preview/user/{userId}
Evaluates a TBU request.
POST
/accounts/private/v1/admin/tbu-requests/user/{userId}
Creates a new TBU request.


OWT(OUTGOING WIRE TRANSFER) REQUESTS

POST
/accounts/private/v1/owt-requests/preview
Evaluates a OWT request.
POST
/accounts/private/v1/owt-requests
Creates a new OWT Request.
POST
/accounts/private/v1/admin/owt-requests/preview/user/{userId}
Evaluates request for OWT.
POST
/accounts/private/v1/admin/owt-requests/user/{userId}
Creates a new OWT request.


SEPA REQUESTS

POST
/accounts/private/v1/sepa-requests/preview
Makes evaluation of SEPA request.
POST
/accounts/private/v1/sepa-requests
Creates a new SEPA Request.
POST
/accounts/private/v1/admin/sepa-requests/preview/user/{userId}
Makes evaluation request for SEPA.
POST
/accounts/private/v1/admin/sepa-requests/user/{userId}
Creates a new SEPA request.
GET
/accounts/private/v1/sepa-requests/availability
Returnes the availability params for the SEPA transfers module.


CFT(CARD FUNDING TRANSFER) REQUESTS

POST
/accounts/private/v1/cft-requests/preview
Evaluates a CFT request.
POST
/accounts/private/v1/cft-requests
Creates a new CFT request.
POST
/accounts/private/v1/admin/cft-requests/preview/user/{userId}
Evaluates a CFT request.
POST
/accounts/private/v1/admin/cft-requests/user/{userId}
Creates a new CFT request.


CA(CREDIT ACCOUNT) REQUESTS

POST
/accounts/private/v1/admin/ca-requests/preview
Evaluates a CA request.
POST
/accounts/private/v1/admin/ca-requests
Creates a new CA request.


DA(DEBIT ACCOUNT) REQUESTS

POST
/accounts/private/v1/admin/da-requests/preview
Evaluates a DA request.
POST
/accounts/private/v1/admin/da-requests
Creates a new DA request.


DRA(DEDUCT REVENUE ACCOUNT) REQUESTS

POST
/accounts/private/v1/admin/dra-requests/preview
Makes an evaluation of DRA request.
POST
/accounts/private/v1/admin/dra-requests
Creates a new DRA request.


WEBHOOK

GET
/accounts/private/v1/admin/requests/webhook/failed-payloads
List all failed payloads
GET
/accounts/private/v1/admin/requests/webhook/failed-payloads/{id}
Get a specific failed payload
GET
/accounts/private/v1/admin/requests/webhook/failed-payloads/{id}/retry
Retry a specific failed payload


AUTH

GET
/users/private/v1/auth/me
Get current user by AccessToken
POST
/users/public/v1/auth/signin-device
Receive access and refresh tokens by device id and pin.
POST
/users/public/v1/auth/signup
Sign Up
DELETE
/users/private/v1/auth/logout
Sign Out
POST
/users/private/v1/auth/logout-device
Sign Out Device
POST
/users/public/v1/auth/forgot_password
Forgot Password
POST
/users/public/v1/auth/reset_password
Reset Password
GET
/users/public/v1/auth/refresh
Refresh token
POST
/users/private/v1/auth/change_password
Change Password
POST
/users/public/v1/auth/set-password
Set user password


AUTH

POST
/users/private/v1/auth/short-tokens
Create new short token
POST
/users/public/v1/auth/signin
Receive access and refresh tokens by credentials


SECURITY QUESTIONS

GET
/users/public/v1/security-questions
Get list of security questions


CURRENCY

GET
/currencies/private/v1/currencies/{id}
Shows a currency by passed id.
GET
/currencies/private/v1/currencies
Shows list of currencies.
GET
/currencies/private/v1/admin/currencies
Shows a list of currencies.
PATCH
/currencies/private/v1/admin/currencies
Updates currencies by passed ids.
GET
/currencies/private/v1/admin/currencies/{id}
Shows currency by passed id.


RATES

GET
/currencies/private/v1/rates/main
Shows list of rates for current main currency.
GET
/currencies/private/v1/rates/pair
Shows rate and exchange margin for two currencies.
PATCH
/currencies/private/v1/admin/rates
Updates rates.


CRYPTO RATE FEED

GET
/currencies/private/v1/admin/crypto/rates/settings
Retrieves "Crypto Rate Feed" settings.
POST
/currencies/private/v1/admin/crypto/rates/settings
Update "Crypto Rate Feed" settings.
GET
/currencies/private/v1/admin/crypto/rates/providers
Retrieves "Crypto Rate Feed" providers.


CUSTOMIZATION

POST
/customization/private/v1/color-schemes
Creates a new color scheme.
GET
/customization/private/v1/color-schemes
Shows a list of color schemes.
GET
/customization/private/v1/color-schemes/{id}
Shows a color scheme by passed id.
PUT
/customization/private/v1/color-schemes/{id}
Updates color scheme by id.
DELETE
/customization/private/v1/color-schemes/{id}
Deletes color scheme.
PUT
/customization/private/v1/color-schemes/set-as-active/{id}
Applies color scheme by passed id.
GET
/customization/public/v1/color-schemes/get-active
Shows active color scheme.
GET
/customization/public/v1/logo-settings
Shows a logo settings.
PUT
/customization/private/v1/logo-settings
Updates logo settings.
POST
/customization/private/v1/logo
Uploads temporary logo.
POST
/customization/private/v1/favicon
Uploads temporary icon.
GET
/customization/private/v1/icons/{type}
Shows a list of available icons.
GET
/customization/assets/icon/{iconName}
Provides an icon.
GET
/customization/public/v1/gdpr
Shows GDPR text.
PUT
/customization/private/v1/gdpr
Updates GDPR text.
GET
/customization/public/v1/site-texts
Shows "Site texts".
PUT
/customization/private/v1/site-texts
Updates "Site texts".


FILES

GET
/files/private/v1/files/{id}
Returns file info by id.
DELETE
/files/private/v1/files/{id}
Deletes file by id.
POST
/files/private/v1/files/public/{uid}
Uploads public file.
POST
/files/private/v1/files/private/{uid}
Uploads private file.
POST
/files/private/v1/files/admin-only/{uid}
Uploads file visible by admins.
POST
/files/private/v1/files
Uploads file with the specific params.
GET
/files/private/v1/users/{uid}
Returns a list of user files by uid. Available for admins with
"view_admin_profiles" permission if {uid} belongs to an admin user or
"view_user_profiles" permission if {uid} belongs to a client.
GET
/files/private/v1/entity/{entity}/id/{entityId}/files
Returns a list of files by entity and id.
GET
/files/private/v1/storage/bin/{id}
Returns binary file directly.
GET
/files/public/v1/storage/bin/{id}
Returns public binary file directly.


TRANSACTIONS LOG

GET
/logs/private/v1/admin/export/transactions-log/async
Requests a file with transactions log via the queue.
GET
/logs/private/v1/admin/export/transactions-log
Responds with a file with transactions log.
GET
/logs/private/v1/admin/export/information-log/async
Requests a file with information log via the queue.
GET
/logs/private/v1/admin/export/information-log
Responds with a file with information log.


SYSTEM LOGS

GET
/logs/private/v1/admin/system-logs
Shows a list of system logs.
GET
/logs/private/v1/admin/system-logs/{id}



MESSAGES

POST
/messages/private/v1/messages
Send new message to admins having sufficient permissions.
GET
/messages/private/v1/messages
List of messages for current user.
GET
/messages/private/v1/messages/{id}
Get thread.
POST
/messages/private/v1/messages/{id}
Reply to a message.
GET
/messages/private/v1/admin/messages
Shows all messages.
GET
/messages/private/v1/admin/messages/{id}
Get thread.
POST
/messages/private/v1/admin/messages/{id}
Reply to a message.
POST
/messages/private/v1/admin/message/to/all
Send message to all users.
POST
/messages/private/v1/admin/message/to/group
Send message to users from group.
POST
/messages/private/v1/admin/message/to/users
Send message to specific users.
GET
/messages/private/v1/admin/count/messages/unread
Responds with count of unread messages for current user.
GET
/messages/private/v1/count/messages/unread
Responds with count of unread messages for current user.
GET
/messages/private/v1/intercom/identity-hash
Get user hash for the Identity Verification.
GET
/messages/public/v1/intercom/settings
Responds with the Intercom public settings.


NEWS

POST
/news/private/v1/article
Creates a new article.
GET
/news/private/v1/article
Shows a list of articles.
GET
/news/private/v1/article/{id}
Shows an article by id.
DELETE
/news/private/v1/article/{id}
Deletes an article by id.
PATCH
/news/private/v1/article/{id}
Updates an article.


ADMIN USER SETTINGS

GET
/notifications/private/v1/user-settings/{uid}
Get list of settings
PUT
/notifications/private/v1/user-settings/{uid}
Updates admin user settings
PATCH
/notifications/private/v1/user-settings/{uid}
Updated user settings


USER SETTINGS

GET
/notifications/private/v1/user-settings
Get list of settings
PUT
/notifications/private/v1/user-settings
Updates user settings
PATCH
/notifications/private/v1/user-settings
Updated user settings


TEMPLATES

GET
/notifications/private/v1/templates/{scope}
Shows a list of email templates.
PUT
/notifications/private/v1/templates
Updates email notification templates.


NOTIFIERS

GET
/notifications/private/v1/notifiers/{provider}/details
Shows provider details.


TEST EMAIL

POST
/notifications/private/v1/test/smtp
Sends test email.


PERMISSION

GET
/permissions/private/v1/admin/permission
Shows a list of all permissions for specified user.
GET
/permissions/private/v1/admin/permission/{key}
Shows specific permission associated with a user.


PERMISSION GROUP

GET
/permissions/private/v1/admin/group
Shows a list of admin classes.
POST
/permissions/private/v1/admin/group
Creates a new admin class.
POST
/permissions/private/v1/admin/group/{id}
Updates an admin class.
GET
/permissions/private/v1/admin/group/{id}
Shows an admin class by id.
DELETE
/permissions/private/v1/admin/group/{id}
Deletes an admin class.


PERMISSION ACTION

GET
/permissions/private/v1/admin/action
Shows a list of actions.
GET
/permissions/private/v1/admin/action/{id}
Shows an action by id.
DELETE
/permissions/private/v1/admin/group/{id}/action/{action}
Removes an action from a group.
GET
/permissions/private/v1/admin/category
Shows a tree of actions.


SPECIFIC USER REPORTS

GET
/reports/private/v1/admin/user/account
Get list of transactions for account
GET
/reports/private/v1/admin/user/account/export/async
Requests a file with transactions of account via the queue
GET
/reports/private/v1/admin/user/account/export
Returns a file with transactions for account
GET
/reports/private/v1/admin/user/transaction
Get list all transactions of user
GET
/reports/private/v1/admin/user/transaction/export/async
Requests a file with all transactions of user via the queue
GET
/reports/private/v1/admin/user/transaction/export
Responds with a file with all transactions of user
GET
/reports/private/v1/admin/user/balance
Get list balances of user
GET
/reports/private/v1/admin/user/balance/export/async
Requests a file with balances of user via the queue
GET
/reports/private/v1/admin/user/balance/export
Returns a file with balances of user


GENERAL SYSTEM REPORTS

GET
/reports/private/v1/admin/system/transaction
Get list all transactions
GET
/reports/private/v1/admin/system/transaction/export/async
Requests a file with all transactions via the queue
GET
/reports/private/v1/admin/system/transaction/export
Returns a file with all transactions
GET
/reports/private/v1/admin/system/interests
Get list of interest
GET
/reports/private/v1/admin/system/interests/export/async
Responds with a file with interests via the queue
GET
/reports/private/v1/admin/system/interests/export
Returns a file with interest
GET
/reports/private/v1/admin/system/manual-transaction
Get list manual transactions
GET
/reports/private/v1/admin/system/manual-transaction/export/async
Requests a file with manual transactions via the queue
GET
/reports/private/v1/admin/system/manual-transaction/export
Returns a file with manual transactions
GET
/reports/private/v1/admin/system/balance
Get list balances
GET
/reports/private/v1/admin/system/balance/export/async
Responds with a file with balances via the queue
GET
/reports/private/v1/admin/system/balance/export
Returns a file with balances
GET
/reports/private/v1/admin/system/maturity
Get a list of accounts with an maturity dates
GET
/reports/private/v1/admin/system/maturity/export/async
Responds with a file with accounts with an maturity dates via the queue
GET
/reports/private/v1/admin/system/maturity/export
Returns a file with accounts with maturity dates
GET
/reports/private/v1/admin/system/outgoing-transfer
Get list outgoing transfers
GET
/reports/private/v1/admin/system/outgoing-transfer/export/async
Responds with a file with outgoing transfers via the queue
GET
/reports/private/v1/admin/system/outgoing-transfer/export
Returns a file with outgoing transfers
GET
/reports/private/v1/admin/system/sepa-transfer
Get list of SEPA transfers
GET
/reports/private/v1/admin/system/sepa-transfer/export/async
Responds with a file with sepa transfers via the queue
GET
/reports/private/v1/admin/system/sepa-transfer/export
Responds with a file with sepa transfers
GET
/reports/private/v1/admin/system/card
Get list all cards
GET
/reports/private/v1/admin/system/card/export
Returns a file with all cards
GET
/reports/private/v1/admin/system/access
Get list access logs
GET
/reports/private/v1/admin/system/access/export
Returns a file with access logs
GET
/reports/private/v1/admin/system/revenue
Get list revenues transactions
GET
/reports/private/v1/admin/system/revenue/export/async
Responds with a file with revenues transactions via the queue
GET
/reports/private/v1/admin/system/revenue/export
Returns a file with revenue transactions
GET
/reports/private/v1/admin/system/overview
Get system overview data
GET
/reports/private/v1/admin/system/overview/export/async
Requests a file with overview data via the queue
GET
/reports/private/v1/admin/system/overview/export
Responds with a file with overview data


USER REPORTS

GET
/reports/private/v1/account
Get list account transactions
GET
/reports/private/v1/account/export/async
Requests a file with account transactions via the queue
GET
/reports/private/v1/account/export
Responds with a file with account transactions
GET
/reports/private/v1/transaction
Get list all transactions
GET
/reports/private/v1/transaction/export/async
Reguests a file with all transactions of user via the queue
GET
/reports/private/v1/transaction/export
Responds with a file with all transactions
GET
/reports/private/v1/balance
Get list accounts balances
GET
/reports/private/v1/balance/export/async
Reguests a file with accounts balances via the queue
GET
/reports/private/v1/balance/export
Responds with a file with accounts balances


CONFIG

PUT
/settings/private/v1/config
Updates an existing configs.
GET
/settings/private/v1/config/{path}
Shows a list of configs path.
GET
/settings/public/v1/config/{path}
Shows a list of public configs by path.


EXTERNAL LINKS

GET
/settings/private/v1/external-links
Shows a list of external links.
POST
/settings/private/v1/external-links
Save external links.
GET
/settings/private/v1/external-links/state
Shows external links extension state.


WEB UI

GET
/settings/public/v1/web-url
Returns a URL of the Web UI bound to this environment.


INTEGRATIONS

GET
/settings/public/v1/integration/features/{section}
Returns a list of supported features.


SERVER

GET
/settings/public/v1/server/time
Returns a server datetime in various formats.


MODULES

GET
/settings/private/v1/modules
Shows a list of available modules with settings.
PUT
/settings/private/v1/modules/{name}
Update module settings.


USERS

GET
/users/public/v1/auth/confirmation-code/{code}
Get confirmation code by code
GET
/users/private/v1/users
Get list of users
POST
/users/private/v1/users
Create a user
GET
/users/private/v1/users/{uid}
Get user by uid
PUT
/users/private/v1/users/{uid}
Update user
GET
/users/private/v1/short-users
Get list of users with limited list of fields
GET
/users/private/v1/short-users/{uid}
Get user by uid with limited list of fields
PUT
/users/private/v1/limited/users/profile
Update a client profile.
POST
/users/private/v1/users/unblock
Unblock users


REGISTRATION REQUESTS

GET
/users/private/v1/registration-requests
Get list of registration requests
GET
/users/private/v1/registration-requests/{id}
Get registration request by id
POST
/users/private/v1/registration-requests/approve/{id}
Approve a registration request by id
POST
/users/private/v1/registration-requests/cancel/{id}
Cancel a registration request by id


SECURITY QUESTIONS ANSWERS

GET
/users/private/v1/limited/users/security-questions-answers
Get list of security questions answers
PUT
/users/private/v1/limited/users/security-questions-answers
Updates answers to security questions
GET
/users/private/v1/security-questions-answers/{uid}
Get list of answers for security questions
PUT
/users/private/v1/security-questions-answers/{uid}
Updates answers for security questions


USER GROUPS

GET
/users/private/v1/user-groups
Get list of user groups
POST
/users/private/v1/user-groups
Create a user group
GET
/users/private/v1/user-groups/{id}
Get user group by id
PUT
/users/private/v1/user-groups/{id}
Updated a user group
DELETE
/users/private/v1/user-groups/{id}
Delete a user group


USERS EXPORT

GET
/users/private/v1/export/user-profiles/async
Download a csv file with user profiles for admins via the queue
GET
/users/private/v1/export/user-profiles
Download a csv file with user profiles for admins
GET
/users/private/v1/export/admin-profiles/async
Download file with admin profiles for admins via the queue
GET
/users/private/v1/export/admin-profiles
Download file with admin profiles for admins
GET
/users/private/v1/export/registration-requests/async
Download a csv file with registration requests for admins via the queue
GET
/users/private/v1/export/registration-requests
Download a csv file with registration requests for admins


BLOCKED IPS

GET
/users/private/v1/blocked-ips
Get list of blocked ips
POST
/users/private/v1/blocked-ips/unblock
Unblock ip addresses


DEVICES

POST
/users/private/v1/devices
Add device


DEVICES

POST
/users/private/v1/device/{id}
Update device


PROFILE

POST
/users/private/v1/profile/delete-request
Request deletion


EXTENSIONS

GET
/extensions/public/v1/extensions/state
List the state of registered extesnions.


TFA

GET
/tfa/private/v1/tfa/providers/{uid}
List of available providers for user
PUT
/tfa/private/v1/tfa/providers/{uid}
Reset TFA configuration
POST
/tfa/private/v1/tfa/register/{provider}
Register provider for user
POST
/tfa/private/v1/tfa/enable
Enable tfa provider
POST
/tfa/private/v1/tfa/recovery-codes/reset
Reset recovery codes
POST
/tfa/private/v1/tfa/disable
Disable tfa provider
POST
/tfa/private/v1/reminder/disable
Disable reminder to enable tfa
POST
/tfa/private/v1/reminder/enable
Enable reminder to enable tfa
POST
/tfa/private/v1/reminder/admin/enable/{uid}
Enable reminder to enable tfa for a specific user (available for admins).
GET
/tfa/private/v1/reminder/{type}
Get information about determined reminder.
GET
/tfa/private/v1/tfa/config
Get information about the 2FA setting for the requester.


MULTILINGUAL

GET
/languages/public/v1/default
Show default language.
GET
/languages/public/v1/translation
Obtain translation file for the login page in the default language.
GET
/languages/private/v1/languages
Show available languages.
GET
/languages/private/v1/languages/{code}
Shows a language.
PUT
/languages/private/v1/languages/{code}
Updates a language.
PUT
/languages/private/v1/preferable/{code}
Set preferable language.
GET
/languages/private/v1/preferable
Get preferable language.
GET
/languages/private/v1/preferable/{code}/users
Get users by language.
GET
/languages/public/v1/translation/{code}
Shows translation file for a language.
GET
/languages/private/v1/translation/{code}
Obtain translation file for a specific language.
GET
/languages/public/v1/extensions/multilingual/activity
Multilingual extension activity
GET
/languages/private/v1/admin/editable-phrases/{code}
Editable phrases list
POST
/languages/private/v1/admin/editable-phrases/{code}
Update editable phrases
POST
/languages/private/v1/admin/editable-phrases/{code}/translations/import/csv
Import editable translations
GET
/languages/private/v1/admin/editable-phrases/{code}/translations/export-sample
/csv
Export editable translations sample


IMPORT/EXPORT CSV

GET
/queue/private/v1/queue
Get the list of the queue items.
GET
/queue/private/v1/queue/download/{itemId}
Download the result of the export request.


PREVIEW THE EXPORT RESULT

GET
/queue/private/v1/queue/preview/{itemId}
Preview the result of the export request.

SCHEMAS

QueueItem
CreateAccount
UpdateAccount
ShortAccountList
FullAccountList
FullAccount
RevenueAccount
CreateAccountType
UpdateAccountType
AccountTypeResponse
FullAccountType
AccountType
FullPaymentPeriod
FullPaymentMethod
TransactionView
ListTransaction
TransferFeeParameters
CreateTransferFee
UpdateTransferFee
CreateTransferFeeParameters
TransferFee
CreateCard
UpdateCard
Card
FullCard
CardType
FullCardType
CreateCardType
UpdateCardType
UserAcc
FullAccountUser
AccountUser
UpdateSetting
MassUpdateSetting
Setting
ExtensionActivity
TanCount
TanCreateRequest
CollectionLinks
RequestTemplateTbu
RequestTemplateCft
RequestTemplateOwt
SepaRequestPreview
CreateSepaRequestPreview
CreateSepaRequest
SepaRequest
Country
CardTypeCategory
CardTypeFormat
CreateIwtAccount
IwtBankAccount
IntermediaryBankDetails
BeneficiaryCustomer
ListRequest
ListRequestUser
TBARequestPreview
TBURequestPreview
OWTRequestPreview
CFTRequestPreview
CARequestPreview
DARequestPreview
DRARequestPreview
TBARequestPreviewDetails
RequestExecute
RequestPreview
CreateTBARequestPreview
CreateTBARequest
CreateCFTRequestPreview
CreateCFTRequest
CreateTBURequestPreview
CreateTBURequest
CreateOWTRequestPreview
CreateOWTRequest
CreateCARequestPreview
CreateCARequest
CreateDARequestPreview
CreateDARequest
CreateDRARequestPreview
CreateDRARequest
Rate
CancelRequest
TBARequest
TBURequest
OWTRequest
CFTRequest
CARequest
DARequest
DRARequest
RequestView
TfaProvider
TfaProviders
TfaProviderRegistrationForm
AdminCurrency
Currency
Settings
CurrencyRate
RateAndMargin
UpdateCurrency
UpdateRate
ModelForm
ModelFormValidator
ModelFormValidatorCondition
CorporateMember
CorporateSimpleMember
CreateCorporateMember
CorporateUserInfo
CorporateProfile
CreateCorporateProfile
CreateCorporateRole
CorporateRole
ForbiddenResponse
BadRequestResponse
SuccessfulUpdateRequestFromCsvResponse
BadRequestImportRequestFromCsvResponse
BadRequestUpdateRequestFromCsvResponse
NotFoundResponse
UnprocessableEntityResponse
ErrorResponse
BadRequestError
User
UserGroup
Question
SecurityQuestions
SetPassword
SuccessLogin
SuccessRefresh
UpdateLogoSettings
LogoSettings
UploadedFile
Gdpr
CustomizationFile
CreateColorScheme
ColorScheme
SiteText
UpdateSiteText
Colors
File
Files
LogList
Log
LogUser
LogsList
ExtensionState
NewMessagePostRequest
MessageReplyToMessageRequest
Threads
Thread
Message
Participant
SentToAllMessage
SentToUserGroupMessage
SentToSpecificUsersMessage
Image
Author
Article
ArticleTranslation
ArticleForm
UpdateAllSettings
UpdateSettings
AllSettings
Tokens
UserSettings
NotificationSetting
PublicSetting
UpdateAllTemplates
UpdateTemplate
AllTemplates
Template
SendTestEmail
PlivoDetails
TwilioDetails
CreateGroup
UpdateGroup
Permission
Group
Category
Action
ShortAction
AdminUserAccount
AdminUserTransaction
AdminUserBalance
AdminSystemTransaction
AdminSystemInterest
AdminSystemManualTransaction
AdminSystemBalance
AdminSystemMaturity
AdminSystemOutgoingTransfer
AdminSystemCard
AdminSystemAccess
AdminSystemRevenue
UserAccount
UserTransaction
UserBalance
UserUserObject
AccountTypeObject
AccountCardTypeObject
Config
ConfigResponse
AllConfigsResponse
AllModules
Module
ModuleSetting
Users
ShortUsers
ShortUser
CreateUser
UpdateUser
UpdateClientLimited
RegistrationRequest
UserGroups
CreateUserGroup
UpdateUserGroup
UpdateSecurityQuestionsAnswers
UpdateSecurityQuestionsAnswer
AddDevice
EditDevice
SecurityQuestionsAnswers
UnblockedIps
UnblockUsers
BlockedIps
BlockedIp
ConfirmationCode
SecurityQuestionsAnswer
Device
TfaConfig
Languages
Language
SetLanguage
TranslationFile
ExtensionIsActiveResponse
EditablePhrasesResponse
AllExternalLinks
ExternalLink
ExternalLinksState
TfaReminder
InterceptedPayload
Error500
ValidationErrors
NotFoundError
UnauthorizedResponse
ServerErrorResponse
ParamsError
BadResponse
Error