Skip to content

Latest commit

 

History

History
299 lines (212 loc) · 10.5 KB

DefaultApi.md

File metadata and controls

299 lines (212 loc) · 10.5 KB
Raw

SpojeNET\Csas\DefaultApi

All URIs are relative to https://www.csas.cz/webapi/api/v3/accounts, except if the operation defines another base path.

Method HTTP request Description
getAccountBalance() GET /my/accounts/{id}/balance Get account balance
getAccounts() GET /my/accounts Get account details
getStatements() GET /my/accounts/{id}/statements Get statements list
getTransactions() GET /my/accounts/{id}/transactions Overview of transactions

getAccountBalance()

getAccountBalance($id): \SpojeNET\Csas\Model\AccountBalance

Get account balance

Get the current balance of the account.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKey('web-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKeyPrefix('web-api-key', 'Bearer');

// Configure Bearer (JWT) authorization: bearerAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new SpojeNET\Csas\Api\DefaultApi(
    // 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
);
$id = 'id_example'; // string | Opaque system ID of the account

try {
    $result = $apiInstance->getAccountBalance($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAccountBalance: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Opaque system ID of the account

Return type

\SpojeNET\Csas\Model\AccountBalance

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getAccounts()

getAccounts($size, $page, $sort, $order): \SpojeNET\Csas\Model\Account

Get account details

Get a list of accounts for the authenticated user.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKey('web-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKeyPrefix('web-api-key', 'Bearer');

// Configure Bearer (JWT) authorization: bearerAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new SpojeNET\Csas\Api\DefaultApi(
    // 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
);
$size = 56; // int | Number of accounts to return
$page = 56; // int | Page number to return
$sort = 'sort_example'; // string | Field to sort by
$order = 'order_example'; // string | Sort order

try {
    $result = $apiInstance->getAccounts($size, $page, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAccounts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
size int Number of accounts to return [optional]
page int Page number to return [optional]
sort string Field to sort by [optional]
order string Sort order [optional]

Return type

\SpojeNET\Csas\Model\Account

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getStatements()

getStatements($id, $fromDate, $toDate, $format, $size, $page): \SpojeNET\Csas\Model\StatementList

Get statements list

Obtain list of statements for a given account.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKey('web-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKeyPrefix('web-api-key', 'Bearer');

// Configure Bearer (JWT) authorization: bearerAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new SpojeNET\Csas\Api\DefaultApi(
    // 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
);
$id = 'id_example'; // string | Unique system identification of the client account
$fromDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Date from which the statement history should be obtained (yyyy-MM-dd)
$toDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Date to which the statement history should be obtained (yyyy-MM-dd)
$format = 'format_example'; // string | Selected statement format
$size = 56; // int | Number of entries per page (max. 100)
$page = 56; // int | The desired page (indexed from zero)

try {
    $result = $apiInstance->getStatements($id, $fromDate, $toDate, $format, $size, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getStatements: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Unique system identification of the client account
fromDate \DateTime Date from which the statement history should be obtained (yyyy-MM-dd) [optional]
toDate \DateTime Date to which the statement history should be obtained (yyyy-MM-dd) [optional]
format string Selected statement format [optional]
size int Number of entries per page (max. 100) [optional]
page int The desired page (indexed from zero) [optional]

Return type

\SpojeNET\Csas\Model\StatementList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getTransactions()

getTransactions($id, $fromDate, $toDate, $size, $page, $sort, $order): \SpojeNET\Csas\Model\TransactionList

Overview of transactions

Paginated and optionally filtered (by dates) transaction list for given account.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKey('web-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setApiKeyPrefix('web-api-key', 'Bearer');

// Configure Bearer (JWT) authorization: bearerAuth
$config = SpojeNET\Csas\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new SpojeNET\Csas\Api\DefaultApi(
    // 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
);
$id = 'id_example'; // string | Unique system identification of the client account
$fromDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Filter transactions starting from a specific day in UTC (yyyy-MM-dd)
$toDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Filter transactions up to the chosen day in UTC (yyyy-MM-dd)
$size = 56; // int | Number of entries per page (max. 200)
$page = 56; // int | The desired page (indexed from zero)
$sort = 'sort_example'; // string | One single field that should be used for sorting
$order = 'order_example'; // string | Sort order

try {
    $result = $apiInstance->getTransactions($id, $fromDate, $toDate, $size, $page, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Unique system identification of the client account
fromDate \DateTime Filter transactions starting from a specific day in UTC (yyyy-MM-dd) [optional]
toDate \DateTime Filter transactions up to the chosen day in UTC (yyyy-MM-dd) [optional]
size int Number of entries per page (max. 200) [optional]
page int The desired page (indexed from zero) [optional]
sort string One single field that should be used for sorting [optional]
order string Sort order [optional]

Return type

\SpojeNET\Csas\Model\TransactionList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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