spojenet / csas-accountsapi
API for managing production accounts.
0.7.1
2025-03-18 17:09 UTC
Requires
- php: ^8.1 || ^8.2 || ^8.3 || ^8.4
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
- vitexsoftware/ease-core: ^1.47
Requires (Dev)
- ergebnis/composer-normalize: ^2.43
- ergebnis/php-cs-fixer-config: ^6.34
- friendsofphp/php-cs-fixer: ^3.61
- phpstan/phpstan: *
- phpstan/phpstan-phpunit: 2.0.x-dev
- phpunit/phpunit: *
README
API for managing production accounts.
For more information, please visit https://www.csas.cz/content/dam/cz/csas/www_csas_cz/dokumenty/obecne/how-to-connect-to-api-of-cs.pdf.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/Spoje-NET/php-csas-webapi.git" } ], "require": { "Spoje-NET/php-csas-webapi": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/Premium - Accounts API/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?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 = D2C8C1DCC51A3738538A40A4863CA288E0225E52; // string | Unique system identification of the client account $accountStatementId = 002498aa881201c7; // string | Unique identifier of the account statement $format = pdf; // string | Selected statement format try { $result = $apiInstance->downloadAccountStatement($id, $accountStatementId, $format); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->downloadAccountStatement: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://www.csas.cz/webapi/api/v3/accounts
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | downloadAccountStatement | GET /my/accounts/{id}/statements/{accountStatementId}/download | Download account statement |
DefaultApi | getAccountBalance | GET /my/accounts/{id}/balance | Get account balance |
DefaultApi | getAccountStatements | GET /my/accounts/{id}/statements | Get account statements |
DefaultApi | getAccounts | GET /my/accounts | Get account details |
DefaultApi | getTransactions | GET /my/accounts/{id}/transactions | Overview of transactions |
Models
- Account
- AccountBalance
- AccountCurrencyExchange
- AccountIdentification
- AccountRelatedAgents
- AccountRelationship
- AccountServicer
- AccountSuitableScope
- DownloadAccountStatement200Response
- DownloadAccountStatement200Response1
- DownloadAccountStatement200Response2
- DownloadAccountStatement400Response
- DownloadAccountStatement400ResponseErrorsInner
- GetAccountBalance200Response
- GetAccountBalance200ResponseBalancesInner
- GetAccountBalance200ResponseBalancesInnerAmount
- GetAccountBalance200ResponseBalancesInnerDate
- GetAccountBalance200ResponseBalancesInnerType
- GetAccountBalance200ResponseBalancesInnerTypeCodeOrProprietary
- GetAccountStatements200Response
- GetAccountStatements200ResponseAccountStatementsInner
- GetAccountStatements200ResponseAccountStatementsInnerFormatsInner
- GetAccountStatements400Response
- GetAccountStatements400ResponseErrorsInner
- GetAccountStatements404Response
- GetAccountStatements404ResponseErrorsInner
- GetAccountStatements429Response
- GetAccountStatements429ResponseErrorsInner
- GetAccountStatements500Response
- GetAccountStatements500ResponseErrorsInner
- GetAccountStatements503Response
- GetAccountStatements503ResponseErrorsInner
- GetAccounts200Response
- GetAccounts403Response
- GetAccounts403ResponseErrorsInner
- GetTransactions200Response
- GetTransactions200ResponseTransactionsInner
- GetTransactions200ResponseTransactionsInnerAmount
- GetTransactions200ResponseTransactionsInnerBankTransactionCode
- GetTransactions200ResponseTransactionsInnerBankTransactionCodeProprietary
- GetTransactions200ResponseTransactionsInnerBookingDate
- GetTransactions200ResponseTransactionsInnerEntryDetails
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetails
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsAmountDetails
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsAmountDetailsCounterValueAmount
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsAmountDetailsCounterValueAmountAmount
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsAmountDetailsCounterValueAmountCurrencyExchange
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsAmountDetailsInstructedAmount
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsAmountDetailsInstructedAmountAmount
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsReferences
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedAgents
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedAgentsCreditorAgent
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedAgentsCreditorAgentFinancialInstitutionIdentification
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedAgentsDebtorAgent
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedAgentsDebtorAgentFinancialInstitutionIdentification
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedParties
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesCreditor
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesCreditorAccount
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesCreditorAccountIdentification
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesCreditorAccountIdentificationOther
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesDebtor
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesDebtorAccount
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesDebtorAccountIdentification
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRelatedPartiesDebtorAccountIdentificationOther
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRemittanceInformation
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRemittanceInformationStructured
- GetTransactions200ResponseTransactionsInnerEntryDetailsTransactionDetailsRemittanceInformationStructuredCreditorReferenceInformation
- GetTransactions200ResponseTransactionsInnerValueDate
- StatementList
- TransactionList
- TransactionListTransactionsInner
Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication (JWT)
ApiKeyAuth
- Type: API key
- API key parameter name: WEB-API-key
- Location: HTTP header
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0
- Generator version:
7.10.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen