Open Sidebar

Sandbox
 1.1.20240910 

[ Base URL: api.rb.cz/ ]

Sandbox environment.

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 ClientID that your application must send in the request as X-IBM-Client-Id. This is the key that grants your app access to the API.

However, this may not be enough. Your application needs to use mTLS to call most operations here. Thus, you not only need https but also a client certificate issued by us. The exception is two operations for FX rates that are accessible also without a client certificate.

Each bank client/user can issue several certificates. Each certificate can permit different sets of operations (http methods) on different bank accounts. All this must be configured in Internet Banking first by each bank client/user (bank clients need to look under Settings and do not forget to download the certificate at the last step). The certificate is downloaded in PKCS#12 format as *.p12 file and protected by a password chosen by the bank client/user. Yes, your app needs the password as well to get use of the *p12 file for establishing mTLS connection to the bank.

Client certificates issued in Internet Banking for bank clients/users have limited validity (e.g. 5 years). However, each year certificates are automatically blocked and bank client/user must unblock them in Internet Banking. It is possible to do it in advance and prolong the time before the certificate is blocked. Your app should be prepared for these scenarios and it should communicate such cases to your user in advance to provide seamless service and high user-experience of your app.

For testing purposes please download and use our test client certificate. The certificate password is Test12345678.

Rate Limiting

In production environment the request rate is limited according to your subscription plan. Therefore the consumer must be able to handle HTTP responses status 429 in case of exceeding these limits.

Response headers X-RateLimit-Limit-Second and X-RateLimit-Limit-Day show the actual limits configured for the specific operation. Response headers X-RateLimit-Remaining-Second and X-RateLimit-Remaining-Day are returned to help prevent the limits from being exceeded.

Notes

Be aware, that in certain error situations, API can return specific error structures along with 5xx status code, which is not explicitely defined below.

Quick Start Client

Feel free to download a simple Java client that gives you quick access to our API.

Models

CurrencyListSimple
ExchangeRateList
ExchangeRate