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 his type.
Paths
/payments/balanceCheck
Request for balancheck
Source for balance check request on specific account of specific payer. This source is authorized by account owner via authorization resource. Access to informations has to be granted by client outside of this API before it will be used to this source.
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
- Missing mandatory field in requestu. (FIELD_MISSING)
- Invalid field value. (FIELD_INVALID)
- [InvalidDebtorAccountNumber] – Invalid account identifier in request values. (AC02)
- [InvalidAccountCurrency] – Invalid currency on requested account. (AC09)
- [InvalidTransactionCurrency] – In request is filled unsupported currency. (AM11)
- [InvalidAmount] – Invalid ammount. eg. too low, too high or invalid fomat of filled number, including decimal part of number by ISO 4217. (AM12)
- [Invalid File Format] – invalid JSON format, or different problem with processing of request. (FF01)
- Narrative – general problem for payment rejection, with additional information about problem. (NARR)
- [NotUniqueTransactionReference] – Non-unique application identifier. (RF01)
- [InvalidCharacterSet] – Invalid charset in request. (RR10)
Missing certificate. (UNAUTHORISED)
- Call of method which does not responde to license or certificate. (FORBIDDEN)
- [TransactionForbidden] – Unexsisting consent with access to information about balance on account. (AG01)
/payments
New payment - payment initiation
Resource for new payment initiation.
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
- Missing mandatory field in requestu. (FIELD_MISSING)
- Invalid field value. (FIELD_INVALID)
- [InvalidDebtorAccountNumber] – Invalid account identifier in request values. (AC02)
- [InvalidAccountCurrency] – Invalid currency on requested account. (AC09)
- [InvalidTransactionCurrency] – In request is filled unsupported currency. (AM11)
- [InvalidAmount] – Invalid ammount. eg. too low, too high or invalid fomat of filled number, including decimal part of number by ISO 4217. (AM12)
- [Invalid File Format] – invalid JSON format, or different problem with processing of request. (FF01)
- Narrative – general problem for payment rejection, with additional information about problem. (NARR)
- [NotUniqueTransactionReference] – Non-unique application identifier. (RF01)
- [InvalidCharacterSet] – Invalid charset in request. (RR10)
Missing certificate. (UNAUTHORISED)
- Call of method which does not responde to license or certificate. (FORBIDDEN)
- [TransactionForbidden] – Unexsisting consent with access to information about balance on account. (AG01)
/payments/{paymentId}/status
Status of created/initiated payment
Resource used to display payment status. It means status of created payment, which has not yet been authorized by client or has already been authorized and PISP is requesting its status (GET). COBS non-compliant API - this API is a secured one.
Payment identification
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
- Missing mandatory field in requestu. (FIELD_MISSING)
- Invalid field value. (FIELD_INVALID)
- [InvalidDebtorAccountNumber] – Invalid account identifier in request values. (AC02)
- [InvalidAccountCurrency] – Invalid currency on requested account. (AC09)
- [InvalidTransactionCurrency] – In request is filled unsupported currency. (AM11)
- [InvalidAmount] – Invalid ammount. eg. too low, too high or invalid fomat of filled number, including decimal part of number by ISO 4217. (AM12)
- [Invalid File Format] – invalid JSON format, or different problem with processing of request. (FF01)
- Narrative – general problem for payment rejection, with additional information about problem. (NARR)
- [NotUniqueTransactionReference] – Non-unique application identifier. (RF01)
- [InvalidCharacterSet] – Invalid charset in request. (RR10)
Missing certificate. (UNAUTHORISED)
- Call of method which does not responde to license or certificate. (FORBIDDEN)
- [TransactionForbidden] – Unexsisting consent with access to information about balance on account. (AG01)
/payments/{paymentId}
Information about entered/initiated payment
Resource used to display information about entered payment. It means the payment which was accepted for authorization but not yet authorized by the client. Resource works only with transactions which were created via the specific provider.
Payment identification
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’.
/payments/{paymentId}/sign/{signId}
Step II. Initiation of payment authorization - specific for every bank
This resource is used for start of specific authorization method for chosen scenarion.
Payment identification
Unambiguous identifier for current authorization of transaction
Url to redirect back to TPP
Code of requested authorization (from authorization scenarios)
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
This resource cannot be authorized by this method. (AUTH_LIMIT_EXCEEDED)
Invalid/missing access token = user is unauthorized (UNAUTHORISED)
Invalid/missing certificate = provider unauthorized (FORBIDDEN)
Requested ID not exist (ID_NOT_FOUND)
/standingorders
New standing order
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
- [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful (status code ACTC)
- [Rejected] - Payment initiation or individual transaction included in the payment initiation has been rejected (status code RJCT)
- [AcceptedWithChange] - Instruction is accepted but a change will be made, such as date or remittance not change (status code ACWC)
{
"schema": {
"description": "Response for new\/edit\/delete standing order initiation",
"properties": {
"paymentTypeInformation": {
"description": "A set of elements used to further determine the transaction type.\nIt is used to determine the speed and method of payment processing.\n",
"properties": {
"serviceLevel": {
"description": "Service placement (within type of payment)",
"properties": {
"code": {
"description": "Type of entered payment.\n- DMCT - [DoMestic Credit Transfer] Domestic payment\n- ESCT - [SEPA Credit Transfer] – SEPA payment\n- XBCT - [Cross-Border Credit Transfer] – Cross border payment\n- EXCT - [EEA X-border Credit Transfers] – Cross border payment within the EEP\n- NXCT - [Non-EEA X-border Credit Transfers] – Cross border payment outside the EEP\n",
- Missing mandatory field in the request. (FIELD_MISSING)
- FIELD value is not valid. (FIELD_INVALID)
- [InvalidDebtorAccountNumber] – invalid account identifier in the request content. (AC02)
- [InvalidCreditorAccountNumber] – recipient account number is closed, blocked, credit card are disabled for the account type, or the recipient's account number is in invalid format (note: only valid for in-house payments). (AC03)
- [InvalidDebtorAccountCurrency] - the specified payer account currency does not correspond to the client's account currency for the account number held in the bank. (AC10)
- [InvalidAccountType] - account type does not match allowed account types (e.g., a non-paying account). (AC12)
- [TransactionForbidden] – absent consent to access to Balance Check at the account. (AG01)
- [Duplication] - this is a duplicate. Universal code for a duplicate CISP query or a duplicate payment via GIS (non-unique payment reference). (AM05)
- [InvalidTransactionCurrency] – the request contains a currency not trade/not supported. (AM11)
- [InvalidAmount] – wrong amount. For instance, too low or high amount or wrong number format according to the number of decimal places according to the ISO 4217. (AM12)
- [Invalid File Format] – invalid JSON forma tor other technical problem with the query processing. (FF01)
- [InvalidChargeBearerCode] - invalid fee type for the given transaction type. (BE19)
- [InvalidDate] - non-existent date value or format. Maturity in the future or in the past. Transactions on a non-business day of a bank. (DT01)
- [InvalidCreditorBICIdentifier] – invalid recipient SWIFT / BIC code. (RC07)
- [InvalidCreditorClearingSystemMemberIdentifier] - invalid recipient bank code identification. (RC10)
- [MissingCreditorNameOrAddress] - the field is missing the required data about the recipient's name or address (or its part). If the data is in bad format, the error code FIELD_INVALID is used. (RR03)
- [InvalidCharacterSet] – invalid character set in the request. (RR10)
- [RECEIVER_SAME_AS_SENDER] – payer's account is the same as the payee's account (Applies to all types of payments). (REC_SEND)
- Narrative – a general reason for rejecting the payment, with an addition of error-related information. (NARR)
{
"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."- Invalid/missing access token = user is not authorized (UNAUTHORISED)
- Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
{
"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."Calling of the method which does not correspond to the licence, or invalid certificate. (FORBIDDEN)
{
"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."/standingorders/{standingOrderId}
Detail about the standing order
Resource for get detail about the standing order
Identification for standing order
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.
The flag identifies if the end user is online and the request was made based on his activity.
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
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
}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 identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
Standing order detail
- Invalid/missing access token = user is not authorized (UNAUTHORISED)
- Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING)
Method not implemented (NOT_IMPLEMENTED)
Delete an unauthorized standing order
Resource to delete an unauthorized standing order. Deletion is not require authorization because is not received by bank.
Identification for standing order
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.
The flag identifies if the end user is online and the request was made based on his activity.
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
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
}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 identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
- [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful (status code ACTC)
- [Rejected] - Payment initiation or individual transaction included in the payment initiation has been rejected (status code RJCT)
- [AcceptedWithChange] - Instruction is accepted but a change will be made, such as date or remittance not change (status code ACWC)
- Invalid/missing access token = user is not authorized (UNAUTHORISED)
- Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
Calling of the method which does not correspond to the licence, or invalid certificate. (FORBIDDEN)
Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING)
Method not implemented (NOT_IMPLEMENTED)
Change of standing order specification
Resource for change of standing order specification.
Identification for standing order
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.
The flag identifies if the end user is online and the request was made based on his activity.
The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’.
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
}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 identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’.
- [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful (status code ACTC)
- [Rejected] - Payment initiation or individual transaction included in the payment initiation has been rejected (status code RJCT)
- [AcceptedWithChange] - Instruction is accepted but a change will be made, such as date or remittance not change (status code ACWC)
- Missing mandatory field in the request. (FIELD_MISSING)
- FIELD value is not valid. (FIELD_INVALID)
- [InvalidDebtorAccountNumber] – invalid account identifier in the request content. (AC02)
- [InvalidCreditorAccountNumber] – recipient account number is closed, blocked, credit card are disabled for the account type, or the recipient's account number is in invalid format (note: only valid for in-house payments). (AC03)
- [InvalidDebtorAccountCurrency] - the specified payer account currency does not correspond to the client's account currency for the account number held in the bank. (AC10)
- [InvalidAccountType] - account type does not match allowed account types (e.g., a non-paying account). (AC12)
- [TransactionForbidden] – absent consent to access to Balance Check at the account. (AG01)
- [Duplication] - this is a duplicate. Universal code for a duplicate CISP query or a duplicate payment via GIS (non-unique payment reference). (AM05)
- [InvalidTransactionCurrency] – the request contains a currency not trade/not supported. (AM11)
- [InvalidAmount] – wrong amount. For instance, too low or high amount or wrong number format according to the number of decimal places according to the ISO 4217. (AM12)
- [Invalid File Format] – invalid JSON forma tor other technical problem with the query processing. (FF01)
- [InvalidChargeBearerCode] - invalid fee type for the given transaction type. (BE19)
- [InvalidDate] - non-existent date value or format. Maturity in the future or in the past. Transactions on a non-business day of a bank. (DT01)
- [InvalidCreditorBICIdentifier] – invalid recipient SWIFT / BIC code. (RC07)
- [InvalidCreditorClearingSystemMemberIdentifier] - invalid recipient bank code identification. (RC10)
- [MissingCreditorNameOrAddress] - the field is missing the required data about the recipient's name or address (or its part). If the data is in bad format, the error code FIELD_INVALID is used. (RR03)
- [InvalidCharacterSet] – invalid character set in the request. (RR10)
- [RECEIVER_SAME_AS_SENDER] – payer's account is the same as the payee's account (Applies to all types of payments). (REC_SEND)
- Narrative – a general reason for rejecting the payment, with an addition of error-related information. (NARR)
- Invalid/missing access token = user is not authorized (UNAUTHORISED)
- Invalid/missing certificate = provider is not authorized (UNAUTHORISED)
Calling of the method which does not correspond to the licence, or invalid certificate. (FORBIDDEN)
Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING)
/standingorders/{standingOrderId}/sign/{signId}
Second step of standing order authorization
Identification for standing order
Jedinečný identifikátor aktuální autorizace transakce
Url na redirect zpět k TPP
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’.
Code of required authorization (from authorization scenarios)
{
"schema": {
"properties": {
"authorizationType": {
"description": "Code of required authorization (from authorization scenarios)",
"type": "string"
}
},
"required": [
"authorizationType"
],
"type": "object"
}
}application/octet-stream
Success answer
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"properties": {
"authorizationType": {
"description": "Code of required authorization (from authorization scenarios)",
"type": "string"
},
"formData": {
"description": "Optional element. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element.\nContains data for sending in redirecting to federated authorization.\n",
"properties": {
"SAMLRequest": {
"description": "Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element.\nContains data of SAML request.\n",
"type": "string"
},
The resource may not be authorized with this method (AUTH_LIMIT_EXCEEDED)
{
"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"
- 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"
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"
Requested id not found (ID_NOT_FOUND)
{
"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"
/standingorders/{standingOrderId}/status
Resource for getting status of the standing order
Identification for standing order
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
Success answer
{
"headers": {
"X-Request-ID": {
"description": "Unique identifier for each request specified by TPP returned in response header.\n",
"type": "string"
}
},
"schema": {
"description": "Status of entered\/initiated standing order\n\nproperty instructionStatus values:\n* ACTC: [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful\n* RJCT: [Rejected] - Payment initiation or individual transaction included in the payment initiation has been rejected\n* ACSP: [AcceptedSettlementInProcess] - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution\n",
"properties": {
"instructionStatus": {
"description": "Status of entered payment\nACTC: [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful\nRJCT: [RejeThe resource may not be authorized with this method (AUTH_LIMIT_EXCEEDED)
{
"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"
- 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"
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"
Definitions
Metoda ověření
{
"title": "AuthenticationMethod",
"example": "NPIN",
"type": "string",
"enum": [
"NPIN",
"PPSG",
"PSWD",
"SCRT",
"SCNL",
"SNCT",
"CPSG",
"ADDB",
"BIOM",
"CDHI",
"CRYP",
"CSCV",
"PSVE",
"CSEC",
"ADDS",
"TOKP"
]
}
{
"title": "AuthorizationTypeWrapper",
"type": "object",
"properties": {
"authorizationType": {
"description": "Code of required authorization (from authorization scenarios)",
"type": "string"
}
},
"required": [
"authorizationType"
]
}
Transakční karta
{
"title": "Card",
"type": "object",
"properties": {
"cardholderName": {
"description": "Jméno držitele karty",
"type": "string",
"maxLength": 45
},
"maskedPan": {
"description": "Maskované číslo karty",
"type": "string",
"minLength": 1,
"maxLength": 30
}
},
"required": [
"maskedPan"
]
}
Identifikace banky plátce nebo příjemce v lokálním platebním systému, ve kterém působí banka plátce nebo příjemce.
{
"title": "ClearingSystemIdentification",
"type": "object",
"properties": {
"code": {
"description": "Kód",
"type": "string"
},
"proprietary": {
"description": "Volný formát",
"type": "string",
"maxLength": 35
}
}
}
Lokální formát kódu banky plátce nebo příjemce - buď ve formě kódu, nebo textového popisu.
{
"title": "ClearingSystemMemberIdentification",
"type": "object",
"properties": {
"clearingSystemIdentification": {
"$ref": "#/definitions/ClearingSystemIdentification"
},
"memberIdentification": {
"description": "Lokální formát kódu banky plátce.",
"type": "string",
"maxLength": 35
}
},
"required": [
"memberIdentification"
]
}
{
"title": "CreatedPayment",
"type": "object",
"properties": {
"instructionStatus": {
"$ref": "#/definitions/InstructionStatus"
},
"scenarios": {
"description": "Kolekce možných autorizačních scénářů",
"type": "array",
"items": {
"type": "string"
}
},
"serviceLevel": {
"$ref": "#/definitions/ServiceLevel"
},
"signInfo": {
"$ref": "#/definitions/SignInfo"
},
"transactionIdentification": {
"description": "Identifikátor založené transakce",
"type": "string",
"maxLength": 35
}
},
"required": [
"scenarios",
"serviceLevel",
"signInfo",
"transactionIdentification"
]
}
Příjemce platby.
{
"title": "Creditor",
"type": "object",
"properties": {
"name": {
"description": "Název příjemce.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"postalAddress": {
"$ref": "#/definitions/PostalAddress"
}
},
"required": [
"name"
]
}
{
"title": "CreditorAccount",
"type": "object",
"properties": {
"currency": {
"description": "měna účtu příjemnce platby",
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"identification": {
"$ref": "#/definitions/CreditorAccountIdentification"
}
},
"required": [
"identification"
]
}
identifikace účtu přijemce platby
{
"title": "CreditorAccountIdentification",
"type": "object",
"properties": {
"iban": {
"description": "IBAN",
"type": "string",
"pattern": "^[A-Z]{2}\\d{2}\\w{1,30}$"
},
"other": {
"$ref": "#/definitions/Other"
}
}
}
Informace o bance příjemce. Řídí se dle směru platby, vyplňuje se v případě protistrany.
{
"title": "CreditorAgent",
"type": "object",
"properties": {
"financialInstitutionIdentification": {
"$ref": "#/definitions/FinancialInstitutionIdentification"
}
}
}
Identifikace plátce nebo příjemce platby.
{
"title": "CreditorDebtorIdentification",
"type": "object",
"properties": {
"organisationIdentification": {
"$ref": "#/definitions/OrganisationIdentification"
},
"privateIdentification": {
"$ref": "#/definitions/OrganisationPrivateIdentification"
}
}
}
identifikace účtu plátce
{
"title": "DebtorAccountIdentification",
"type": "object",
"properties": {
"iban": {
"description": "IBAN",
"type": "string",
"pattern": "^[A-Z]{2}\\d{2}\\w{1,30}$"
}
},
"required": [
"iban"
]
}
Optional element. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element. Contains data for sending in redirecting to federated authorization.
{
"title": "FederatedAuthorizationFormData",
"type": "object",
"properties": {
"SAMLRequest": {
"description": "Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element.\nContains data of SAML request.",
"type": "string"
},
"relayState": {
"description": "Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element.\nContains relayState for returnable value.",
"type": "string"
}
}
}
Reference to call federated authorization
{
"title": "FederatedAuthorizationReference",
"type": "object",
"properties": {
"id": {
"description": "Possible id for calling federated authorization",
"type": "string"
},
"url": {
"description": "URL link or package of federated authorization",
"type": "string"
}
},
"required": [
"url"
]
}
{
"title": "FinancialInstitutionIdentification",
"type": "object",
"properties": {
"bic": {
"type": "string"
},
"clearingSystemMemberIdentification": {
"$ref": "#/definitions/ClearingSystemMemberIdentification"
},
"name": {
"type": "string",
"maxLength": 140
},
"other": {
"$ref": "#/definitions/FinancialInstitutionIdentificationOther"
},
"postalAddress": {
"$ref": "#/definitions/PostalAddress"
}
}
}
Jiná identifikace banky plátce nebo příjemce.
{
"title": "FinancialInstitutionIdentificationOther",
"type": "object",
"properties": {
"identification": {
"description": "Jiná identifikace banky plátce nebo příjemce, zejména formou tzv. local bank code.",
"type": "string",
"maxLength": 35
}
}
}
Status of entered payment ACTC: [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful RJCT: [Rejected] - Payment initiation or individual transaction included in the payment initiation has been rejected ACSP: [AcceptedSettlementInProcess] - All preceding checks such as technical validation and customer pro⪗le were successful and therefore the payment initiation has been accepted for execution ACSC: [AcceptedSettlementCompleted] - Settlement on the debotor´s account has been completed. Usage: this can be used by the ⪗rst agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for ⪗nancial information. It can only be used after bilateral agreement ACWC: [AcceptedWithChange] - Instruction is accepted but a change will be made, such as date or remittance not change ACPA: [AcceptedPendingAdditionalApproval] Waiting for additional approval
{
"title": "InstructionStatus",
"example": "ACTC",
"type": "string",
"enum": [
"ACTC",
"RJCT",
"ACSP",
"ACSC",
"ACWC",
"ACPA"
]
}
Obchodník provádějící transakci
{
"title": "Merchant",
"type": "object",
"properties": {
"address": {
"description": "Adresa obchodníka",
"type": "string",
"maxLength": 140
},
"commonName": {
"description": "Jméno obchodníka tak, jak je uvedeno na potvrzení o platbě",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"countryCode": {
"description": "Země obchodníka",
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"identification": {
"description": "Identifikace obchodníka",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"merchantCategoryCode": {
"description": "Kód obchodníka v návaznosti na typ obchodu",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"shortName": {
"description": "Název obchodníka",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"type": {
"$ref": "#/definitions/MerchantType"
}
},
"required": [
"commonName",
"identification",
"merchantCategoryCode",
"shortName"
]
}
Typ obchodníka
{
"title": "MerchantType",
"example": "OPOI",
"type": "string",
"enum": [
"OPOI",
"MERC",
"ACCP",
"ITAG",
"ACQR",
"CISS",
"DLIS"
]
}
Peněžní částka
{
"title": "MonetaryAmount",
"type": "object",
"properties": {
"currency": {
"description": "Měna",
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"value": {
"description": "Částka",
"type": "number",
"minimum": 1.0e-7,
"format": "double"
}
},
"required": [
"currency",
"value"
]
}
Jednoznačná identifikace plátce nebo příjemce jako organizace/právnické osoby.
{
"title": "OrganisationIdentification",
"type": "object",
"properties": {
"bicOrBei": {
"description": "Identifikace plátce nebo příjemce jako organizace/právnické osoby ve formě BIC nebo BEI kódu.",
"type": "string"
},
"other": {
"$ref": "#/definitions/OrganisationPrivateOtherIdentification"
}
}
}
Jednoznačná identifikace plátce nebo příjemce.
{
"title": "OrganisationPrivateIdentification",
"type": "object",
"properties": {
"other": {
"$ref": "#/definitions/OrganisationPrivateOtherIdentification"
}
}
}
Jiná identifikace plátce nebo příjemce.
{
"title": "OrganisationPrivateOtherIdentification",
"type": "object",
"properties": {
"identification": {
"description": "Jiná identifikace plátce nebo příjemce v nestrukturované podobě.",
"type": "string",
"maxLength": 35
},
"issuer": {
"description": "Vydavatel kódu pro identifikaci plátce nebo příjemce.",
"type": "string",
"maxLength": 35
},
"schemaName": {
"$ref": "#/definitions/SchemaName"
}
},
"required": [
"identification"
]
}
Platba.
{
"title": "Payment",
"type": "object",
"properties": {
"amount": {
"$ref": "#/definitions/PaymentAmount"
},
"chargeBearer": {
"$ref": "#/definitions/ChargeBearer"
},
"creditor": {
"$ref": "#/definitions/Creditor"
},
"creditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"creditorAgent": {
"$ref": "#/definitions/CreditorAgent"
},
"debtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"paymentIdentification": {
"$ref": "#/definitions/PaymentIdentification"
},
"paymentTypeInformation": {
"$ref": "#/definitions/PaymentTypeInformation"
},
"remittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"ultimateCreditor": {
"$ref": "#/definitions/UltimateCreditorDebtor"
},
"ultimateDebtor": {
"$ref": "#/definitions/UltimateCreditorDebtor"
}
},
"required": [
"amount",
"creditorAccount",
"paymentIdentification"
]
}
Payment amount
{
"title": "PaymentAmount",
"type": "object",
"properties": {
"instructedAmount": {
"$ref": "#/definitions/MonetaryAmount"
}
},
"required": [
"instructedAmount"
]
}
Authorization detail
{
"title": "PaymentAuthorizationDetail",
"type": "object",
"properties": {
"scenarios": {
"description": "A set of possible authorization scenarios",
"type": "array",
"items": {
"type": "string"
}
},
"signInfo": {
"$ref": "#/definitions/SignInfo"
}
},
"required": [
"scenarios",
"signInfo"
]
}
{
"title": "PaymentIdentification",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 35
},
"instructionIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 35
}
},
"required": [
"instructionIdentification"
]
}
Status of entered/initialized payment
{
"title": "PaymentStatus",
"type": "object",
"properties": {
"instructionStatus": {
"$ref": "#/definitions/InstructionStatus"
}
},
"required": [
"instructionStatus"
]
}
A set of elements used to further determine the transaction type. It is used to determine the speed and method of payment processing.
{
"title": "PaymentTypeInformationResponse",
"type": "object",
"properties": {
"serviceLevel": {
"$ref": "#/definitions/ServiceLevel1"
}
},
"required": [
"serviceLevel"
]
}
Dotaz na dostatek prostředků
{
"title": "PaymentsBalanceCheckRequest",
"type": "object",
"properties": {
"authenticationMethod": {
"$ref": "#/definitions/AuthenticationMethod"
},
"card": {
"$ref": "#/definitions/Card"
},
"debtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"exchangeIdentification": {
"description": "Jednoznačná identifikace dotazu",
"type": "string",
"minLength": 1,
"maxLength": 18
},
"merchant": {
"$ref": "#/definitions/Merchant"
},
"transactionDetails": {
"$ref": "#/definitions/PaymentsBalanceCheckTransactionDetails"
}
},
"required": [
"debtorAccount",
"exchangeIdentification",
"transactionDetails"
]
}
Odpověď na dotaz na dostatek prostředků
{
"title": "PaymentsBalanceCheckResponse",
"type": "object",
"properties": {
"exchangeIdentification": {
"description": "Zopakovaná identifikace platební transakce (dotazu na dostatek prostředků) ze strany vydavatele karty, ke které se dotaz na dostatek prostředků na účtu váže.",
"type": "string"
},
"response": {
"$ref": "#/definitions/Response"
},
"responseIdentification": {
"description": "Jednoznačná identifikace odpovědi na dotaz na zůstatek (ze strany ASPSP).",
"type": "integer",
"format": "int64"
}
},
"required": [
"exchangeIdentification",
"response",
"responseIdentification"
]
}
detaily transakce
{
"title": "PaymentsBalanceCheckTransactionDetails",
"type": "object",
"properties": {
"currency": {
"description": "Měna dotazu na zůstatek",
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"totalAmount": {
"description": "Částka dotazu na zůstatek",
"type": "number",
"minimum": 1.0e-7,
"format": "double"
}
},
"required": [
"currency",
"totalAmount"
]
}
Poštovní adresa.
{
"title": "PostalAddress",
"type": "object",
"properties": {
"addressLine": {
"description": "Nestrukturovaný záznam poštovní adresy.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
},
"buildingNumber": {
"description": "Číslo popisné použité pro poštovní adresu.",
"type": "string",
"maxLength": 16
},
"country": {
"description": "Název země použitý pro poštovní adresu.",
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"postCode": {
"description": "Poštovní směrovací číslo použité pro poštovní adresu.",
"type": "string",
"maxLength": 16
},
"streetName": {
"description": "Název ulice použitý pro poštovní adresu.",
"type": "string",
"maxLength": 70
},
"townName": {
"description": "Název města použitý pro poštovní adresu.",
"type": "string",
"maxLength": 35
}
}
}
Transaction identificator
{
"title": "RealizedPayment",
"type": "object",
"properties": {
"date": {
"description": "Due date/payment foreign currency in the format ISODate, or ISODateTime, i.e. YYYY-MM-DD, or YYYY-MM-DDThh:mm:ss.sTZD,\ndepending on the transaction type and method how the bank presents data (and time) of due date/ payment foreign currency.\nMainly for card or cash transactions it is posted as ISODateTime.",
"type": "string",
"format": "date"
},
"transactionIdentification": {
"description": "Identifier of estabilished transaction",
"type": "string"
}
},
"required": [
"transactionIdentification"
]
}
Doplňující informace k platbě.
{
"title": "RemittanceInformation",
"type": "object",
"properties": {
"debtorMessage": {
"description": "Zpráva pro plátce.\nPoznámka: Tento atribut není součástí COBS.\n\n**COBS non-compliant API** - this attribute is not a part of COBS.",
"type": "string"
},
"structured": {
"$ref": "#/definitions/Structured"
},
"unstructured": {
"description": "Doplňující informace k platbě vyplněné v platbě jako nestrukturovaná informace. Pokud je v platbě uvedeno více opakování nestrukturovaného záznamu doplňujících informací k platbě, poté se přebírá pouze první výskyt.",
"type": "string",
"maxLength": 140
}
}
}
Zařazení služby (v rámci typu pltaby)
{
"title": "ServiceLevel",
"type": "object",
"properties": {
"code": {
"description": "Typ zadané platby",
"type": "string"
}
},
"required": [
"code"
]
}
Status information and id of unauthorized transactions or information on instruction author.
{
"title": "SignInfo",
"type": "object",
"properties": {
"signId": {
"description": "Identifier of the authorization process of a particular transaction.",
"type": "string"
},
"signInfo": {
"description": "Transaction status identifier.",
"type": "string"
},
"state": {
"description": "Transaction authorization status",
"type": "string"
}
},
"required": [
"state"
]
}
Standing order identification
{
"title": "StandingOrderIdentification",
"type": "object",
"properties": {
"endToEndIdentification": {
"description": "End to end identification (required for SEPA payment type)",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"instructionIdentification": {
"description": "Instruction identification",
"type": "string",
"minLength": 1,
"maxLength": 35
}
},
"required": [
"instructionIdentification"
]
}
Request for new or edit standing order initiation
{
"title": "StandingOrderRequest",
"type": "object",
"properties": {
"amount": {
"$ref": "#/definitions/PaymentAmount"
},
"chargeBearer": {
"$ref": "#/definitions/ChargeBearer"
},
"creditor": {
"$ref": "#/definitions/Creditor"
},
"creditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"creditorAgent": {
"$ref": "#/definitions/CreditorAccount"
},
"debtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"paymentTypeInformation": {
"$ref": "#/definitions/PaymentTypeInformation"
},
"remittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"requestedExecutionDate": {
"description": "Requested date of payment",
"type": "string",
"format": "date"
},
"standingOrder": {
"$ref": "#/definitions/StandingOrder"
},
"standingOrderIdentification": {
"$ref": "#/definitions/StandingOrderIdentification"
},
"ultimateCreditor": {
"$ref": "#/definitions/UltimateCreditorDebtor"
},
"ultimateDebtor": {
"$ref": "#/definitions/UltimateCreditorDebtor"
}
},
"required": [
"amount",
"creditorAccount",
"debtorAccount",
"requestedExecutionDate",
"standingOrder",
"standingOrderIdentification"
]
}
Response for new/edit/delete standing order initiation
{
"title": "StandingOrderResponse",
"type": "object",
"properties": {
"paymentTypeInformation": {
"$ref": "#/definitions/PaymentTypeInformationResponse"
},
"signInfo": {
"$ref": "#/definitions/SignInfo"
},
"standingOrderIdentification": {
"$ref": "#/definitions/StandingOrderTransactionIdentification"
}
},
"required": [
"signInfo",
"standingOrderIdentification"
]
}
Status of entered/initiated standing order
property instructionStatus values:
- ACTC: [AcceptedTechnicalValidation] - Authentication and syntactical and semantical validation are successful
- RJCT: [Rejected] - Payment initiation or individual transaction included in the payment initiation has been rejected
- ACSP: [AcceptedSettlementInProcess] - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution
{
"title": "StandingOrderStatus",
"type": "object",
"properties": {
"instructionStatus": {
"$ref": "#/definitions/InstructionStatus"
},
"realizedPayments": {
"description": "Array of transaction identificators",
"type": "array",
"items": {
"$ref": "#/definitions/RealizedPayment"
}
}
},
"required": [
"instructionStatus"
]
}
Standing order identification
{
"title": "StandingOrderTransactionIdentification",
"type": "object",
"properties": {
"transactionIdentification": {
"description": "Identifier of estabilished standing order instruction",
"type": "string",
"minLength": 1,
"maxLength": 35
}
},
"required": [
"transactionIdentification"
]
}
{
"title": "StandingOrdersDetail",
"type": "object",
"properties": {
"amount": {
"$ref": "#/definitions/Amount2"
},
"standingOrderIdentification": {
"$ref": "#/definitions/StandingOrderIdentification3"
},
"chargeBearer": {
"$ref": "#/definitions/ChargeBearer"
},
"creditor": {
"$ref": "#/definitions/Creditor3"
},
"creditorAccount": {
"$ref": "#/definitions/CreditorAccount3"
},
"creditorAgent": {
"$ref": "#/definitions/CreditorAgent3"
},
"debtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"paymentTypeInformation": {
"$ref": "#/definitions/PaymentTypeInformation"
},
"requestedExcutionDate": {
"description": "Requested date of payment.",
"type": "string",
"format": "date"
},
"standingOrder": {
"$ref": "#/definitions/StandingOrder"
},
"ultimateCreditor": {
"$ref": "#/definitions/UltimateCreditor2"
},
"ultimateDebtor": {
"$ref": "#/definitions/UltimateDebtor2"
},
"remittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"signInfo": {
"$ref": "#/definitions/SignInfo"
}
},
"required": [
"amount",
"standingOrderIdentification",
"creditorAccount",
"debtorAccount",
"standingOrder"
]
}
{
"title": "Step2Response",
"type": "object",
"properties": {
"authorizationType": {
"description": "Code of required authorization (from authorization scenarios)",
"type": "string"
},
"formData": {
"$ref": "#/definitions/FederatedAuthorizationFormData"
},
"href": {
"$ref": "#/definitions/FederatedAuthorizationReference"
},
"method": {
"description": "Method to use href link and federated authorization.",
"type": "string"
},
"signInfo": {
"$ref": "#/definitions/SignInfo"
}
},
"required": [
"authorizationType",
"signInfo"
]
}
{
"title": "Step3Response",
"type": "object",
"properties": {
"state": {
"description": "Status of transaction authorization in a format supported by the bank",
"type": "string"
}
},
"required": [
"state"
]
}
{
"title": "UltimateCreditorDebtor",
"type": "object",
"properties": {
"identification": {
"$ref": "#/definitions/CreditorDebtorIdentification"
},
"name": {
"type": "string",
"maxLength": 140
},
"postalAddress": {
"$ref": "#/definitions/PostalAddress"
}
}
}
Payment amount
{
"title": "Amount2",
"type": "object",
"properties": {
"instructedAmount": {
"$ref": "#/definitions/InstructedAmount3"
}
}
}
Break periods.
{
"title": "Breaks",
"type": "object",
"properties": {
"validFromDate": {
"description": "Start date of one break period. Standing order will not be processed from this date.",
"type": "string",
"format": "date"
},
"validToDate": {
"description": "End date of one break period. Standing order will not be processed to this date.",
"type": "string",
"format": "date"
}
},
"required": [
"validFromDate",
"validToDate"
]
}
Provides the party (parties) that will pay fees associated with the payment transaction processing.
TUZEM (Domestic payments): The code of the fee payer cannot be chosen (the payer always pays the fees of the payer's bank and the payee pays the fees of the payee's bank). When processing domestic payments within CNB clearing, the fee payer's code is not stated.
SEPA (SEPA payments): The code of the fee payer cannot be chosen (the payer always pays the fees of the payer's bank and the payee pays the fees of the payee's bank). In SEPA payment processing, the payer's bank will always complete the SLEV value.
EHP (Foreign payments within EEA): Permitted values are DEBT = OUR or SHAR = SHA. If no value is filled in, the payer's bank will fill in the SHAR value.
NONEHP (Foreign payments outside EEA): Permitted values are DEBT = OUR or CRED = BEN or SHAR = SHA. If no value is filled in, the payer's bank will fill in the SHAR value.
{
"title": "ChargeBearer",
"example": "DEBT",
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
]
}
Identification of the payer's or payee's bank in the local payment system in which the payer's or payee's bank operates.
{
"title": "ClearingSystemIdentification5",
"type": "object",
"properties": {
"code": {
"description": "Bank identification in the local payment system.",
"type": "string"
},
"proprietary": {
"description": "Free format.",
"type": "string",
"maxLength": 35
}
}
}
Local format of the payer's or payee's bank code - either in code form or text description.
{
"title": "ClearingSystemMemberIdentification4",
"type": "object",
"properties": {
"clearingSystemIdentification": {
"$ref": "#/definitions/ClearingSystemIdentification5"
},
"memberIdentification": {
"description": "Local format of the payer's bank code..",
"type": "string",
"maxLength": 35
}
},
"required": [
"memberIdentification"
]
}
Type of entered payment.
- DMCT - [DoMestic Credit Transfer] Domestic payment
- ESCT - [SEPA Credit Transfer] – SEPA payment
- XBCT - [Cross-Border Credit Transfer] – Cross border payment
- EXCT - [EEA X-border Credit Transfers] – Cross border payment within the EEP
- NXCT - [Non-EEA X-border Credit Transfers] – Cross border payment outside the EEP
{
"title": "Code",
"example": "DMCT",
"type": "string",
"enum": [
"DMCT",
"ESCT",
"XBCT",
"EXCT",
"NXCT"
]
}
Payee Recipient.
{
"title": "Creditor3",
"type": "object",
"properties": {
"name": {
"description": "Recipient name.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"postalAddress": {
"$ref": "#/definitions/PostalAddress11"
}
},
"required": [
"name"
]
}
{
"title": "CreditorAccount3",
"type": "object",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.",
"example": "CZK",
"type": "string",
"pattern": "[A-Z]{3}"
},
"identification": {
"$ref": "#/definitions/Identification11"
}
},
"required": [
"identification"
]
}
Recipient's bank information. It follows the direction of payment, is filled in counterparty.
{
"title": "CreditorAgent3",
"type": "object",
"properties": {
"financialInstitutionIdentification": {
"$ref": "#/definitions/FinancialInstitutionIdentification3"
}
}
}
Pro zobrazení informací o variabilním, specifickém a konstantním symbolu.
{
"title": "CreditorReferenceInformation",
"type": "object",
"properties": {
"reference": {
"description": "Pole začínat kódem VS: (pro variabilní symbol), nebo SS: (pro specifický symbol) anebo KS: (pro konstantní symbol). v jednom opakování pole reference mohou být uvedeny všechny tři symboly, vždy maximálně jedno opakování každého jednotlivého symbolu. Způsob záznamu symbolů je VS:|KS:|SS:)[0-9]{1,10}.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[KSV]S:\\d{1,10}$"
}
}
}
}
Information on the account payer. It is according to the payment direction, and filled in in the case of counterparty.
{
"title": "DebtorAccount",
"type": "object",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.",
"example": "CZK",
"type": "string",
"pattern": "[A-Z]{3}"
},
"identification": {
"$ref": "#/definitions/Identification2"
},
"name": {
"description": "Payer account name.",
"type": "string"
}
},
"required": [
"identification"
]
}
Chybový stav
{
"title": "Error",
"type": "object",
"properties": {
"parameters": {
"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"
]
}
Elements defining exceptions to executing a standing order.
{
"title": "Exceptions",
"type": "object",
"properties": {
"breaks": {
"$ref": "#/definitions/Breaks"
},
"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",
"type": "array",
"items": {
"type": "string",
"maxLength": 20
}
}
}
}
Features of execution a standing order for payment.
{
"title": "Execution",
"type": "object",
"properties": {
"interval": {
"$ref": "#/definitions/Interval"
},
"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.",
"example": 15,
"type": "number",
"format": "double"
},
"mode": {
"$ref": "#/definitions/Mode"
},
"modeDue": {
"$ref": "#/definitions/ModeDue"
}
},
"required": [
"interval",
"intervalDue",
"mode",
"modeDue"
]
}
{
"title": "FinancialInstitutionIdentification3",
"type": "object",
"properties": {
"bic": {
"type": "string"
},
"clearingSystemMemberIdentification": {
"$ref": "#/definitions/ClearingSystemMemberIdentification4"
},
"name": {
"type": "string",
"maxLength": 140
},
"other": {
"$ref": "#/definitions/Other22"
},
"postalAddress": {
"$ref": "#/definitions/PostalAddress11"
}
}
}
Payer account identification.
{
"title": "Identification2",
"type": "object",
"properties": {
"iban": {
"description": "International Bank Account Number (IBAN)",
"example": "CZ0708000000001019382023",
"type": "string",
"maxLength": 34,
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
}
},
"required": [
"iban"
]
}
Payment recipient account identification.
{
"title": "Identification11",
"type": "object",
"properties": {
"iban": {
"description": "International Bank Account Number (IBAN)",
"example": "CZ0708000000001019382023",
"type": "string",
"maxLength": 34,
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"other": {
"$ref": "#/definitions/Other"
}
}
}
Identification of payer or payee.
{
"title": "Identification13",
"type": "object",
"properties": {
"organisationIdentification": {
"$ref": "#/definitions/OrganisationIdentification6"
},
"privateIdentification": {
"$ref": "#/definitions/PrivateIdentification6"
}
}
}
Amount and currency in the instruction
{
"title": "InstructedAmount3",
"type": "object",
"properties": {
"currency": {
"description": "Defined account currency.\n\nCurrency code according to ISO 4217 = 3 capital letters.",
"example": "CZK",
"type": "string",
"pattern": "[A-Z]{3}"
},
"value": {
"description": "Amount value",
"example": 10000,
"type": "number",
"format": "double"
}
},
"required": [
"currency",
"value"
]
}
{
"title": "InstructionPriority",
"example": "NORM",
"type": "string",
"enum": [
"NORM",
"HIGH",
"INST"
]
}
Execution interval defines how often order is executed.
{
"title": "Interval",
"example": "DAILY",
"type": "string",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"BI_MONTHLY",
"QUARTERLY",
"HALFYEARLY",
"YEARLY",
"IRREGULAR"
]
}
Payment amount
{
"title": "MaxAmount",
"type": "object",
"properties": {
"instructedAmount": {
"$ref": "#/definitions/InstructedAmount3"
}
}
}
The execution mode defines when or how standing order will be cancelled, processed the last time. Possible values: UNTIL_DATE (standing order is valid until specific date - field lastExecutionDate), UNTIL_CANCELLATION (standing order is valid forever and must be cancelled by client), AFTER_MAX_ITERATION_EXCEEDED (certain count of executions is specified - field maxIterations) or MAX_AMOUNT_EXCEEDED (maximum amount which can be transferred for this order is specified, if next iteration would exceed this amount it is not executed - field maxAmount).
{
"title": "Mode",
"example": "UNTIL_DATE",
"type": "string",
"enum": [
"UNTIL_DATE",
"UNTIL_CANCELLATION",
"FTER_MAX_ITERATION_EXCEEDED",
"MAX_AMOUNT_EXCEEDED"
]
}
The execution due mode defines how the date when order should be executed is specified. Possible values: DUE_DAY_OF_MONTH (specific number of day in the month is defined) or DUE_OR_BEFORE_DAY_OF_MONTH (is defined as a specific day of the month or the previous day if the day falls on a non-banking day) or DUE_OR_NEXT_DAY_OF_MONTH (is defined as a specific day of the month or the next day if the day falls on a non-banking day) or DUE_LAST_DAY_OF_MONTH (order is executed on last day of particular month).
{
"title": "ModeDue",
"example": "DUE_DAY_OF_MONTH",
"type": "string",
"enum": [
"DUE_DAY_OF_MONTH",
"DUE_OR_BEFORE_DAY_OF_MONTH",
"DUE_OR_NEXT_DAY_OF_MONTH",
"DUE_LAST_DAY_OF_MONTH"
]
}
Unique identification of the payer or payee as an organization/legal entity persons.
{
"title": "OrganisationIdentification6",
"type": "object",
"properties": {
"bicOrBei": {
"description": "Unique identification of the payer or payee as an organization/legal entity persons.\nIn BIC or BEI code form.",
"type": "string"
},
"other": {
"$ref": "#/definitions/Other23"
}
}
}
{
"title": "Other",
"type": "object",
"properties": {
"identification": {
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
Jiná identifikace plátce nebo příjemce.
{
"title": "Other3",
"type": "object",
"properties": {
"identification": {
"description": "Jiná identifikace plátce nebo příjemce v nestrukturované podobě.",
"type": "string",
"maxLength": 35
},
"issuer": {
"description": "Vydavatel kódu pro identifikaci plátce nebo příjemce.",
"type": "string",
"maxLength": 35
},
"schemaName": {
"$ref": "#/definitions/SchemaName"
}
},
"required": [
"identification"
]
}
Other identification of the payer's or payee's bank.
{
"title": "Other22",
"type": "object",
"properties": {
"identification": {
"description": "Other identification of the payer's or payee's bank, especially in the form of local bank code.",
"type": "string",
"maxLength": 35
}
}
}
Other identification of payer or payee.
{
"title": "Other23",
"type": "object",
"properties": {
"identification": {
"description": "Other identification of payer or payee in unstructured form.",
"type": "string",
"maxLength": 35
},
"issuer": {
"description": "Code publisher to identify payer or payee.",
"type": "string",
"maxLength": 35
},
"schemaName": {
"$ref": "#/definitions/SchemaName14"
}
},
"required": [
"identification"
]
}
Payment type information
{
"title": "PaymentTypeInformation",
"type": "object",
"properties": {
"instructionPriority": {
"$ref": "#/definitions/InstructionPriority"
}
}
}
Postal address.
{
"title": "PostalAddress11",
"type": "object",
"properties": {
"addressLine": {
"description": "Unstructured postal address record.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
},
"buildingNumber": {
"description": "House number used for mailing address.",
"type": "string",
"maxLength": 16
},
"country": {
"description": "The name of the country used for the postal address.",
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"postCode": {
"description": "Zip code used for mailing address.",
"type": "string",
"maxLength": 16
},
"streetName": {
"description": "The street name used for the postal