OpenAPI\Client\MandatorAdministrationApi

All URIs are relative to https://sandbox.finapi.io, except if the operation defines another base path.

Method	HTTP request	Description
changeClientCredentials()	POST /api/v2/mandatorAdmin/changeClientCredentials	Change client credentials
createIbanRules()	POST /api/v2/mandatorAdmin/ibanRules	Create IBAN rules
createKeywordRules()	POST /api/v2/mandatorAdmin/keywordRules	Create keyword rules
deleteIbanRules()	POST /api/v2/mandatorAdmin/ibanRules/delete	Delete IBAN rules
deleteKeywordRules()	POST /api/v2/mandatorAdmin/keywordRules/delete	Delete keyword rules
deleteUsers()	POST /api/v2/mandatorAdmin/deleteUsers	Delete users
getIbanRuleList()	GET /api/v2/mandatorAdmin/ibanRules	Get IBAN rules
getKeywordRuleList()	GET /api/v2/mandatorAdmin/keywordRules	Get keyword rules
getUserList()	GET /api/v2/mandatorAdmin/getUserList	Get user list
switchApiVersion()	POST /api/v2/mandatorAdmin/switchApiVersion	Switch API Version

`changeClientCredentials()`

changeClientCredentials($change_client_credentials_params, $x_request_id)

Change client credentials

Change the client_secret for any of your clients, including the mandator admin client. Must pass the mandator admin client's access_token.

NOTES:
• When you change a client's secret, then all of its existing access tokens will be revoked. User access tokens are not affected.
• finAPI is storing client secrets with a one-way encryption. A lost client secret can NOT be recovered.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$change_client_credentials_params = new \OpenAPI\Client\Model\ChangeClientCredentialsParams(); // \OpenAPI\Client\Model\ChangeClientCredentialsParams | Parameters for changing client credentials
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $apiInstance->changeClientCredentials($change_client_credentials_params, $x_request_id);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->changeClientCredentials: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
change_client_credentials_params	\OpenAPI\Client\Model\ChangeClientCredentialsParams	Parameters for changing client credentials
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

void (empty response body)

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createIbanRules()`

createIbanRules($iban_rules_params, $x_request_id): \OpenAPI\Client\Model\IbanRuleList

Create IBAN rules

This service can be used to define IBAN rules for finAPI's transaction categorization system. The transaction categorization is run automatically whenever new transactions are imported, as well as when you call the services 'Check categorization' or 'Trigger categorization'.

An IBAN rule maps an IBAN to a certain category. finAPI's categorization system will pick the category as a candidate for any transaction whose counterpart's account matches the IBAN. It is not guaranteed though that this candidate will actually be applied, as there could be other categorization rules that have higher priority or that are an even better match for the transaction.

Note that the rules that you define here will be applied to all of your users. They have higher priority than finAPI's default categorization rules, but lower priority than user-specific rules (User-specific rules are created implicitly whenever a category is manually assigned to a transaction via the PATCH /transactions services). IBAN rules have a higher priority than keyword rules (see the 'Create keyword rules' service).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$iban_rules_params = new \OpenAPI\Client\Model\IbanRulesParams(); // \OpenAPI\Client\Model\IbanRulesParams | IBAN rule definitions
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->createIbanRules($iban_rules_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->createIbanRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
iban_rules_params	\OpenAPI\Client\Model\IbanRulesParams	IBAN rule definitions
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\IbanRuleList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createKeywordRules()`

createKeywordRules($keyword_rules_params, $x_request_id): \OpenAPI\Client\Model\KeywordRuleList

Create keyword rules

This service can be used to define keyword rules for finAPI's transaction categorization system. The transaction categorization is run automatically whenever new transactions are imported (if enabled; see GET /clientConfiguration, field 'isAutoCategorizationEnabled'), as well as when you call the services 'Check categorization' or 'Trigger categorization'.

A keyword rule maps a set of keywords (of a given language) to a certain category. finAPI's categorization system will pick the category as a candidate for any transaction that matches the given keywords' language, and that contains at least one of the keywords in its purpose or counterpart information. It is not guaranteed though that this candidate will actually be applied, as there could be other categorization rules that have higher priority or that are an even better match for the transaction. If there are multiple keyword rules that match a transaction, finAPI will pick the one with the highest count of matched keywords.

Note that the rules that you define here will be applied to all of your users. They have higher priority than finAPI's default categorization rules, but lower priority than user-specific rules (User-specific rules are created implicitly whenever a category is manually assigned to a transaction via the PATCH /transactions services). Keyword rules have a lower priority than IBAN rules (see the 'Create IBAN rules' service).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$keyword_rules_params = new \OpenAPI\Client\Model\KeywordRulesParams(); // \OpenAPI\Client\Model\KeywordRulesParams | Keyword rule definitions
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->createKeywordRules($keyword_rules_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->createKeywordRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
keyword_rules_params	\OpenAPI\Client\Model\KeywordRulesParams	Keyword rule definitions
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\KeywordRuleList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteIbanRules()`

deleteIbanRules($iban_rule_identifiers_params, $x_request_id): \OpenAPI\Client\Model\IdentifierList

Delete IBAN rules

Delete one or multiple IBAN rules that you have previously created via the 'Create IBAN rules' service.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$iban_rule_identifiers_params = new \OpenAPI\Client\Model\IbanRuleIdentifiersParams(); // \OpenAPI\Client\Model\IbanRuleIdentifiersParams | List of IBAN rules identifiers. The maximum number of identifiers is 100.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->deleteIbanRules($iban_rule_identifiers_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->deleteIbanRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
iban_rule_identifiers_params	\OpenAPI\Client\Model\IbanRuleIdentifiersParams	List of IBAN rules identifiers. The maximum number of identifiers is 100.
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\IdentifierList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteKeywordRules()`

deleteKeywordRules($keyword_rule_identifiers_params, $x_request_id): \OpenAPI\Client\Model\IdentifierList

Delete keyword rules

Delete one or multiple keyword rules that you have previously created via the 'Create keyword rules' service.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$keyword_rule_identifiers_params = new \OpenAPI\Client\Model\KeywordRuleIdentifiersParams(); // \OpenAPI\Client\Model\KeywordRuleIdentifiersParams | List of keyword rule identifiers. The maximum number of identifiers is 100.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->deleteKeywordRules($keyword_rule_identifiers_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->deleteKeywordRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
keyword_rule_identifiers_params	\OpenAPI\Client\Model\KeywordRuleIdentifiersParams	List of keyword rule identifiers. The maximum number of identifiers is 100.
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\IdentifierList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteUsers()`

deleteUsers($user_identifiers_params, $x_request_id): \OpenAPI\Client\Model\UserIdentifiersList

Delete users

Delete one or several users, which are specified by a given list of identifiers. Must pass the mandator admin client's access_token.

NOTE: finAPI may fail to delete one (or several, or all) of the specified users. A user cannot get deleted when his data is currently locked by an internal process (for instance, update of a bank connection or transaction categorization). The response contains the identifiers of all users that could not get deleted, and all users that could get deleted, separated in two lists. The mandator admin client can retry the request at a later time for the users who could not get deleted.
Note that non-existing user identifiers will be ignored entirely, meaning that those identifiers will not appear in the response at all.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_identifiers_params = new \OpenAPI\Client\Model\UserIdentifiersParams(); // \OpenAPI\Client\Model\UserIdentifiersParams | List of user identifiers
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->deleteUsers($user_identifiers_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->deleteUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
user_identifiers_params	\OpenAPI\Client\Model\UserIdentifiersParams	List of user identifiers
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\UserIdentifiersList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getIbanRuleList()`

getIbanRuleList($page, $per_page, $order, $x_request_id): \OpenAPI\Client\Model\PageableIbanRuleList

Get IBAN rules

Returns all IBAN-based categorization rules that you have defined for your users via the 'Create IBAN rules' service.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Result page that you want to retrieve
$per_page = 20; // int | Maximum number of records per page. By default it's 20.
$order = array('order_example'); // string[] | Determines the order of the results. You can order the results by 'id'. The default order for this service is 'id,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->getIbanRuleList($page, $per_page, $order, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->getIbanRuleList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Result page that you want to retrieve	[optional] [default to 1]
per_page	int	Maximum number of records per page. By default it's 20.	[optional] [default to 20]
order	string[]	Determines the order of the results. You can order the results by 'id'. The default order for this service is 'id,asc'. The general format is: 'property[,asc	desc]', with 'asc' being the default value.
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\PageableIbanRuleList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getKeywordRuleList()`

getKeywordRuleList($page, $per_page, $order, $x_request_id): \OpenAPI\Client\Model\PageableKeywordRuleList

Get keyword rules

Returns all keyword-based categorization rules that you have defined for your users via the 'Create keyword rules' service.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Result page that you want to retrieve
$per_page = 20; // int | Maximum number of records per page. By default it's 20.
$order = array('order_example'); // string[] | Determines the order of the results. You can order the results by 'id'. The default order for this service is 'id,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->getKeywordRuleList($page, $per_page, $order, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->getKeywordRuleList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Result page that you want to retrieve	[optional] [default to 1]
per_page	int	Maximum number of records per page. By default it's 20.	[optional] [default to 20]
order	string[]	Determines the order of the results. You can order the results by 'id'. The default order for this service is 'id,asc'. The general format is: 'property[,asc	desc]', with 'asc' being the default value.
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\PageableKeywordRuleList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getUserList()`

getUserList($min_registration_date, $max_registration_date, $min_deletion_date, $max_deletion_date, $min_last_active_date, $max_last_active_date, $include_monthly_stats, $monthly_stats_start_date, $monthly_stats_end_date, $min_bank_connection_count_in_monthly_stats, $user_id, $is_deleted, $is_locked, $page, $per_page, $order, $x_request_id): \OpenAPI\Client\Model\PageableUserInfoList

Get user list

Get a list of the users of the mandator that is authorized by the access_token. Must pass the mandator admin client's access_token. You can set optional search criteria to get only those users that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Note that the original user id is no longer available in finAPI once a user has been deleted. Because of this, the userId of deleted users will be a distorted version of the original userId. For example, if the deleted user's id was originally 'user', then this service will return 'uXXr' as the userId.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$min_registration_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | <strong>Format:</strong> 'YYYY-MM-DD'<br/>Lower bound for a user's registration date, e.g. '2016-01-01'. If specified, then only users whose 'registrationDate' is equal to or later than the given date will be regarded.
$max_registration_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | <strong>Format:</strong> 'YYYY-MM-DD'<br/>Upper bound for a user's registration date, e.g. '2016-01-01'. If specified, then only users whose 'registrationDate' is equal to or earlier than the given date will be regarded.
$min_deletion_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | <strong>Format:</strong> 'YYYY-MM-DD'<br/>Lower bound for a user's deletion date, e.g. '2016-01-01'. If specified, then only users whose 'deletionDate' is not null, and is equal to or later than the given date will be regarded.
$max_deletion_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | <strong>Format:</strong> 'YYYY-MM-DD'<br/>Upper bound for a user's deletion date, e.g. '2016-01-01'. If specified, then only users whose 'deletionDate' is null, or is equal to or earlier than the given date will be regarded.
$min_last_active_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | <strong>Format:</strong> 'YYYY-MM-DD'<br/>Lower bound for a user's last active date, e.g. '2016-01-01'. If specified, then only users whose 'lastActiveDate' is not null, and is equal to or later than the given date will be regarded.
$max_last_active_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | <strong>Format:</strong> 'YYYY-MM-DD'<br/>Upper bound for a user's last active date, .g. '2016-01-01'. If specified, then only users whose 'lastActiveDate' is null, or is equal to or earlier than the given date will be regarded.
$include_monthly_stats = false; // bool | Whether to include the 'monthlyStats' for the returned users. If not specified, then the field defaults to 'false'.
$monthly_stats_start_date = 'monthly_stats_start_date_example'; // string | <strong>Format:</strong> 'YYYY-MM'<br/>Minimum bound for the monthly stats (=oldest month that should be included). If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true.
$monthly_stats_end_date = 'monthly_stats_end_date_example'; // string | <strong>Format:</strong> 'YYYY-MM'<br/>Maximum bound for the monthly stats (=latest month that should be included). If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if  'includeMonthlyStats' = true.
$min_bank_connection_count_in_monthly_stats = 0; // int | A value of X means that the service will return only those users which had at least X bank connections imported at any time within the returned monthly stats set. This field is only regarded when 'includeMonthlyStats' is set to 'true'. The default value for this field is 0.
$user_id = 'user_id_example'; // string | The identifier of a user to search for. If specified, then only the user with the given id will be regarded. If no user can be found for the passed userId, then the result list will be empty.
$is_deleted = True; // bool | If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded.
$is_locked = True; // bool | If NOT specified, then the service will regard both locked and not locked users in the search. If set to 'true', then ONLY locked users will be regarded. If set to 'false', then ONLY not locked users will be regarded.
$page = 1; // int | Result page that you want to retrieve
$per_page = 20; // int | Maximum number of records per page. By default it's 20.
$order = array('order_example'); // string[] | Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value.
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->getUserList($min_registration_date, $max_registration_date, $min_deletion_date, $max_deletion_date, $min_last_active_date, $max_last_active_date, $include_monthly_stats, $monthly_stats_start_date, $monthly_stats_end_date, $min_bank_connection_count_in_monthly_stats, $user_id, $is_deleted, $is_locked, $page, $per_page, $order, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->getUserList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
min_registration_date	\DateTime	<strong>Format:</strong> 'YYYY-MM-DD'<br/>Lower bound for a user's registration date, e.g. '2016-01-01'. If specified, then only users whose 'registrationDate' is equal to or later than the given date will be regarded.	[optional]
max_registration_date	\DateTime	<strong>Format:</strong> 'YYYY-MM-DD'<br/>Upper bound for a user's registration date, e.g. '2016-01-01'. If specified, then only users whose 'registrationDate' is equal to or earlier than the given date will be regarded.	[optional]
min_deletion_date	\DateTime	<strong>Format:</strong> 'YYYY-MM-DD'<br/>Lower bound for a user's deletion date, e.g. '2016-01-01'. If specified, then only users whose 'deletionDate' is not null, and is equal to or later than the given date will be regarded.	[optional]
max_deletion_date	\DateTime	<strong>Format:</strong> 'YYYY-MM-DD'<br/>Upper bound for a user's deletion date, e.g. '2016-01-01'. If specified, then only users whose 'deletionDate' is null, or is equal to or earlier than the given date will be regarded.	[optional]
min_last_active_date	\DateTime	<strong>Format:</strong> 'YYYY-MM-DD'<br/>Lower bound for a user's last active date, e.g. '2016-01-01'. If specified, then only users whose 'lastActiveDate' is not null, and is equal to or later than the given date will be regarded.	[optional]
max_last_active_date	\DateTime	<strong>Format:</strong> 'YYYY-MM-DD'<br/>Upper bound for a user's last active date, .g. '2016-01-01'. If specified, then only users whose 'lastActiveDate' is null, or is equal to or earlier than the given date will be regarded.	[optional]
include_monthly_stats	bool	Whether to include the 'monthlyStats' for the returned users. If not specified, then the field defaults to 'false'.	[optional] [default to false]
monthly_stats_start_date	string	<strong>Format:</strong> 'YYYY-MM'<br/>Minimum bound for the monthly stats (=oldest month that should be included). If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true.	[optional]
monthly_stats_end_date	string	<strong>Format:</strong> 'YYYY-MM'<br/>Maximum bound for the monthly stats (=latest month that should be included). If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true.	[optional]
min_bank_connection_count_in_monthly_stats	int	A value of X means that the service will return only those users which had at least X bank connections imported at any time within the returned monthly stats set. This field is only regarded when 'includeMonthlyStats' is set to 'true'. The default value for this field is 0.	[optional] [default to 0]
user_id	string	The identifier of a user to search for. If specified, then only the user with the given id will be regarded. If no user can be found for the passed userId, then the result list will be empty.	[optional]
is_deleted	bool	If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded.	[optional]
is_locked	bool	If NOT specified, then the service will regard both locked and not locked users in the search. If set to 'true', then ONLY locked users will be regarded. If set to 'false', then ONLY not locked users will be regarded.	[optional]
page	int	Result page that you want to retrieve	[optional] [default to 1]
per_page	int	Maximum number of records per page. By default it's 20.	[optional] [default to 20]
order	string[]	Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc	desc]', with 'asc' being the default value.
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\PageableUserInfoList

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`switchApiVersion()`

switchApiVersion($switch_api_version_params, $x_request_id): \OpenAPI\Client\Model\ResponseMessage

Switch API Version

Switch your client to a different version of the API. Must pass the mandator admin client's access_token.

Please make sure to read the article on Upgrading to a new API Version before you use this service.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: finapi_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\MandatorAdministrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$switch_api_version_params = new \OpenAPI\Client\Model\SwitchApiVersionParams(); // \OpenAPI\Client\Model\SwitchApiVersionParams | Parameters for switching the API version
$x_request_id = 'x_request_id_example'; // string | With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

try {
    $result = $apiInstance->switchApiVersion($switch_api_version_params, $x_request_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MandatorAdministrationApi->switchApiVersion: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
switch_api_version_params	\OpenAPI\Client\Model\SwitchApiVersionParams	Parameters for switching the API version
x_request_id	string	With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.	[optional]

Return type

\OpenAPI\Client\Model\ResponseMessage

Authorization

finapi_auth, finapi_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MandatorAdministrationApi.md

Latest commit

History

MandatorAdministrationApi.md

File metadata and controls

OpenAPI\Client\MandatorAdministrationApi

changeClientCredentials()

Example

Parameters

Return type

Authorization

HTTP request headers

createIbanRules()

Example

Parameters

Return type

Authorization

HTTP request headers

createKeywordRules()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteIbanRules()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteKeywordRules()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUsers()

Example

Parameters

Return type

Authorization

HTTP request headers

getIbanRuleList()

Example

Parameters

Return type

Authorization

HTTP request headers

getKeywordRuleList()

Example

Parameters

Return type

Authorization

HTTP request headers

getUserList()

Example

Parameters

Return type

Authorization

HTTP request headers

switchApiVersion()

Example

Parameters

Return type

Authorization

HTTP request headers

`changeClientCredentials()`

`createIbanRules()`

`createKeywordRules()`

`deleteIbanRules()`

`deleteKeywordRules()`

`deleteUsers()`

`getIbanRuleList()`

`getKeywordRuleList()`

`getUserList()`

`switchApiVersion()`