Czech standard for Open Banking
general notes
Unless explicitly stated otherwise, for all request is expected following definition of processed headers.
- Content-Type:
- Typ: string
- Obligation: yes
- Description: Specification of transfer format. Assuming on technical specification for this API standard is in this case primarily supported format application/json.
- API-key:
- Typ: string
- Obligation: no
- Description: Optional string provided by third party as identifier of request from third party which is iused as configuration element of comunication.
- Authorization:
- Type: string
- Obligation: yes
- Description: Parameter which is used for handover to access token of authenticated user together with its type.
Paths
/accounts
List of clients payment accounts
Paged list of clients accounts. Each account contains unique ID usable for URI reference eg. on account detail.
Paging. Number of records for requested page.
Paging. Requested page. + Default: 0
{
"default": 0
}
Comma separated list of fields for sorting sorted by importance
Comma separated list of sorting options (ASC, DESC). the order matches the order of the fields in parameter sort.
The flag identifies if the end user is online and the request was made based on his activity.
Identifies the API's end-user IP address. The TPP should fill this value if the IP address can be detected. The address can be in IPv4 or IPv6 format.
{
"maxLength": 50
}
An element used to pass on information about what end-user IP port is using.
{
"maxLength": 40
}
The element is used to forward information about the end user operating system used.
{
"maxLength": 100
}
Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent.
{
"maxLength": 200
}
Local time on User's device.
End-user GPS coordinates (if the coordinates can be reliably detected).
Required format: GEO:Latitude;Longitude
Based on [RFC2426] in signed degrees format (DDD.dddd)
{
"maxLength": 100
}
It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI).
Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters.
{
"maxLength": 60
}
Defines MIME media type of the resource. For example application/json or application/x-www-form-urlencoded (OAuth2 /auth resources) and application/xml in case of bulk payment initiation.
{
"maxLength": 50
}
Each request of a transaction contains the date and time at which the message was originated. In timestamp format.
IDs that identify the technical or business process within the call of each API request.
For example, it can be used to identify the process of retrieving a transaction history that is provided as a paged response available through multiple requests.
{
"maxLength": 60
}
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
Successful response
Parameter value is not valid (PARAMETER_INVALID)
- Invalid/missing access token = user is not authorized (UNAUTHORISED) - Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
Attribute description not found
Request for non existing page (PAGE_NOT_FOUND)
/accounts/{id}/transactions
Payer account currency eg. CZK
Paged list of transactions for given clients account. COBS non-compliant API
Clients account system ID
Requested currency for multicurrency account eg. CZK
Date and time for start of requested transaction history
Date and time for end of requested transaction history [given date is included]
Paging. Number of records on single page
Paging. Requested page. + Default: 0
{
"default": 0
}
Comma-separated list of sort fields, sorted by its meaning
Comma-separated list of sort variants (ASC, DESC). The order matches the order of the fields in the sort parameter.
The flag identifies if the end user is online and the request was made based on his activity.
Identifies the API's end-user IP address. The TPP should fill this value if the IP address can be detected. The address can be in IPv4 or IPv6 format.
{
"maxLength": 50
}
An element used to pass on information about what end-user IP port is using.
{
"maxLength": 40
}
The element is used to forward information about the end user operating system used.
{
"maxLength": 100
}
Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent.
{
"maxLength": 200
}
Local time on User's device.
End-user GPS coordinates (if the coordinates can be reliably detected).
Required format: GEO:Latitude;Longitude
Based on [RFC2426] in signed degrees format (DDD.dddd)
{
"maxLength": 100
}
It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI).
Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters.
{
"maxLength": 60
}
Defines MIME media type of the resource. For example application/json or application/x-www-form-urlencoded (OAuth2 /auth resources) and application/xml in case of bulk payment initiation.
{
"maxLength": 50
}
Each request of a transaction contains the date and time at which the message was originated. In timestamp format.
IDs that identify the technical or business process within the call of each API request.
For example, it can be used to identify the process of retrieving a transaction history that is provided as a paged response available through multiple requests.
{
"maxLength": 60
}
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
Succeful response
- Parameter value is invalid (PARAMETER_INVALID) - [InvalidAccountCurrency] - for multicurrency accounts, or unsupported currency by exchange rates (AC09) - [InvalidDate] invalid date (DT01)
- Invalid/missing access token = user is not authorized (UNAUTHORISED) - Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
Attribute description not found
- Invalid or uknown account ID (ID_NOT_FOUND)
- Request for non-existent page (PAGE_NOT_FOUND)
/accounts/{id}/balance
Balance on account
Balance on account for specific clients account ID.
Clients account system ID
Requested currency for multicurrency account. eg. CZK
The flag identifies if the end user is online and the request was made based on his activity.
Identifies the API's end-user IP address. The TPP should fill this value if the IP address can be detected. The address can be in IPv4 or IPv6 format.
{
"maxLength": 50
}
An element used to pass on information about what end-user IP port is using.
{
"maxLength": 40
}
The element is used to forward information about the end user operating system used.
{
"maxLength": 100
}
Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent.
{
"maxLength": 200
}
Local time on User's device.
End-user GPS coordinates (if the coordinates can be reliably detected).
Required format: GEO:Latitude;Longitude
Based on [RFC2426] in signed degrees format (DDD.dddd)
{
"maxLength": 100
}
It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI).
Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters.
{
"maxLength": 60
}
Defines MIME media type of the resource. For example application/json or application/x-www-form-urlencoded (OAuth2 /auth resources) and application/xml in case of bulk payment initiation.
{
"maxLength": 50
}
Each request of a transaction contains the date and time at which the message was originated. In timestamp format.
IDs that identify the technical or business process within the call of each API request.
For example, it can be used to identify the process of retrieving a transaction history that is provided as a paged response available through multiple requests.
{
"maxLength": 60
}
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
Successful response
[InvalidAccountCurrency] - for multicurrency accounts, or unsupported currency by list of currencies (AC09)
- Invalid/missing access token = user is not authorized (UNAUTHORISED) - Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
Attribute description not found
Invalid or unknown account ID (ID_NOT_FOUND)
/standingorders
List of client’s standing orders
Paged list of client’s standing orders. Each standing order contains a unique id usable for URI referencing, e.g. for the standing order detail.
Resource characteristics:
- Authorization: request requires the authorization of user/client as part of API calling
- Use certificate: request requires the use of the qualified third-party certificate
- Paging: yes
- Sorting: yes
- Filtering: yes
Date and time of the start of required transaction history.
Date and time of the end of required transaction history [inclusive].
Required account currency for multi-currency accounts.
{
"pattern": "[A-Z]{3}"
}
Stránkování. Počet záznamů na stránce stránky
Stránkování. Požadovaná stránka. + Default: 0
{
"default": 0
}
Čárkou oddělený seznam polí pro třídění seřazený podle významu
Čárkou oddělený seznam způsobů řazení (ASC, DESC). Pořadí odpovídá pořadí polí v parametru sort.
Defines MIME media type of the resource. For example application/json or application/x-www-form-urlencoded (OAuth2 /auth resources) and application/xml in case of bulk payment initiation.
{
"maxLength": 50
}
Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters.
{
"maxLength": 60
}
Each request of a transaction contains the date and time at which the message was originated. In timestamp format.
IDs that identify the technical or business process within the call of each API request.
For example, it can be used to identify the process of retrieving a transaction history that is provided as a paged response available through multiple requests.
{
"maxLength": 60
}
The flag identifies if the end user is online and the request was made based on his activity.
Identifies the API's end-user IP address. The TPP should fill this value if the IP address can be detected. The address can be in IPv4 or IPv6 format.
{
"maxLength": 50
}
An element used to pass on information about what end-user IP port is using.
{
"maxLength": 40
}
The element is used to forward information about the end user operating system used.
{
"maxLength": 100
}
Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent.
{
"maxLength": 200
}
Local time on User's device.
End-user GPS coordinates (if the coordinates can be reliably detected).
Required format: GEO:Latitude;Longitude
Based on [RFC2426] in signed degrees format (DDD.dddd)
{
"maxLength": 100
}
It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI).
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
application/octet-stream
OK
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"allOf": [
{
"description": "Stránkovaná kolekce",
"properties": {
"nextPage": {
"description": "Číslo následující stránky. Pokud je aktuální stránka zároveň poslední stránkou seznamu, není tento parametr uveden resp. je uveden s hodnotou null.",
"type": "integer"
},
"pageCount": {
"description": "Celkový počet stránek dotazu",
"type": "integer"
},
"pageNumber": {
"description": "Číslo aktuální stránky",
"type": "integer"
},
"pageSize": {
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"allOf": [
{
"description": "Stránkovaná kolekce",
"properties": {
"nextPage": {
"description": "Číslo následující stránky. Pokud je aktuální stránka zároveň poslední stránkou seznamu, není tento parametr uveden resp. je uveden s hodnotou null.",
"type": "integer"
},
"pageCount": {
"description": "Celkový počet stránek dotazu",
"type": "integer"
},
"pageNumber": {
"description": "Číslo aktuální stránky",
"type": "integer"
},
"pageSize": {
"description": "Počet záznamů na stránce. Tento parametr může odpovídat požadované hodnotě size z dotazu až na případy kdy se jedná o poslední stránku, nebo v případě kdy požadovaný rozsah stránek překročil maximální limit definovaný pro konkrétní API zdroj.",
"type": "integer"
},
"page": {
"items": {
"allOf": [
{
"description": "Standing order identification and amount.\n",
"properties": {
"amount": {
"description": "Payment amount\n",
"properties": {
"instructedAmount": {
"description": "Amount and currency in the instruction\n",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
"type": "string"
},
"value": {
"description": "Amount value",
"example": 10000,
"type": "number"
}
},
"required": [
"value",
"currency"
],
"type": "object"
}
},
"type": "object"
},
"standingOrderIdentification": {
"description": "Standing order identification\n",
"properties": {
"endToEndIdentification": {
"description": "End to end identification.\nRequired only for: SEPA payments.\n",
"maxLength": 35,
"type": "string"
},
"instructionIdentification": {
"description": "Payment identification entered by a third party, or a constant symbol may be entered.\n",
"maxLength": 35,
"type": "string"
},
"transactionIdentification": {
"description": "Transaction identification\n",
"maxLength": 35,
"type": "string"
}
}
},
"standingOrder": {
"description": "Structure describing the parameters of the standing orders.\n",
"properties": {
"alias": {
"description": "Description resp. the user-defined standing order payment name.\n",
"example": "Payments for lunch - kindergarten Michal",
"maxLength": 250,
"type": "string"
},
"debtorAccount": {
"description": "Payer's account",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
"type": "string"
},
"id": {
"description": "API Payment account identifier.\n",
"example": "D2C8C1DCC51A3738538A40A4863CA288E0225E52",
"type": "string"
},
"identification": {
"description": "Payer account identifier",
"properties": {
"iban": {
"description": "International Bank Account Number (IBAN)",
"example": "CZ0708000000001019382023",
"maxLength": 34,
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
"type": "string"
}
},
"required": [
"iban"
],
"type": "object"
}
},
"required": [
"id",
"identification",
"currency"
],
"type": "object"
},
"execution": {
"description": "Features of execution a standing order for payment.",
"properties": {
"interval": {
"description": "Execution interval defines how often order is executed.",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"BI_MONTHLY",
"QUARTERLY",
"HALFYEARLY",
"YEARLY",
"IRREGULAR"
],
"example": "MONTHLY",
"type": "string"
},
"intervalDue": {
"description": "Value represents order number of the day within particular period when the standing order will be reqularly executed.\nPossible values: 1-7 (for WEEKLY interval), 1-28 for MONTHLY, 1-2 for BI_MONTHLY, 1-3 for QUARTERLY, 1-6 for HALFYEARLY, 1-12 for YEARLY.\n",
"example": 15,
"type": "number"
},
"mode": {
"description": "The execution mode defines when or how standing order will be cancelled, processed the last time.\nPossible values: UNTIL_DATE (standing order is valid until specific date - field lastExecutionDate),\nUNTIL_CANCELLATION (standing order is valid forever and must be cancelled by client),\nAFTER_MAX_ITERATION_EXCEEDED (certain count of executions is specified - field maxIterations) or\nMAX_AMOUNT_EXCEEDED (maximum amount which can be transferred for this order is specified, if next\niteration would exceed this amount it is not executed - field maxAmount).\n",
"enum": [
"UNTIL_DATE",
"UNTIL_CANCELLATION",
"FTER_MAX_ITERATION_EXCEEDED",
"MAX_AMOUNT_EXCEEDED"
],
"example": "UNTIL_CANCELLATION",
"type": "string"
},
"modeDue": {
"description": "The execution due mode defines how the date when order should be executed is specified.\nPossible values: DUE_DAY_OF_MONTH (specific number of day in the month is defined) or\nDUE_OR_BEFORE_DAY_OF_MONTH (is defined as a specific day of the month or the previous day\nif the day falls on a non-banking day) or DUE_OR_NEXT_DAY_OF_MONTH (is defined as a specific\nday of the month or the next day if the day falls on a non-banking day) or\nDUE_LAST_DAY_OF_MONTH (order is executed on last day of particular month).\n",
"enum": [
"DUE_DAY_OF_MONTH",
"DUE_OR_BEFORE_DAY_OF_MONTH",
"DUE_OR_NEXT_DAY_OF_MONTH",
"DUE_LAST_DAY_OF_MONTH"
],
"example": "DUE_DAY_OF_MONTH",
"type": "string"
}
},
"required": [
"mode",
"interval"
],
"type": "object"
}
},
"required": [
"execution",
"debtorAccount"
],
"type": "object"
}
},
"required": [
"standingOrderIdentification",
"amount",
"standingOrder"
],
"type": "object"
}
],
"description": "Standing order\n",
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Nepovinný údaj o celkovém počtu záznamů přes všechny stránky. Pokud není možné tuto hodnotu přesně určit není uvedena.",
"type": "integer"
}
},
"required": [
"pageNumber",
"pageCount",
"pageSize",
"page"
],
"type": "object"
}
],
"description": "Set of clients standing orders.\n",
"type": "object"
}
}
x
- Request for a non-existing page (PAGE_NOT_FOUND)
- The value of the parameter is not valid (PARAMETER_INVALID)
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
},
"message": {
"description": "Nepovinný textový popi. Není určen pro interpretaci koncovému uživateli, ale např. pro obohacení error logu.",
"type": "string"
},
"scope": {
"description": "Určuje JSON path elementu requestu, který vedl k vyvolání chybového stavu.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
x
- Invalid/missing access token = user is not authorized (UNAUTHORISED)
- Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
},
"message": {
"description": "Nepovinný textový popi. Není určen pro interpretaci koncovému uživateli, ale např. pro obohacení error logu.",
"type": "string"
},
"scope": {
"description": "Určuje JSON path elementu requestu, který vedl k vyvolání chybového stavu.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
x
Calling of the method which does not correspond to the licence, or invalid certificate. (FORBIDDEN)
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
},
"message": {
"description": "Nepovinný textový popi. Není určen pro interpretaci koncovému uživateli, ale např. pro obohacení error logu.",
"type": "string"
},
"scope": {
"description": "Určuje JSON path elementu requestu, který vedl k vyvolání chybového stavu.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
x
/standingorders/{transactionIdentification}
Detail of client’s standing order
Detail of client’s standing order.
Resource characteristics:
- Authorization: request requires the authorization of user/client as part of API calling
- Use certificate: request requires the use of the qualified third-party certificate
- Paging: no
- Sorting: no
- Filtering: no
Transaction identificator
{
"maxLength": 35
}
Defines MIME media type of the resource. For example application/json or application/x-www-form-urlencoded (OAuth2 /auth resources) and application/xml in case of bulk payment initiation.
{
"maxLength": 50
}
Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters.
{
"maxLength": 60
}
Each request of a transaction contains the date and time at which the message was originated. In timestamp format.
IDs that identify the technical or business process within the call of each API request.
For example, it can be used to identify the process of retrieving a transaction history that is provided as a paged response available through multiple requests.
{
"maxLength": 60
}
The flag identifies if the end user is online and the request was made based on his activity.
Identifies the API's end-user IP address. The TPP should fill this value if the IP address can be detected. The address can be in IPv4 or IPv6 format.
{
"maxLength": 50
}
An element used to pass on information about what end-user IP port is using.
{
"maxLength": 40
}
The element is used to forward information about the end user operating system used.
{
"maxLength": 100
}
Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent.
{
"maxLength": 200
}
Local time on User's device.
End-user GPS coordinates (if the coordinates can be reliably detected).
Required format: GEO:Latitude;Longitude
Based on [RFC2426] in signed degrees format (DDD.dddd)
{
"maxLength": 100
}
It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI).
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
application/octet-stream
OK
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"allOf": [
{
"description": "Standing order identification and amount.\n",
"properties": {
"amount": {
"description": "Payment amount\n",
"properties": {
"instructedAmount": {
"description": "Amount and currency in the instruction\n",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"allOf": [
{
"description": "Standing order identification and amount.\n",
"properties": {
"amount": {
"description": "Payment amount\n",
"properties": {
"instructedAmount": {
"description": "Amount and currency in the instruction\n",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
"type": "string"
},
"value": {
"description": "Amount value",
"example": 10000,
"type": "number"
}
},
"required": [
"value",
"currency"
],
"type": "object"
}
},
"type": "object"
},
"standingOrderIdentification": {
"description": "Standing order identification\n",
"properties": {
"endToEndIdentification": {
"description": "End to end identification.\nRequired only for: SEPA payments.\n",
"maxLength": 35,
"type": "string"
},
"instructionIdentification": {
"description": "Payment identification entered by a third party, or a constant symbol may be entered.\n",
"maxLength": 35,
"type": "string"
},
"transactionIdentification": {
"description": "Transaction identification\n",
"maxLength": 35,
"type": "string"
}
},
"required": [
"instructionIdentification"
],
"type": "object"
},
"chargeBearer": {
"description": "Provides the party (parties) that will pay fees associated with the payment transaction processing.\n\nTUZEM (Domestic payments): The code of the fee payer cannot be chosen (the payer always pays the fees of the payer's bank\nand the payee pays the fees of the payee's bank). When processing domestic payments within CNB clearing,\nthe fee payer's code is not stated.\n\nSEPA (SEPA payments): The code of the fee payer cannot be chosen (the payer always pays the fees of the payer's bank\nand the payee pays the fees of the payee's bank).\nIn SEPA payment processing, the payer's bank will always complete the SLEV value.\n\nEHP (Foreign payments within EEA): Permitted values are DEBT = OUR or SHAR = SHA. If no value is filled in,\nthe payer's bank will fill in the SHAR value.\n\nNONEHP (Foreign payments outside EEA): Permitted values are DEBT = OUR or CRED = BEN or SHAR = SHA. If no value is filled in,\nthe payer's bank will fill in the SHAR value.\n",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
],
"type": "string"
},
"creditor": {
"description": "Payee Recipient.",
"properties": {
"name": {
"description": "Recipient name.",
"maxLength": 70,
"minLength": 1,
"type": "string"
},
"postalAddress": {
"description": "Postal address.",
"properties": {
"addressLine": {
"description": "Unstructured postal address record.",
"items": {
"maxLength": 70,
"type": "string"
},
"type": "array"
},
"buildingNumber": {
"description": "House number used for mailing address.",
"maxLength": 16,
"type": "string"
},
"country": {
"description": "The name of the country used for the postal address.\n",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"postCode": {
"description": "Zip code used for mailing address.",
"maxLength": 16,
"type": "string"
},
"streetName": {
"description": "The street name used for the postal address.",
"maxLength": 70,
"type": "string"
},
"townName": {
"description": "The name of the city used for the postal address.",
"maxLength": 35,
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"creditorAccount": {
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
"type": "string"
},
"identification": {
"description": "Payment recipient account identification.\n",
"properties": {
"iban": {
"description": "International Bank Account Number (IBAN)",
"example": "CZ0708000000001019382023",
"maxLength": 34,
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
"type": "string"
},
"other": {
"properties": {
"identification": {
"maxLength": 35,
"type": "string"
}
},
"required": [
"identification"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"identification"
],
"type": "object"
},
"creditorAgent": {
"description": "Recipient's bank information. It follows the direction of payment, is filled in counterparty.\n",
"properties": {
"financialInstitutionIdentification": {
"properties": {
"bic": {
"type": "string"
},
"clearingSystemMemberIdentification": {
"description": "Local format of the payer's or payee's bank code - either in code form or text description.\n",
"properties": {
"clearingSystemIdentification": {
"description": "Identification of the payer's or payee's bank in the local payment system in which the payer's or payee's bank operates.\n",
"properties": {
"code": {
"description": "Bank identification in the local payment system.\n",
"type": "string"
},
"proprietary": {
"description": "Free format.",
"maxLength": 35,
"type": "string"
}
},
"type": "object"
},
"memberIdentification": {
"description": "Local format of the payer's bank code..",
"maxLength": 35,
"type": "string"
}
},
"required": [
"memberIdentification"
],
"type": "object"
},
"name": {
"maxLength": 140,
"type": "string"
},
"other": {
"description": "Other identification of the payer's or payee's bank.\n",
"properties": {
"identification": {
"description": "Other identification of the payer's or payee's bank, especially in the form of local bank code.\n",
"maxLength": 35,
"type": "string"
}
},
"type": "object"
},
"postalAddress": {
"description": "Postal address.",
"properties": {
"addressLine": {
"description": "Unstructured postal address record.",
"items": {
"maxLength": 70,
"type": "string"
},
"type": "array"
},
"buildingNumber": {
"description": "House number used for mailing address.",
"maxLength": 16,
"type": "string"
},
"country": {
"description": "The name of the country used for the postal address.\n",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"postCode": {
"description": "Zip code used for mailing address.",
"maxLength": 16,
"type": "string"
},
"streetName": {
"description": "The street name used for the postal address.",
"maxLength": 70,
"type": "string"
},
"townName": {
"description": "The name of the city used for the postal address.",
"maxLength": 35,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"debtorAccount": {
"description": "Information on the account payer. It is according to the payment direction, and filled in in the case of counterparty.\n",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
"type": "string"
},
"identification": {
"description": "Payer account identification.\n",
"properties": {
"iban": {
"description": "International Bank Account Number (IBAN)",
"example": "CZ0708000000001019382023",
"maxLength": 34,
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
"type": "string"
}
},
"required": [
"iban"
],
"type": "object"
},
"name": {
"description": "Payer account name.\n",
"type": "string"
}
},
"required": [
"identification"
],
"type": "object"
},
"paymentTypeInformation": {
"description": "Payment type information",
"properties": {
"instructionPriority": {
"enum": [
"NORM",
"HIGH",
"INST"
],
"type": "string"
}
},
"type": "object"
},
"remittanceInformation": {
"description": "Additional payment information.",
"properties": {
"debtorMessage": {
"description": "Payer's message.\nNote This attribute is not part of COBS.\n\n**COBS non-compliant API** - this attribute is not a part of COBS.\n",
"type": "string"
},
"structured": {
"description": "Payment symbols are expected to be filled (variable, specific, and constant).\nIf a variable, specific, or constant symbol has not been filled in the payment,\nthen the entire Structured Remittance Information will remain blank.\n",
"properties": {
"creditorReferenceInformation": {
"description": "To display information about a variable, specific, and constant sympol. symbolu.",
"properties": {
"reference": {
"description": "Field starts with VS code: (for variable symbol), or SS: (for a specific symbol) or KS: (for a constant symbol).\nAll can be listed in one repeating field reference three symbols, always a maximum of one repeat each single symbol.\nThe way to record symbols is: (VS:|KS:|SS:)[0-9]{1,10}.\n",
"items": {
"pattern": "^[KSV]S:\\d{1,10}$",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"unstructured": {
"description": "Additional payment information filled in as unstructured information.\nIf multiple repetitions are listed in the payment unstructured record of additional payment information,\nthen takes only the first occurrence.\n",
"maxLength": 140,
"type": "string"
}
},
"type": "object"
},
"requestedExcutionDate": {
"description": "Requested date of payment.\n",
"format": "date",
"type": "string"
},
"standingOrder": {
"description": "Structure describint the parameters of the standing orders.\n",
"properties": {
"alias": {
"description": "Description resp. the user-defined standing order payment name.\n",
"example": "Payments for lunch - kindergarten Michal",
"maxLength": 250,
"type": "string"
},
"exceptions": {
"description": "Elements defining exceptions to executing a standing order.\n",
"properties": {
"breaks": {
"description": "Break periods.\n",
"properties": {
"validFromDate": {
"description": "Start date of one break period. Standing order will not be processed from this date.\n",
"format": "date",
"type": "string"
},
"validToDate": {
"description": "End date of one break period. Standing order will not be processed to this date.\n",
"format": "date",
"type": "string"
}
},
"required": [
"validFromDate",
"validToDate"
],
"type": "object"
},
"stoppages": {
"description": "List of months where there is no payment (only applicable with interval IRREGULAR).\nPossible values: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER\n",
"items": {
"maxLength": 20,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"execution": {
"description": "Features of execution a standing order for payment.",
"properties": {
"interval": {
"description": "Execution interval defines how often order is executed.",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"BI_MONTHLY",
"QUARTERLY",
"HALFYEARLY",
"YEARLY",
"IRREGULAR"
],
"example": "MONTHLY",
"type": "string"
},
"intervalDue": {
"description": "Value represents order number of the day within particular period when the standing order will be reqularly executed.\nPossible values: 1-7 (for WEEKLY interval), 1-28 for MONTHLY, 1-2 for BI_MONTHLY, 1-3 for QUARTERLY, 1-6 for HALFYEARLY, 1-12 for YEARLY.\n",
"example": 15,
"type": "number"
},
"mode": {
"description": "The execution mode defines when or how standing order will be cancelled, processed the last time.\nPossible values: UNTIL_DATE (standing order is valid until specific date - field lastExecutionDate),\nUNTIL_CANCELLATION (standing order is valid forever and must be cancelled by client),\nAFTER_MAX_ITERATION_EXCEEDED (certain count of executions is specified - field maxIterations) or\nMAX_AMOUNT_EXCEEDED (maximum amount which can be transferred for this order is specified, if next\niteration would exceed this amount it is not executed - field maxAmount).\n",
"enum": [
"UNTIL_DATE",
"UNTIL_CANCELLATION",
"FTER_MAX_ITERATION_EXCEEDED",
"MAX_AMOUNT_EXCEEDED"
],
"example": "UNTIL_CANCELLATION",
"type": "string"
},
"modeDue": {
"description": "The execution due mode defines how the date when order should be executed is specified.\nPossible values: DUE_DAY_OF_MONTH (specific number of day in the month is defined) or\nDUE_OR_BEFORE_DAY_OF_MONTH (is defined as a specific day of the month or the previous day\nif the day falls on a non-banking day) or DUE_OR_NEXT_DAY_OF_MONTH (is defined as a specific\nday of the month or the next day if the day falls on a non-banking day) or\nDUE_LAST_DAY_OF_MONTH (order is executed on last day of particular month).\n",
"enum": [
"DUE_DAY_OF_MONTH",
"DUE_OR_BEFORE_DAY_OF_MONTH",
"DUE_OR_NEXT_DAY_OF_MONTH",
"DUE_LAST_DAY_OF_MONTH"
],
"example": "DUE_DAY_OF_MONTH",
"type": "string"
}
},
"required": [
"mode",
"interval"
],
"type": "object"
},
"validity": {
"description": "Elements restricting the validity of the standing order.\n",
"properties": {
"lastExecutionDate": {
"description": "Elements restricting the validity of the standing order.\n",
"format": "date",
"type": "string"
},
"maxAmount": {
"allOf": [
{
"description": "Payment amount\n",
"properties": {
"instructedAmount": {
"description": "Amount and currency in the instruction\n",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.\n",
"example": "CZK",
"pattern": "[A-Z]{3}",
"type": "string"
},
"value": {
"description": "Amount value",
"example": 10000,
"type": "number"
}
},
"required": [
"value",
"currency"
],
"type": "object"
}
},
"type": "object"
}
],
"description": "Maximum amount to be transferred using the standing order.\nOnly applicable in combination with executionMode AFTER_MAX_AMOU NT_EXCEEDED.\n",
"type": "object"
},
"maxIterations": {
"description": "Maximum number of iterations - processing of the standing order.\nOnly applicable in combination with executionMode AFTER_MAX_ITERAT ION_EXCEEDED.\n",
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"execution"
],
"type": "object"
},
"ultimateCreditor": {
"properties": {
"identification": {
"description": "Identification of payer or payee.\n",
"properties": {
"organisationIdentification": {
"allOf": [
{
"properties": {
"bicOrBei": {
"description": "Unique identification of the payer or payee as an organization\/legal entity persons.\nIn BIC or BEI code form.\n",
"type": "string"
}
}
},
{
"description": "Unique identification of payer or payee.\n",
"properties": {
"other": {
"description": "Other identification of payer or payee.\n",
"properties": {
"identification": {
"description": "Other identification of payer or payee in unstructured form.\n",
"maxLength": 35,
"type": "string"
},
"issuer": {
"description": "Code publisher to identify payer or payee.",
"maxLength": 35,
"type": "string"
},
"schemaName": {
"description": "Code type to identify the payer or payee.\n",
"properties": {
"proprietary": {
"description": "Code type to identify the payer or payee in free text format.\n",
"maxLength": 35,
"type": "string"
}
},
"required": [
"proprietary"
],
"type": "object"
}
},
"required": [
"identification"
],
"type": "object"
}
},
"type": "object"
}
],
"description": "Unique identification of the payer or payee as an organization\/legal entity persons.\n",
"type": "object"
},
"privateIdentification": {
"allOf": [
{
"description": "Unique identification of payer or payee.\n",
"properties": {
"other": {
"description": "Other identification of payer or payee.\n",
"properties": {
"identification": {
"description": "Other identification of payer or payee in unstructured form.\n",
"maxLength": 35,
"type": "string"
},
"issuer": {
"description": "Code publisher to identify payer or payee.",
"maxLength": 35,
"type": "string"
},
"schemaName": {
"description": "Code type to identify the payer or payee.\n",
"properties": {
"proprietary": {
"description": "Code type to identify the payer or payee in free text format.\n",
"maxLength": 35,
"type": "string"
}
},
"required": [
"proprietary"
],
"type": "object"
}
},
"required": [
"identification"
],
"type": "object"
}
},
"type": "object"
}
],
"description": "Unique identification of the payer or payee as a individual.",
"type": "object"
}
},
"type": "object"
},
"name": {
"maxLength": 140,
"type": "string"
},
"postalAddress": {
"description": "Postal address.",
"properties": {
"addressLine": {
"description": "Unstructured postal address record.",
"items": {
"maxLength": 70,
"type": "string"
},
"type": "array"
},
"buildingNumber": {
"description": "House number used for mailing address.",
"maxLength": 16,
"type": "string"
},
"country": {
"description": "The name of the country used for the postal address.\n",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"postCode": {
"description": "Zip code used for mailing address.",
"maxLength": 16,
"type": "string"
},
"streetName": {
"description": "The street name used for the postal address.",
"maxLength": 70,
"type": "string"
},
"townName": {
"description": "The name of the city used for the postal address.",
"maxLength": 35,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ultimateDebtor": {
"properties": {
"identification": {
"description": "Identification of payer or payee.\n",
"properties": {
"organisationIdentification": {
"allOf": [
{
"properties": {
"bicOrBei": {
"description": "Unique identification of the payer or payee as an organization\/legal entity persons.\nIn BIC or BEI code form.\n",
"type": "string"
}
}
},
{
"description": "Unique identification of payer or payee.\n",
"properties": {
"other": {
"description": "Other identification of payer or payee.\n",
"properties": {
"identification": {
"description": "Other identification of payer or payee in unstructured form.\n",
"maxLength": 35,
"type": "string"
},
"issuer": {
"description": "Code publisher to identify payer or payee.",
"maxLength": 35,
"type": "string"
},
"schemaName": {
"description": "Code type to identify the payer or payee.\n",
"properties": {
"proprietary": {
"description": "Code type to identify the payer or payee in free text format.\n",
"maxLength": 35,
"type": "string"
}
},
"required": [
"proprietary"
],
"type": "object"
}
},
"required": [
"identification"
],
"type": "object"
}
},
"type": "object"
}
],
"description": "Unique identification of the payer or payee as an organization\/legal entity persons.\n",
"type": "object"
},
"privateIdentification": {
"allOf": [
{
"description": "Unique identification of payer or payee.\n",
"properties": {
"other": {
"description": "Other identification of payer or payee.\n",
"properties": {
"identification": {
"description": "Other identification of payer or payee in unstructured form.\n",
"maxLength": 35,
"type": "string"
},
"issuer": {
"description": "Code publisher to identify payer or payee.",
"maxLength": 35,
"type": "string"
},
"schemaName": {
"description": "Code type to identify the payer or payee.\n",
"properties": {
"proprietary": {
"description": "Code type to identify the payer or payee in free text format.\n",
"maxLength": 35,
"type": "string"
}
},
"required": [
"proprietary"
],
"type": "object"
}
},
"required": [
"identification"
],
"type": "object"
}
},
"type": "object"
}
],
"description": "Unique identification of the payer or payee as a individual.",
"type": "object"
}
},
"type": "object"
},
"name": {
"maxLength": 140,
"type": "string"
},
"postalAddress": {
"description": "Postal address.",
"properties": {
"addressLine": {
"description": "Unstructured postal address record.",
"items": {
"maxLength": 70,
"type": "string"
},
"type": "array"
},
"buildingNumber": {
"description": "House number used for mailing address.",
"maxLength": 16,
"type": "string"
},
"country": {
"description": "The name of the country used for the postal address.\n",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"postCode": {
"description": "Zip code used for mailing address.",
"maxLength": 16,
"type": "string"
},
"streetName": {
"description": "The street name used for the postal address.",
"maxLength": 70,
"type": "string"
},
"townName": {
"description": "The name of the city used for the postal address.",
"maxLength": 35,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"standingOrderIdentification",
"amount",
"standingOrder",
"debtorAccount",
"creditorAccount"
],
"type": "object"
}
],
"description": "Standing order\n",
"type": "object"
}
}
x
- Invalid/missing access token = user is not authorized (UNAUTHORISED)
- Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
},
"message": {
"description": "Nepovinný textový popi. Není určen pro interpretaci koncovému uživateli, ale např. pro obohacení error logu.",
"type": "string"
},
"scope": {
"description": "Určuje JSON path elementu requestu, který vedl k vyvolání chybového stavu.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
x
Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING)
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
},
"message": {
"description": "Nepovinný textový popi. Není určen pro interpretaci koncovému uživateli, ale např. pro obohacení error logu.",
"type": "string"
},
"scope": {
"description": "Určuje JSON path elementu requestu, který vedl k vyvolání chybového stavu.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
x
Method not implemented (NOT_IMPLEMENTED)
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"errors": {
"description": "Nadřazený element obsahující kolekci všech chybových stavů",
"items": {
"description": "Chybový stav",
"properties": {
"parameters": {
"additionalProperties": true,
"description": "Pole dodatečných elementů specifických pro daný chybový kód. Tyto parametry jsou specifikovány vždy v popis konkrétního chybového kódu.",
"type": "object"
},
"error": {
"description": "Obsahuje specifický chybový kód",
"type": "string"
},
"message": {
"description": "Nepovinný textový popi. Není určen pro interpretaci koncovému uživateli, ale např. pro obohacení error logu.",
"type": "string"
},
"scope": {
"description": "Určuje JSON path elementu requestu, který vedl k vyvolání chybového stavu.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
x
Definitions
Clients account
{
"type": "object",
"required": [
"id",
"identification",
"servicer"
],
"properties": {
"id": {
"type": "string",
"description": "API identifier of payment account API identifier of payment account"
},
"identification": {
"$ref": "#/definitions/AccountIdentification"
},
"currency": {
"type": "string",
"description": "Payer account currency eg. CZK"
},
"servicer": {
"$ref": "#/definitions/AccountServicer"
},
"nameI18N": {
"type": "string",
"description": "Account name"
},
"productI18N": {
"type": "string",
"description": "Product name"
},
"ownersNames": {
"$ref": "#/definitions/ownersNames"
}
}
}
Payer account identification
{
"type": "object",
"required": [
"iban"
],
"properties": {
"iban": {
"type": "string",
"description": "IBAN"
},
"other": {
"type": "string",
"description": "Other identifier of payer account eg. account number"
}
}
}
Array of name/s of the account holder/s for consumers or trade name/s for commercial clients
{
"type": "array",
"example": [
"Jan Bílý",
"Adam Červené",
"Petr Žlutá"
],
"items": {
"$ref": "#/definitions/ownerName"
}
}
Name and Surname of the owner
{
"type": "string",
"maxLength": 100
}
Collection of clients accounts
{
"allOf": [
{
"$ref": "#/definitions/PagedList"
},
{
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "array",
"items": {
"$ref": "#/definitions/Account"
}
}
}
}
]
}
{
"type": "object",
"properties": {
"bankCode": {
"type": "string"
},
"countryCode": {
"type": "string",
"description": "Country of the bank"
},
"bic": {
"type": "string",
"description": "BIC code of the bank"
}
}
}
Clients payment account balance
{
"type": "object",
"required": [
"type",
"amount",
"creditDebitIndicator",
"date"
],
"properties": {
"type": {
"$ref": "#/definitions/BalanceType"
},
"creditLine": {
"$ref": "#/definitions/BalanceTypeCreditLine"
},
"amount": {
"$ref": "#/definitions/MonetaryAmount"
},
"creditDebitIndicator": {
"type": "string",
"description": "Indication if balance on requested account is positive or negative"
},
"date": {
"$ref": "#/definitions/DateTimeDateTime"
}
}
}
Collection of account balances on clients payment account
{
"type": "object",
"required": [
"balances"
],
"properties": {
"balances": {
"type": "array",
"items": {
"$ref": "#/definitions/Balance"
}
}
}
}
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "Balance type codes"
}
}
}
Amount of allowed debit / overdraft
{
"type": "object",
"properties": {
"included": {
"type": "boolean"
},
"amount": {
"$ref": "#/definitions/MonetaryAmountOptional"
}
}
}
Describes balance type, for which belongs information about balance
{
"type": "object",
"required": [
"codeOrProprietary"
],
"properties": {
"codeOrProprietary": {
"$ref": "#/definitions/BalanceTypeCodeOrProprietary"
}
}
}
Date and time by ISO 8601
{
"type": "object",
"required": [
"dateTime"
],
"properties": {
"dateTime": {
"description": "Date or date and time by ISO 8601",
"type": "string",
"format": "date-time"
}
}
}
Monetary amount
{
"type": "object",
"required": [
"value",
"currency"
],
"properties": {
"value": {
"type": "number",
"description": "Amount"
},
"currency": {
"type": "string",
"description": "Currency eg. CZK"
}
}
}
Monetary amount (optional attributes)
{
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Amount"
},
"currency": {
"type": "string",
"description": "Currency eg. CZK"
}
}
}
Paged collection
{
"type": "object",
"required": [
"pageNumber",
"pageCount",
"pageSize"
],
"properties": {
"pageNumber": {
"type": "integer",
"description": "Number of current page"
},
"pageCount": {
"type": "integer",
"description": "Total number of query pages"
},
"nextPage": {
"type": "integer",
"description": "Number of the following page. In case if current page is last page of list, this parametr is not listed, respectiveli is listed with value null."
},
"pageSize": {
"type": "integer",
"description": "Number of records on page. This parameter can respond to requested value of size from request except when it is the last page, or in case when requested range of pages exceeded maximal limit defined for specific API source."
},
"totalCount": {
"type": "integer",
"description": "Optional parameter which informs about number of records over all pages. If it´s impossible to exactly define this value it is not filled."
}
}
}
Transaction
{
"type": "object",
"required": [
"bookingDate",
"amount"
],
"properties": {
"bookingDate": {
"description": "Booking date",
"type": "string",
"format": "date"
},
"transactionType": {
"description": "Transaction category",
"type": "string"
},
"counterPartyAccount": {
"description": "Counter part account number",
"$ref": "#/definitions/TransactionAccount"
},
"productBankRef": {
"description": "Product ID, which belongs to transaction (eg. payment card number)",
"type": "string"
},
"amount": {
"description": "Amount",
"$ref": "#/definitions/MonetaryAmount"
},
"fee": {
"description": "Fee",
"$ref": "#/definitions/MonetaryAmount"
},
"description": {
"description": "Description",
"type": "string"
}
}
}
Paged collection
{
"allOf": [
{
"$ref": "#/definitions/PagedList"
},
{
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
}
}
}
}
]
}
Account
{
"type": "object",
"required": [
"accountNumber",
"bankCode"
],
"properties": {
"accountNumberPrefix": {
"description": "Prefix",
"type": "string"
},
"accountNumber": {
"description": "Account number",
"type": "string"
},
"bankCode": {
"description": "Bank code",
"type": "string"
},
"accountName": {
"description": "Account name",
"type": "string"
}
}
}
Error status
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Contains specific error code"
},
"parameters": {
"type": "object",
"additionalProperties": true,
"description": "Field with additiona specific elements for error code. These parameters are every time specified in description of specific error."
},
"scope": {
"type": "string",
"description": "Defines JSON path of request element, which leads to causing of error status."
},
"message": {
"type": "string",
"description": "Optional text description. It´s not used to interpretation for client. It is used for example to enriche error log."
}
}
}
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"description": "Parent element with collection of all error statuses",
"items": {
"$ref": "#/definitions/Error"
}
}
}
}