--- swagger: "2.0" info: x-ibm-name: psd2-rbcz-payments-api title: Payments API CZ version: 1.0.4 description: | # 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. contact: [] schemes: - https basePath: /v1/banks/rbcz/pisp consumes: - application/json produces: - application/json securityDefinitions: OAuth2: type: oauth2 description: "" flow: accessCode scopes: PISP: Payment services authorizationUrl: https://api-public.rbi-developer.rb.cz/psd2-rbcz-oauth2-api/oauth2/authorize tokenUrl: https://api-public.rbi-developer.rb.cz/psd2-rbcz-oauth2-api/oauth2/token clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id security: - clientIdHeader: [] OAuth2: - PISP x-ibm-configuration: testable: true enforced: true phase: realized application-authentication: certificate: false paths: /payments/balanceCheck: post: summary: Request for balancheck description: 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. tags: - PISP produces: - application/json parameters: - in: body name: paymentsBalanceCheck required: true schema: $ref: '#/definitions/PaymentsBalanceCheckRequest' - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string responses: 200: description: Successful response schema: $ref: '#/definitions/PaymentsBalanceCheckResponse' 400: description: | - 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) schema: $ref: '#/definitions/ErrorList' 401: description: Missing certificate. (UNAUTHORISED) schema: $ref: '#/definitions/ErrorList' 403: description: | - Call of method which does not responde to license or certificate. (FORBIDDEN) - [TransactionForbidden] – Unexsisting consent with access to information about balance on account. (AG01) schema: $ref: '#/definitions/ErrorList' /payments: post: summary: New payment - payment initiation description: Resource for new payment initiation. tags: - PISP produces: - application/json parameters: - in: body name: payment required: true schema: $ref: '#/definitions/Payment' - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string responses: 200: description: Successful response schema: $ref: '#/definitions/CreatedPayment' 400: description: | - 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) schema: $ref: '#/definitions/ErrorList' 401: description: Missing certificate. (UNAUTHORISED) schema: $ref: '#/definitions/ErrorList' 403: description: | - Call of method which does not responde to license or certificate. (FORBIDDEN) - [TransactionForbidden] – Unexsisting consent with access to information about balance on account. (AG01) schema: $ref: '#/definitions/ErrorList' /payments/{paymentId}/status: get: summary: Status of created/initiated payment description: |- 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. tags: - PISP produces: - application/json parameters: - in: path name: paymentId type: string required: true description: Payment identification - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string responses: 200: description: Successful response schema: $ref: '#/definitions/PaymentStatus' 400: description: | - 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) schema: $ref: '#/definitions/ErrorList' 401: description: Missing certificate. (UNAUTHORISED) schema: $ref: '#/definitions/ErrorList' 403: description: | - Call of method which does not responde to license or certificate. (FORBIDDEN) - [TransactionForbidden] – Unexsisting consent with access to information about balance on account. (AG01) schema: $ref: '#/definitions/ErrorList' /payments/{paymentId}: get: summary: Information about entered/initiated payment description: 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. tags: - PISP produces: - application/json parameters: - in: path name: paymentId type: string required: true description: Payment identification - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string responses: 200: description: Successful response schema: $ref: '#/definitions/Payment' 401: description: Missing/invalid certificate = provider is not authorized (UNAUTHORISED) schema: $ref: '#/definitions/ErrorList' 404: description: Requested method does not match the license or certificate is invalid (TRANSACTION_MISSING) schema: $ref: '#/definitions/ErrorList' 501: description: Requested method not implemented (NOT_IMPLEMENTED) schema: $ref: '#/definitions/ErrorList' /payments/{paymentId}/sign/{signId}: post: summary: Step II. Initiation of payment authorization - specific for every bank description: This resource is used for start of specific authorization method for chosen scenarion. tags: - PISP produces: - application/json parameters: - in: path name: paymentId type: string required: true description: Payment identification - in: path name: signId type: string required: true description: Unambiguous identifier for current authorization of transaction - name: X-tppUrl type: string required: true in: header description: Url to redirect back to TPP - in: body name: authorizationType required: true description: Code of requested authorization (from authorization scenarios) schema: $ref: '#/definitions/AuthorizationTypeWrapper' - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string responses: 200: description: Successful response schema: $ref: '#/definitions/Step2Response' 400: description: This resource cannot be authorized by this method. (AUTH_LIMIT_EXCEEDED) schema: $ref: '#/definitions/ErrorList' 401: description: Invalid/missing access token = user is unauthorized (UNAUTHORISED) schema: $ref: '#/definitions/ErrorList' 403: description: Invalid/missing certificate = provider unauthorized (FORBIDDEN) schema: $ref: '#/definitions/ErrorList' 404: description: Requested ID not exist (ID_NOT_FOUND) schema: $ref: '#/definitions/ErrorList' /standingorders: post: consumes: - application/json produces: - application/json - application/octet-stream parameters: - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string - in: body name: body schema: $ref: '#/definitions/StandingOrderBody' required: true responses: 200: description: | - [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. It is used to determine the speed and method of payment processing. properties: serviceLevel: description: Service placement (within type of payment) properties: code: description: | 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 enum: - DMCT - ESCT - XBCT - EXCT - NXCT type: string required: - code type: object required: - serviceLevel type: object signInfo: description: | Status information and id of unauthorized transactions or information on instruction author. 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 type: object standingOrderIdentification: description: Standing order identification properties: transactionIdentification: description: Identifier of estabilished standing order instruction maxLength: 35 minLength: 1 type: string required: - transactionIdentification type: object required: - standingOrderIdentification - signInfo type: object 400: description: | - 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. 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 401: description: |- - 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. 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 403: description: 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. 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 tags: - PISP summary: New standing order /standingorders/{standingOrderId}: get: description: Resource for get detail about the standing order summary: Detail about the standing order tags: - PISP deprecated: false produces: - application/json parameters: - name: standingOrderId in: path required: true type: string description: Identification for standing order - name: Content-Type in: header required: true type: string maxLength: 50 description: 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. - name: X-Request-ID in: header required: true type: string maxLength: 60 description: Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. - name: Date in: header required: true type: string description: Each request of a transaction contains the date and time at which the message was originated. In timestamp format. - name: User-Involved in: header required: true type: boolean description: The flag identifies if the end user is online and the request was made based on his activity. - name: TPP-Name in: header required: true type: string description: The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. - name: Action-ID in: header required: false type: string maxLength: 60 description: |- 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. - name: User-IP-Address in: header required: true type: string maxLength: 50 description: 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. - name: User-IP-Port in: header required: false type: string maxLength: 40 description: An element used to pass on information about what end-user IP port is using. - name: User-Device-OS in: header required: true type: string maxLength: 100 description: The element is used to forward information about the end user operating system used. - name: User-User-Agent in: header required: true type: string maxLength: 200 description: Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. - name: User-Timestamp in: header required: false type: string description: Local time on User's device. - name: User-Geo-Location in: header required: false type: string maxLength: 100 description: |- 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) - name: User-Device-ID in: header required: false type: string description: It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). - name: TPP-Identification in: header required: false type: string description: The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. responses: 200: description: Standing order detail schema: $ref: '#/definitions/StandingOrdersDetail' headers: X-Request-ID: description: | Unique identifier for each request specified by TPP returned in response header. type: string 401: description: |- - Invalid/missing access token = user is not authorized (UNAUTHORISED) - Invalid/missing certificate = provider is not authorized (UNAUTHORISED) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 404: description: Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 501: description: Method not implemented (NOT_IMPLEMENTED) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' delete: description: Resource to delete an unauthorized standing order. Deletion is not require authorization because is not received by bank. summary: Delete an unauthorized standing order tags: - PISP deprecated: false produces: - application/json parameters: - name: standingOrderId in: path required: true type: string description: Identification for standing order - name: Content-Type in: header required: true type: string maxLength: 50 description: 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. - name: X-Request-ID in: header required: true type: string maxLength: 60 description: Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. - name: Date in: header required: true type: string description: Each request of a transaction contains the date and time at which the message was originated. In timestamp format. - name: User-Involved in: header required: true type: boolean description: The flag identifies if the end user is online and the request was made based on his activity. - name: TPP-Name in: header required: true type: string description: The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. - name: Action-ID in: header required: false type: string maxLength: 60 description: |- 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. - name: User-IP-Address in: header required: true type: string maxLength: 50 description: 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. - name: User-IP-Port in: header required: false type: string maxLength: 40 description: An element used to pass on information about what end-user IP port is using. - name: User-Device-OS in: header required: true type: string maxLength: 100 description: The element is used to forward information about the end user operating system used. - name: User-User-Agent in: header required: true type: string maxLength: 200 description: Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. - name: User-Timestamp in: header required: false type: string description: Local time on User's device. - name: User-Geo-Location in: header required: false type: string maxLength: 100 description: |- 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) - name: User-Device-ID in: header required: false type: string description: It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). - name: TPP-Identification in: header required: false type: string description: The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. responses: 200: description: | - [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: $ref: '#/definitions/StandingOrderResponse' headers: X-Request-ID: description: | Unique identifier for each request specified by TPP returned in response header type: string 401: description: |- - Invalid/missing access token = user is not authorized (UNAUTHORISED) - Invalid/missing certificate = provider is not authorized (UNAUTHORISED) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 403: description: Calling of the method which does not correspond to the licence, or invalid certificate. (FORBIDDEN) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 404: description: Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 501: description: Method not implemented (NOT_IMPLEMENTED) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' put: description: Resource for change of standing order specification. summary: Change of standing order specification tags: - PISP operationId: MyStandingordersByStandingOrderIdPut deprecated: false produces: - application/json parameters: - name: standingOrderId in: path required: true type: string description: Identification for standing order - name: Content-Type in: header required: true type: string maxLength: 50 description: 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. - name: X-Request-ID in: header required: true type: string maxLength: 60 description: Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. - name: Date in: header required: true type: string description: Each request of a transaction contains the date and time at which the message was originated. In timestamp format. - name: User-Involved in: header required: true type: boolean description: The flag identifies if the end user is online and the request was made based on his activity. - name: TPP-Name in: header required: true type: string description: The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. - name: Action-ID in: header required: false type: string maxLength: 60 description: |- 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. - name: User-IP-Address in: header required: true type: string maxLength: 50 description: 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. - name: User-IP-Port in: header required: false type: string maxLength: 40 description: An element used to pass on information about what end-user IP port is using. - name: User-Device-OS in: header required: true type: string maxLength: 100 description: The element is used to forward information about the end user operating system used. - name: User-User-Agent in: header required: true type: string maxLength: 200 description: Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. - name: User-Timestamp in: header required: false type: string description: Local time on User's device. - name: User-Geo-Location in: header required: false type: string maxLength: 100 description: |- 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) - name: User-Device-ID in: header required: false type: string description: It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). - name: TPP-Identification in: header required: false type: string description: The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. - name: body in: body required: false description: "" schema: $ref: '#/definitions/StandingOrderRequest' responses: 200: description: | - [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: $ref: '#/definitions/StandingOrderResponse' headers: X-Request-ID: description: | Unique identifier for each request specified by TPP returned in response header. type: string 400: description: | - 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: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 401: description: |- - Invalid/missing access token = user is not authorized (UNAUTHORISED) - Invalid/missing certificate = provider is not authorized (UNAUTHORISED) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 403: description: Calling of the method which does not correspond to the licence, or invalid certificate. (FORBIDDEN) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' 404: description: Calling of the method which does not correspond to the licence, or invalid certificate. (TRANSACTION_MISSING) schema: $ref: '#/definitions/Thirdstepofstandingorderauthorization.Exception' /standingorders/{standingOrderId}/sign/{signId}: post: consumes: - application/json produces: - application/json - application/octet-stream parameters: - description: Identification for standing order in: path name: standingOrderId required: true type: string - description: Jedinečný identifikátor aktuální autorizace transakce in: path name: signId required: true type: string - description: Url na redirect zpět k TPP in: header name: X-tppUrl required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string - description: Code of required authorization (from authorization scenarios) in: body name: body required: true schema: properties: authorizationType: description: Code of required authorization (from authorization scenarios) type: string required: - authorizationType type: object responses: 200: description: Success answer headers: X-Request-ID: description: | Unique identifier for each request specified by TPP returned in response header. 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. Contains data for sending in redirecting to federated authorization. properties: SAMLRequest: description: | Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element. Contains data of SAML request. type: string relayState: description: | Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element. Contains relayState for returnable value. type: string type: object href: description: Reference to call federated authorization properties: id: description: Possible id for calling federated authorization type: string url: description: URL link or package of federated authorization type: string required: - url type: object method: description: Method to use href link and federated authorization. type: string signInfo: description: | Status information and id of unauthorized transactions or information on instruction author. 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 type: object required: - authorizationType - signInfo type: object 400: description: 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. 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 401: description: |- - 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. 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 403: description: 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. 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 404: description: Requested id not found (ID_NOT_FOUND) headers: X-Request-ID: description: | Unique identifier for each request specified by TPP returned in response header. 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 tags: - PISP summary: Second step of standing order authorization /standingorders/{standingOrderId}/status: get: produces: - application/json - application/octet-stream parameters: - description: Identification for standing order in: path name: standingOrderId required: true type: string - description: | 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. in: header maxLength: 50 name: Content-Type required: true type: string - description: | Unique identifier for each request specified by TPP. It is recommended to use a UUID format with a length of 36 to 60 characters. in: header maxLength: 60 name: X-Request-ID required: true type: string - description: | Each request of a transaction contains the date and time at which the message was originated. In timestamp format. in: header name: Date required: true type: string - description: | 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. in: header maxLength: 60 name: Action-ID required: false type: string - description: | The flag identifies if the end user is online and the request was made based on his activity. in: header name: User-Involved required: true type: boolean - description: | 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. in: header maxLength: 50 name: User-IP-Address required: true type: string - description: | An element used to pass on information about what end-user IP port is using. in: header maxLength: 40 name: User-IP-Port required: false type: string - description: | The element is used to forward information about the end user operating system used. in: header maxLength: 100 name: User-Device-OS required: true type: string - description: | Contains information about the end-user web browser. The format should be the same as the standard HTTP parameter User-Agent. in: header maxLength: 200 name: User-User-Agent required: true type: string - description: | Local time on User's device. in: header name: User-Timestamp required: false type: string - description: | 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) in: header maxLength: 100 name: User-Geo-Location required: false type: string - description: | It contains a unique identifier of end user equipment, if available. For example, a unique mobile device identifier (IMEI). in: header name: User-Device-ID required: false type: string - description: | The name of the original TPP that created the request. Eg. ‘Star corporation, a.s.’. in: header name: TPP-Name required: true type: string - description: | The identification (licence number) of the original TPP that created the request. Eg. ‘CZ013574-15’. in: header name: TPP-Identification required: false type: string responses: 200: description: Success answer headers: X-Request-ID: description: | Unique identifier for each request specified by TPP returned in response header. type: string schema: description: | 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 properties: instructionStatus: description: | 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 enum: - ACTC - RJCT - ACSP - ACSC - ACWC - ACPA type: string realizedPayments: description: Array of transaction identificators items: description: Transaction identificator 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, depending on the transaction type and method how the bank presents data (and time) of due date/ payment foreign currency. Mainly for card or cash transactions it is posted as ISODateTime. format: date type: string transactionIdentification: description: Identifier of estabilished transaction type: string required: - transactionIdentification type: object type: array required: - instructionStatus type: object 400: description: 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. 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 401: description: |- - 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. 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 404: description: 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. 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 tags: - PISP summary: Resource for getting status of the standing order definitions: AuthenticationMethod: title: AuthenticationMethod description: Metoda ověření example: NPIN type: string enum: - NPIN - PPSG - PSWD - SCRT - SCNL - SNCT - CPSG - ADDB - BIOM - CDHI - CRYP - CSCV - PSVE - CSEC - ADDS - TOKP AuthorizationTypeWrapper: title: AuthorizationTypeWrapper type: object properties: authorizationType: description: Code of required authorization (from authorization scenarios) type: string required: - authorizationType Card: title: Card description: Transakční karta 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 ClearingSystemIdentification: title: ClearingSystemIdentification description: 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. type: object properties: code: description: Kód type: string proprietary: description: Volný formát type: string maxLength: 35 ClearingSystemMemberIdentification: title: ClearingSystemMemberIdentification description: Lokální formát kódu banky plátce nebo příjemce - buď ve formě kódu, nebo textového popisu. type: object properties: clearingSystemIdentification: $ref: '#/definitions/ClearingSystemIdentification' memberIdentification: description: Lokální formát kódu banky plátce. type: string maxLength: 35 required: - memberIdentification CreatedPayment: 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 Creditor: title: Creditor description: Příjemce platby. type: object properties: name: description: Název příjemce. type: string minLength: 1 maxLength: 70 postalAddress: $ref: '#/definitions/PostalAddress' required: - name CreditorAccount: 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 CreditorAccountIdentification: title: CreditorAccountIdentification description: identifikace účtu přijemce platby type: object properties: iban: description: IBAN type: string pattern: ^[A-Z]{2}\d{2}\w{1,30}$ other: $ref: '#/definitions/Other' CreditorAgent: title: CreditorAgent description: Informace o bance příjemce. Řídí se dle směru platby, vyplňuje se v případě protistrany. type: object properties: financialInstitutionIdentification: $ref: '#/definitions/FinancialInstitutionIdentification' CreditorDebtorIdentification: title: CreditorDebtorIdentification description: Identifikace plátce nebo příjemce platby. type: object properties: organisationIdentification: $ref: '#/definitions/OrganisationIdentification' privateIdentification: $ref: '#/definitions/OrganisationPrivateIdentification' DebtorAccountIdentification: title: DebtorAccountIdentification description: identifikace účtu plátce type: object properties: iban: description: IBAN type: string pattern: ^[A-Z]{2}\d{2}\w{1,30}$ required: - iban FederatedAuthorizationFormData: title: FederatedAuthorizationFormData description: |- Optional element. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element. Contains data for sending in redirecting to federated authorization. type: object properties: SAMLRequest: description: |- Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element. Contains data of SAML request. type: string relayState: description: |- Optional parameter. For the method POST federated authorization (authorizationType=USERAGENT_REDIRECT) element. Contains relayState for returnable value. type: string FederatedAuthorizationReference: title: FederatedAuthorizationReference description: Reference to call federated authorization 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 FinancialInstitutionIdentification: 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' FinancialInstitutionIdentificationOther: title: FinancialInstitutionIdentificationOther description: Jiná identifikace banky plátce nebo příjemce. type: object properties: identification: description: Jiná identifikace banky plátce nebo příjemce, zejména formou tzv. local bank code. type: string maxLength: 35 InstructionStatus: title: InstructionStatus description: |- 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 example: ACTC type: string enum: - ACTC - RJCT - ACSP - ACSC - ACWC - ACPA Merchant: title: Merchant description: Obchodník provádějící transakci 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 MerchantType: title: MerchantType description: Typ obchodníka example: OPOI type: string enum: - OPOI - MERC - ACCP - ITAG - ACQR - CISS - DLIS MonetaryAmount: title: MonetaryAmount description: Peněžní částka type: object properties: currency: description: Měna type: string pattern: ^[A-Z]{3}$ value: description: Částka type: number minimum: 0.000000 format: double required: - currency - value OrganisationIdentification: title: OrganisationIdentification description: Jednoznačná identifikace plátce nebo příjemce jako organizace/právnické osoby. 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' OrganisationPrivateIdentification: title: OrganisationPrivateIdentification description: Jednoznačná identifikace plátce nebo příjemce. type: object properties: other: $ref: '#/definitions/OrganisationPrivateOtherIdentification' OrganisationPrivateOtherIdentification: title: OrganisationPrivateOtherIdentification description: Jiná identifikace plátce nebo příjemce. 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 Payment: title: Payment description: Platba. 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 PaymentAmount: title: PaymentAmount description: Payment amount type: object properties: instructedAmount: $ref: '#/definitions/MonetaryAmount' required: - instructedAmount PaymentAuthorizationDetail: title: PaymentAuthorizationDetail description: Authorization detail type: object properties: scenarios: description: A set of possible authorization scenarios type: array items: type: string signInfo: $ref: '#/definitions/SignInfo' required: - scenarios - signInfo PaymentIdentification: title: PaymentIdentification type: object properties: endToEndIdentification: type: string minLength: 1 maxLength: 35 instructionIdentification: type: string minLength: 1 maxLength: 35 required: - instructionIdentification PaymentStatus: title: PaymentStatus description: Status of entered/initialized payment type: object properties: instructionStatus: $ref: '#/definitions/InstructionStatus' required: - instructionStatus PaymentTypeInformationResponse: title: PaymentTypeInformationResponse description: |- A set of elements used to further determine the transaction type. It is used to determine the speed and method of payment processing. type: object properties: serviceLevel: $ref: '#/definitions/ServiceLevel1' required: - serviceLevel PaymentsBalanceCheckRequest: title: PaymentsBalanceCheckRequest description: Dotaz na dostatek prostředků 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 PaymentsBalanceCheckResponse: title: PaymentsBalanceCheckResponse description: Odpověď na dotaz na dostatek prostředků 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 PaymentsBalanceCheckTransactionDetails: title: PaymentsBalanceCheckTransactionDetails description: detaily transakce 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: 0.000000 format: double required: - currency - totalAmount PostalAddress: title: PostalAddress description: Poštovní adresa. 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 RealizedPayment: title: RealizedPayment description: Transaction identificator 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, depending on the transaction type and method how the bank presents data (and time) of due date/ payment foreign currency. Mainly for card or cash transactions it is posted as ISODateTime. type: string format: date transactionIdentification: description: Identifier of estabilished transaction type: string required: - transactionIdentification RemittanceInformation: title: RemittanceInformation description: Doplňující informace k platbě. type: object properties: debtorMessage: description: |- Zpráva pro plátce. Poznámka: Tento atribut není součástí COBS. **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 ServiceLevel: title: ServiceLevel description: Zařazení služby (v rámci typu pltaby) type: object properties: code: description: Typ zadané platby type: string required: - code SignInfo: title: SignInfo description: Status information and id of unauthorized transactions or information on instruction author. 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 StandingOrderIdentification: title: StandingOrderIdentification description: Standing order identification 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 StandingOrderRequest: title: StandingOrderRequest description: Request for new or edit standing order initiation 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 StandingOrderResponse: title: StandingOrderResponse description: Response for new/edit/delete standing order initiation type: object properties: paymentTypeInformation: $ref: '#/definitions/PaymentTypeInformationResponse' signInfo: $ref: '#/definitions/SignInfo' standingOrderIdentification: $ref: '#/definitions/StandingOrderTransactionIdentification' required: - signInfo - standingOrderIdentification StandingOrderStatus: title: StandingOrderStatus description: |- 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 type: object properties: instructionStatus: $ref: '#/definitions/InstructionStatus' realizedPayments: description: Array of transaction identificators type: array items: $ref: '#/definitions/RealizedPayment' required: - instructionStatus StandingOrderTransactionIdentification: title: StandingOrderTransactionIdentification description: Standing order identification type: object properties: transactionIdentification: description: Identifier of estabilished standing order instruction type: string minLength: 1 maxLength: 35 required: - transactionIdentification StandingOrdersDetail: 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 Step2Response: 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 Step3Response: title: Step3Response type: object properties: state: description: Status of transaction authorization in a format supported by the bank type: string required: - state UltimateCreditorDebtor: title: UltimateCreditorDebtor type: object properties: identification: $ref: '#/definitions/CreditorDebtorIdentification' name: type: string maxLength: 140 postalAddress: $ref: '#/definitions/PostalAddress' Amount2: title: Amount2 description: Payment amount type: object properties: instructedAmount: $ref: '#/definitions/InstructedAmount3' Breaks: title: Breaks description: Break periods. 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 ChargeBearer: title: ChargeBearer description: |- 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. example: DEBT type: string enum: - DEBT - CRED - SHAR - SLEV ClearingSystemIdentification5: title: ClearingSystemIdentification5 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. type: object properties: code: description: Bank identification in the local payment system. type: string proprietary: description: Free format. type: string maxLength: 35 ClearingSystemMemberIdentification4: title: ClearingSystemMemberIdentification4 description: Local format of the payer's or payee's bank code - either in code form or text description. type: object properties: clearingSystemIdentification: $ref: '#/definitions/ClearingSystemIdentification5' memberIdentification: description: Local format of the payer's bank code.. type: string maxLength: 35 required: - memberIdentification Code: title: Code description: |- 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 example: DMCT type: string enum: - DMCT - ESCT - XBCT - EXCT - NXCT Creditor3: title: Creditor3 description: Payee Recipient. type: object properties: name: description: Recipient name. type: string minLength: 1 maxLength: 70 postalAddress: $ref: '#/definitions/PostalAddress11' required: - name CreditorAccount3: title: CreditorAccount3 type: object properties: currency: description: |- Defined account currency. Currency code according to ISO 4217 = 3 capital letters. example: CZK type: string pattern: '[A-Z]{3}' identification: $ref: '#/definitions/Identification11' required: - identification CreditorAgent3: title: CreditorAgent3 description: Recipient's bank information. It follows the direction of payment, is filled in counterparty. type: object properties: financialInstitutionIdentification: $ref: '#/definitions/FinancialInstitutionIdentification3' CreditorReferenceInformation: title: CreditorReferenceInformation description: Pro zobrazení informací o variabilním, specifickém a konstantním symbolu. 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}$ DebtorAccount: title: DebtorAccount description: Information on the account payer. It is according to the payment direction, and filled in in the case of counterparty. type: object properties: currency: description: |- Defined account currency. Currency 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 Error: title: Error description: Chybový stav 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 Exceptions: title: Exceptions description: Elements defining exceptions to executing a standing order. type: object properties: breaks: $ref: '#/definitions/Breaks' stoppages: description: |- List of months where there is no payment (only applicable with interval IRREGULAR). Possible values: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER type: array items: type: string maxLength: 20 Execution: title: Execution description: Features of execution a standing order for payment. 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. Possible 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 FinancialInstitutionIdentification3: 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' Identification2: title: Identification2 description: Payer account identification. 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 Identification11: title: Identification11 description: Payment recipient account identification. 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' Identification13: title: Identification13 description: Identification of payer or payee. type: object properties: organisationIdentification: $ref: '#/definitions/OrganisationIdentification6' privateIdentification: $ref: '#/definitions/PrivateIdentification6' InstructedAmount3: title: InstructedAmount3 description: Amount and currency in the instruction type: object properties: currency: description: |- Defined account currency. Currency 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 InstructionPriority: title: InstructionPriority example: NORM type: string enum: - NORM - HIGH - INST Interval: title: Interval description: Execution interval defines how often order is executed. example: DAILY type: string enum: - DAILY - WEEKLY - MONTHLY - BI_MONTHLY - QUARTERLY - HALFYEARLY - YEARLY - IRREGULAR MaxAmount: title: MaxAmount description: Payment amount type: object properties: instructedAmount: $ref: '#/definitions/InstructedAmount3' Mode: title: Mode description: |- 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). example: UNTIL_DATE type: string enum: - UNTIL_DATE - UNTIL_CANCELLATION - FTER_MAX_ITERATION_EXCEEDED - MAX_AMOUNT_EXCEEDED ModeDue: title: ModeDue description: |- 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). 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 OrganisationIdentification6: title: OrganisationIdentification6 description: Unique identification of the payer or payee as an organization/legal entity persons. type: object properties: bicOrBei: description: |- Unique identification of the payer or payee as an organization/legal entity persons. In BIC or BEI code form. type: string other: $ref: '#/definitions/Other23' Other: title: Other type: object properties: identification: type: string maxLength: 35 required: - identification Other3: title: Other3 description: Jiná identifikace plátce nebo příjemce. 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 Other22: title: Other22 description: Other identification of the payer's or payee's bank. 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 Other23: title: Other23 description: Other identification of payer or payee. 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 PaymentTypeInformation: title: PaymentTypeInformation description: Payment type information type: object properties: instructionPriority: $ref: '#/definitions/InstructionPriority' PostalAddress11: title: PostalAddress11 description: Postal address. 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 address. type: string maxLength: 70 townName: description: The name of the city used for the postal address. type: string maxLength: 35 PrivateIdentification6: title: PrivateIdentification6 description: Unique identification of payer or payee. type: object properties: other: $ref: '#/definitions/Other23' Response: title: Response description: |- Výsledek dotazu na dostatek prostředků. APPR - Dostatek prostředků na účtu DECL - Nedostatek prostředků na účtu example: APPR type: string enum: - APPR - DECL SchemaName: title: SchemaName description: Typ kódu pro identifikaci plátce nebo příjemce. type: object properties: proprietary: description: Typ kódu pro identifikaci plátce nebo příjemce ve volném textovém formátu. type: string maxLength: 35 required: - proprietary SchemaName14: title: SchemaName14 description: Code type to identify the payer or payee. type: object properties: proprietary: description: Code type to identify the payer or payee in free text format. type: string maxLength: 35 required: - proprietary ServiceLevel1: title: ServiceLevel1 description: Service placement (within type of payment) type: object properties: code: $ref: '#/definitions/Code' required: - code StandingOrder: title: StandingOrder description: Structure describint the parameters of the standing orders. type: object properties: alias: description: Description resp. the user-defined standing order payment name. example: Payments for lunch - kindergarten Michal type: string maxLength: 250 exceptions: $ref: '#/definitions/Exceptions' execution: $ref: '#/definitions/Execution' validity: $ref: '#/definitions/Validity' required: - execution StandingOrderIdentification3: title: StandingOrderIdentification3 description: Standing order identification type: object properties: endToEndIdentification: description: |- End to end identification. Required only for: SEPA payments. type: string maxLength: 35 instructionIdentification: description: Payment identification entered by a third party, or a constant symbol may be entered. type: string maxLength: 35 transactionIdentification: description: Transaction identification type: string maxLength: 35 required: - instructionIdentification Structured: title: Structured description: |- Očekává se vyplnění symbolů platby (variabilní, specifický a konstantní). Pokud v platbě nebyl variabilní, specifický nebo konstantní symbol vyplněn, pak zůstane celá struktura Structured Remittance Information prázdná. type: object properties: creditorReferenceInformation: $ref: '#/definitions/CreditorReferenceInformation' Thirdstepofstandingorderauthorization.Exception: title: Thirdstepofstandingorderauthorization.Exception type: object properties: errors: description: Nadřazený element obsahující kolekci všech chybových stavů type: array items: $ref: '#/definitions/Error' required: - errors UltimateCreditor2: title: UltimateCreditor2 type: object properties: identification: $ref: '#/definitions/Identification13' name: type: string maxLength: 140 postalAddress: $ref: '#/definitions/PostalAddress11' UltimateDebtor2: title: UltimateDebtor2 type: object properties: identification: $ref: '#/definitions/Identification13' name: type: string maxLength: 140 postalAddress: $ref: '#/definitions/PostalAddress11' Validity: title: Validity description: Elements restricting the validity of the standing order. type: object properties: lastExecutionDate: description: Elements restricting the validity of the standing order. type: string format: date maxAmount: $ref: '#/definitions/MaxAmount' maxIterations: description: |- Maximum number of iterations - processing of the standing order. Only applicable in combination with executionMode AFTER_MAX_ITERAT ION_EXCEEDED. type: integer format: int32 StandingOrderBody: description: Request for new or edit standing order initiation properties: amount: description: Payment amount properties: instructedAmount: description: Peněžní částka properties: currency: description: Měna pattern: ^[A-Z]{3}$ type: string value: description: Částka minimum: 0.000000 type: number required: - value - currency type: object required: - instructedAmount type: object chargeBearer: description: | 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. enum: - DEBT - CRED - SHAR - SLEV type: string creditor: description: Příjemce platby. properties: name: description: Název příjemce. maxLength: 70 minLength: 1 type: string postalAddress: description: Poštovní adresa. properties: addressLine: description: Nestrukturovaný záznam poštovní adresy. items: maxLength: 70 type: string type: array buildingNumber: description: Číslo popisné použité pro poštovní adresu. maxLength: 16 type: string country: description: Název země použitý pro poštovní adresu. pattern: ^[A-Z]{2}$ type: string postCode: description: Poštovní směrovací číslo použité pro poštovní adresu. maxLength: 16 type: string streetName: description: Název ulice použitý pro poštovní adresu. maxLength: 70 type: string townName: description: Název města použitý pro poštovní adresu. maxLength: 35 type: string type: object required: - name type: object creditorAccount: properties: currency: description: měna účtu příjemnce platby pattern: ^[A-Z]{3}$ type: string identification: description: identifikace účtu přijemce platby properties: iban: description: IBAN pattern: ^[A-Z]{2}\d{2}\w{1,30}$ type: string other: properties: identification: maxLength: 35 type: string required: - identification type: object type: object required: - identification type: object creditorAgent: properties: currency: description: měna účtu příjemnce platby pattern: ^[A-Z]{3}$ type: string identification: description: identifikace účtu přijemce platby properties: iban: description: IBAN pattern: ^[A-Z]{2}\d{2}\w{1,30}$ type: string other: properties: identification: maxLength: 35 type: string required: - identification type: object type: object required: - identification type: object debtorAccount: description: | Information on the account payer. It is according to the payment direction, and filled in in the case of counterparty. properties: currency: description: | Defined account currency. Currency code according to ISO 4217 = 3 capital letters. example: CZK pattern: '[A-Z]{3}' type: string identification: description: | Payer account identification. 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. type: string required: - identification type: object paymentTypeInformation: description: Payment type information properties: instructionPriority: enum: - NORM - HIGH - INST type: string type: object remittanceInformation: description: Doplňující informace k platbě. properties: debtorMessage: description: | Zpráva pro plátce. Poznámka: Tento atribut není součástí COBS. **COBS non-compliant API** - this attribute is not a part of COBS. type: string structured: description: | Očekává se vyplnění symbolů platby (variabilní, specifický a konstantní). Pokud v platbě nebyl variabilní, specifický nebo konstantní symbol vyplněn, pak zůstane celá struktura Structured Remittance Information prázdná. properties: creditorReferenceInformation: description: Pro zobrazení informací o variabilním, specifickém a konstantním symbolu. 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}. items: pattern: ^[KSV]S:\d{1,10}$ type: string type: array type: object type: object 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. maxLength: 140 type: string type: object requestedExecutionDate: description: Requested date of payment format: date type: string standingOrder: description: | Structure describint the parameters of the standing orders. properties: alias: description: | Description resp. the user-defined standing order payment name. example: Payments for lunch - kindergarten Michal maxLength: 250 type: string exceptions: description: | Elements defining exceptions to executing a standing order. properties: breaks: description: | Break periods. properties: validFromDate: description: | Start date of one break period. Standing order will not be processed from this date. format: date type: string validToDate: description: | End date of one break period. Standing order will not be processed to this date. format: date type: string required: - validFromDate - validToDate type: object stoppages: description: | List of months where there is no payment (only applicable with interval IRREGULAR). Possible values: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER 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. Possible 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 mode: description: | 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). 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. 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). 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. properties: lastExecutionDate: description: | Elements restricting the validity of the standing order. format: date type: string maxAmount: allOf: - description: | Payment amount properties: instructedAmount: description: | Amount and currency in the instruction properties: currency: description: | Defined account currency. Currency code according to ISO 4217 = 3 capital letters. 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. Only applicable in combination with executionMode AFTER_MAX_AMOU NT_EXCEEDED. type: object maxIterations: description: | Maximum number of iterations - processing of the standing order. Only applicable in combination with executionMode AFTER_MAX_ITERAT ION_EXCEEDED. type: integer type: object required: - execution type: object standingOrderIdentification: description: Standing order identification properties: endToEndIdentification: description: End to end identification (required for SEPA payment type) maxLength: 35 minLength: 1 type: string instructionIdentification: description: Instruction identification maxLength: 35 minLength: 1 type: string required: - instructionIdentification type: object ultimateCreditor: properties: identification: description: Identifikace plátce nebo příjemce platby. properties: organisationIdentification: allOf: - properties: bicOrBei: description: Identifikace plátce nebo příjemce jako organizace/právnické osoby ve formě BIC nebo BEI kódu. type: string - description: Jednoznačná identifikace plátce nebo příjemce. properties: other: description: Jiná identifikace plátce nebo příjemce. properties: identification: description: Jiná identifikace plátce nebo příjemce v nestrukturované podobě. maxLength: 35 type: string issuer: description: Vydavatel kódu pro identifikaci plátce nebo příjemce. maxLength: 35 type: string schemaName: description: Typ kódu pro identifikaci plátce nebo příjemce. properties: proprietary: description: Typ kódu pro identifikaci plátce nebo příjemce ve volném textovém formátu. maxLength: 35 type: string required: - proprietary type: object required: - identification type: object type: object description: Jednoznačná identifikace plátce nebo příjemce jako organizace/právnické osoby. type: object privateIdentification: allOf: - description: Jednoznačná identifikace plátce nebo příjemce. properties: other: description: Jiná identifikace plátce nebo příjemce. properties: identification: description: Jiná identifikace plátce nebo příjemce v nestrukturované podobě. maxLength: 35 type: string issuer: description: Vydavatel kódu pro identifikaci plátce nebo příjemce. maxLength: 35 type: string schemaName: description: Typ kódu pro identifikaci plátce nebo příjemce. properties: proprietary: description: Typ kódu pro identifikaci plátce nebo příjemce ve volném textovém formátu. maxLength: 35 type: string required: - proprietary type: object required: - identification type: object type: object description: Jednoznačná identifikace plátce nebo příjemce jako fyzické osoby. type: object type: object name: maxLength: 140 type: string postalAddress: description: Poštovní adresa. properties: addressLine: description: Nestrukturovaný záznam poštovní adresy. items: maxLength: 70 type: string type: array buildingNumber: description: Číslo popisné použité pro poštovní adresu. maxLength: 16 type: string country: description: Název země použitý pro poštovní adresu. pattern: ^[A-Z]{2}$ type: string postCode: description: Poštovní směrovací číslo použité pro poštovní adresu. maxLength: 16 type: string streetName: description: Název ulice použitý pro poštovní adresu. maxLength: 70 type: string townName: description: Název města použitý pro poštovní adresu. maxLength: 35 type: string type: object type: object ultimateDebtor: properties: identification: description: Identifikace plátce nebo příjemce platby. properties: organisationIdentification: allOf: - properties: bicOrBei: description: Identifikace plátce nebo příjemce jako organizace/právnické osoby ve formě BIC nebo BEI kódu. type: string - description: Jednoznačná identifikace plátce nebo příjemce. properties: other: description: Jiná identifikace plátce nebo příjemce. properties: identification: description: Jiná identifikace plátce nebo příjemce v nestrukturované podobě. maxLength: 35 type: string issuer: description: Vydavatel kódu pro identifikaci plátce nebo příjemce. maxLength: 35 type: string schemaName: description: Typ kódu pro identifikaci plátce nebo příjemce. properties: proprietary: description: Typ kódu pro identifikaci plátce nebo příjemce ve volném textovém formátu. maxLength: 35 type: string required: - proprietary type: object required: - identification type: object type: object description: Jednoznačná identifikace plátce nebo příjemce jako organizace/právnické osoby. type: object privateIdentification: allOf: - description: Jednoznačná identifikace plátce nebo příjemce. properties: other: description: Jiná identifikace plátce nebo příjemce. properties: identification: description: Jiná identifikace plátce nebo příjemce v nestrukturované podobě. maxLength: 35 type: string issuer: description: Vydavatel kódu pro identifikaci plátce nebo příjemce. maxLength: 35 type: string schemaName: description: Typ kódu pro identifikaci plátce nebo příjemce. properties: proprietary: description: Typ kódu pro identifikaci plátce nebo příjemce ve volném textovém formátu. maxLength: 35 type: string required: - proprietary type: object required: - identification type: object type: object description: Jednoznačná identifikace plátce nebo příjemce jako fyzické osoby. type: object type: object name: maxLength: 140 type: string postalAddress: description: Poštovní adresa. properties: addressLine: description: Nestrukturovaný záznam poštovní adresy. items: maxLength: 70 type: string type: array buildingNumber: description: Číslo popisné použité pro poštovní adresu. maxLength: 16 type: string country: description: Název země použitý pro poštovní adresu. pattern: ^[A-Z]{2}$ type: string postCode: description: Poštovní směrovací číslo použité pro poštovní adresu. maxLength: 16 type: string streetName: description: Název ulice použitý pro poštovní adresu. maxLength: 70 type: string townName: description: Název města použitý pro poštovní adresu. maxLength: 35 type: string type: object type: object required: - standingOrderIdentification - amount - requestedExecutionDate - standingOrder - debtorAccount - creditorAccount type: object ErrorList: type: object required: - errors properties: errors: type: array description: Parent element with collection of all error statuses items: $ref: '#/definitions/Error' allOf: - $ref: '#/definitions/OrganisationPrivateIdentification' tags: - name: paymentServices description: Payments x-ibm-endpoints: - endpointUrl: https://api.rbi-developer.rb.cz type: - production - development ...