vitexsoftware / rbczpremiumapi
##### API Overview - Accounts list and balance - Transaction overview (also for saving accounts) - Payments import - Statement list and download - FX rates ##### Authentication Before making a call to Premium API, you need to register your app at our _Developer portal_. This is where you get the **
Requires
- php: >= 8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
- vitexsoftware/ease-core: ^1.45
Requires (Dev)
- ergebnis/composer-normalize: ^2.43
- ergebnis/php-cs-fixer-config: ^6.34
- friendsofphp/php-cs-fixer: ^3.71
- phpstan/phpstan-phpunit: 2.0.x-dev
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2025-03-20 19:06:44 UTC
README
php client library for rbczpremiumapi
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/VitexSoftware/php-vitexsoftware-rbczpremiumapi.git" } ], "require": { "vitexsoftware/php-vitexsoftware-rbczpremiumapi": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/Raiffeisenbank Premium API client library/vendor/autoload.php');
Getting Started
Example environment or contents of .env file for basic library configuration
CERT_FILE=examples/test_cert.p12
CERT_PASS=test12345678
XIBMCLIENTID=FbboLD2r1WHDRcuKS4wWUbSRHxlDloWL
API_DEBUG=True
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new VitexSoftware\Raiffeisenbank\Api\DownloadStatementApi( // If you want use custom http client, pass your client which implements // `GuzzleHttp\ClientInterface`. // This is optional, Internal `ApiClient` will be used as default. // Else you must call setXIBMClientId($lientID) and $this->setSUIPAddress($clientPubIP) // methods to set API call properly new \VitexSoftware\Raiffeisenbank\ApiClient(['clientpubip'=> \VitexSoftware\Raiffeisenbank\ApiClient::getPublicIP() ,'debug'=>true]) ); $xRequestId = 'xRequestId_example'; // string | Unique request id provided by consumer application for reference and auditing. $acceptLanguage = 'acceptLanguage_example'; // string | The Accept-Language request HTTP header is used to determine document language. Supported languages are `cs` and `en`. $requestBody = new \VitexSoftware\Raiffeisenbank\Model\DownloadStatementRequest(); // \VitexSoftware\Raiffeisenbank\Model\DownloadStatementRequest try { $result = $apiInstance->downloadStatement( $xRequestId, $acceptLanguage, $requestBody, $pSUIPAddress); print_r($result); } catch (Exception $e) { echo 'Exception when calling DownloadStatementApi->downloadStatement: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.rb.cz
Class | Method | HTTP request | Description |
---|---|---|---|
DownloadStatementApi | downloadStatement | POST /rbcz/premium/api/accounts/statements/download | |
GetAccountBalanceApi | getBalance | GET /rbcz/premium/api/accounts/{accountNumber}/balance | |
GetAccountsApi | getAccounts | GET /rbcz/premium/api/accounts | |
GetBatchDetailApi | getBatchDetail | GET /rbcz/premium/api/payments/batches/{batchFileId} | |
GetFxRatesApi | getFxRates | GET /rbcz/premium/api/fxrates/{currencyCode} | |
GetFxRatesListApi | getFxRatesList | GET /rbcz/premium/api/fxrates | |
GetStatementListApi | getStatements | POST /rbcz/premium/api/accounts/statements | |
GetTransactionListApi | getTransactionList | GET /rbcz/premium/api/accounts/{accountNumber}/{currencyCode}/transactions | |
UploadPaymentsApi | importPayments | POST /rbcz/premium/api/payments/batches |
Models
- CurrencyListSimple
- DownloadStatementRequest
- ExchangeRate
- ExchangeRateList
- GetBalance200Response
- GetBalance200ResponseCurrencyFoldersInner
- GetBalance200ResponseCurrencyFoldersInnerBalancesInner
- GetBalance401Response
- GetBalance403Response
- GetBalance404Response
- GetBalance429Response
- GetStatementsRequest
- ImportPayments400Response
- ImportPayments413Response
- ImportPayments415Response
Authorization
All endpoints do not require authorization.
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.1.20240910
- Package version:
1.3.1
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen
Library is Used by: