General notes

Localization

All requests will contain Accept-Language header reflecting user’s language set in browser. It will be used e.g. for correct language in error messages.

Accept-Language:cs

Dates

Dates are serialized into JSON as strings, We are using UTC and ISO 8601 Time zone format.

So, java.util.Date is converted using SimpleDateFormat yyyy-MM-dd’T’HH:mm:ss.SSSX

We live in CEST (Central European Daylight Savings Time) timezone, which is +2 of GMT. So, for example, date value with date only and no time is serialized like this:

2016-05-032016-05-02T22:00:00.000Z

And after deserialization using yyyy-MM-dd’T’HH:mm:ss.SSSX SimpleDateFormat you will get 2016-05-03 in CEST timezone.

you can also use just date yyyy-MM-dd

HTTP status codes

Status code Usage

200 OK

Operation ended sucessfully

400 Bad Request

When FIS-side validation fails. This status code contains error message(s) which are typically to be rendered to the client. See HTTP 400 Error message

404 Resource not found

When requested URL does not exists

500 Internal error

When there is some technical error (exception). This error is not to be rendered to the client.

Instead something like There is an technical error, please contact helpdesk should be displayed

something else

Some API uses other codes, then they are documented in these APIs. For example /login request returns 403 when login fails

HTTP 400 Error message

{
	"messages":[
		{
			"severity":"ERROR", (1)
			"message":"Counter Party is required"
		},
		{
			"severity":"ERROR",
			"message":"Spot margin must not be null",
			"errorCode":"EB-1001" (2)
		}
	],
	"severity":"ERROR"  (3)
}
1 as of now severity is always ERROR. Reserved for future use: WARN, INFO
2 If there is a need to custom handle error at your side (and not just display it to the client), Error will have a code to identify it.
3 Overall severity is worst case of all severities, so now it is always ERROR

End Points

example:

https://api.expobank.cz/web/contact-form
https://api.expobank.cz/web/service-status

API

Currencies

A GET request to receive list of currency rates vs CZK

Path parameters

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/exchangerate/path-parameters.adoc[]

Response fields

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/exchangerate/response-fields.adoc[]

Example

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/exchangerate/http-request.adoc[]

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/exchangerate/http-response.adoc[]

Contact form

A POST request to fill a contact form

Request fields

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/contact-form/request-fields.adoc[]

Example

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/contact-form/http-request.adoc[]

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/contact-form/http-response.adoc[]

Service status

A GET request to get status of IB and PSD2 services.
If this API returns http status 200, then refer to status of individual services (status can be UP or DOWN)
if this API returns some error http status or is not available at all, consider all services DOWN

Response fields

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/service-status/response-fields.adoc[]

Example

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/service-status/http-request.adoc[]

Unresolved directive in general.adoc - include::/var/lib/jenkins/workspace/FIS_REST_DOCUMENTATION_WEB/app/target/generated-snippets/api/web/service-status/http-response.adoc[]