Accounts services
The Accounts API provides you with services to get information about bank clients’ accounts.
To call these services, you need to possess the PSD2 AISP scope.
Get accounts
GET /api/csob/psd2/v1/my/accounts
Get a list of bank accounts that belong to the user who authorized the operation.
Note that the id attribute in the response identifying an account is not fixed: it may change after a given period of time or when it is used in other API calls, e.g. after getting the account balance.
Request security requirements
| Feature | Required |
|---|---|
| Certificate | ✔ |
| API key header | ✔ |
| Access token header | ✔ |
Supported features
| Feature | Supported |
|---|---|
| Paging | ✔ |
| Sorting | ✔ |
| Filtering | ✘ |
Operation-specific errors
| HTTP status code | Error | Description |
|---|---|---|
| 403 | AG01 | Consent to check account balance not granted |
Please refer to the Overview section for the error response data structure and a list of errors common to all operations.
Sample request
HTTP
GET /api/csob/psd2/v1/my/accounts HTTP/1.1
Host: api.csob.cz
APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b
Content-Type: application/json
Authorization: Bearer 3/FPLYXU5t3muiv1DiOYWRiAZj9DXM3hYbwh2u4miKG7gg1aUPpWsVP5Nkrv9W8Zdn
Cache-Control: no-cache
cURL
curl -X GET \
https://api.csob.cz/api/csob/psd2/v1/my/accounts \
-H 'APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b' \
-H 'Authorization: Bearer 3/FPLYXU5t3muiv1DiOYWRiAZj9DXM3hYbwh2u4miKG7gg1aUPpWsVP5Nkrv9W8Zdn' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
Response schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"pageNumber": {
"description": "Current page number",
"type": "integer"
},
"pageCount": {
"description": "Total number of pages",
"type": "integer"
},
"nextPage": {
"description": "Current page number",
"type": "integer"
},
"pageSize": {
"description": "Number of records returned on current page",
"type": "integer"
},
"totalCount": {
"description": "Number of all records returned on all pages",
"type": "integer"
},
"accounts": {
"description": "Collection of customer's bank accounts",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "API account identifier",
"type": "string"
},
"identification": {
"description": "Unique account identification between the account owner and the party serving the account.",
"type": "object",
"properties": {
"iban": {
"description": "account number in IBAN format",
"type": "string",
"minLength": 1,
"maxLength": 30,
"pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$"
},
"other": {
"description": "account number in other format",
"type": "string",
"maxLength": 35
}
},
"required": [
"iban"
]
},
"currency": {
"description": "Identification of the currency in which the payer's account is kept",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
},
"servicer": {
"description": "",
"type": "object",
"properties": {
"bankCode": {
"description": "Bank code",
"type": "string"
},
"countryCode": {
"description": "Bank country code. ISO 3166",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"bic": {
"description": "Bank BIC code",
"type": "string",
"maxLength": 35,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
}
}
},
"nameI18N": {
"description": "Account name",
"type": "string"
},
"productI18N": {
"description": "Product name",
"type": "string"
}
},
"required": [
"id",
"identification"
]
}
}
},
"required": [
"pageNumber",
"pageCount",
"pageSize",
"accounts"
]
}
Sample response
HTTP/1.1 200 OK
{
"pageNumber": 1,
"pageCount": 1,
"pageSize": 2,
"totalCount": 2,
"accounts": [
{
"id": "20180410165435228a532fc7dde66413697ecf33d27464f8",
"identification": {
"iban": "CZ1203000000000010385565"
},
"currency": "CZK",
"servicer": {
"country": "CZ",
"bic": "CEKOCZPP"
}
},
{
"id": "20180410104748700bf2c1840fc874fddb15997a7be05a53",
"identification": {
"iban": "CZ1503000000000008968147"
},
"currency": "EUR",
"servicer": {
"country": "CZ",
"bic": "CEKOCZPP"
}
}
]
}
Get account balance
GET /api/csob/psd2/v1/my/accounts/{id}/balance{currency}
Get balance of an account.
Request URI parameters
- id: account identifier returned by the Get accounts call; note that the ID for an account changes over time, so make sure it is fresh and valid before making this call
- currency: optional three-digit currency code conforming to ISO 4217; applicable to multi-currency accounts
Request security requirements
| Feature | Required |
|---|---|
| Certificate | ✔ |
| API key header | ✔ |
| Access token header | ✔ |
Supported features
| Feature | Supported |
|---|---|
| Paging | ✘ |
| Sorting | ✘ |
| Filtering | ✘ |
Operation-specific errors
| HTTP status code | Error | Description |
|---|---|---|
| 400 | FIELD_MISSING | Missing account number |
| 400 | AC01 | Invalid account number |
| 403 | AG01 | Consent to check account balance not granted |
| 404 | NOT_FOUND | Account not found |
Please refer to the Overview section for the error response data structure and a list of errors common to all operations.
Sample request
HTTP
GET /api/csob/psd2/v1/my/accounts/20180410165435228a532fc7dde66413697ecf33d27464f8/balance HTTP/1.1
Host: api.csob.cz
APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b
Content-Type: application/json
Authorization: Bearer 3/TgBurw1ownSm9QUAZXjnZP584CD59OeFt2z0ksJWvNRrFZ2bwiH2rYr54rrlcEVv
Cache-Control: no-cache
cURL
curl -X GET https://api.csob.cz/api/csob/psd2/v1/my/accounts/20180410165435228a532fc7dde66413697ecf33d27464f8/balance \
-H 'APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b' \
-H 'Authorization: Bearer 3/TgBurw1ownSm9QUAZXjnZP584CD59OeFt2z0ksJWvNRrFZ2bwiH2rYr54rrlcEVv' \
-H 'Cache-Control: no-cache'
Response schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"balances": {
"description": "Collection of balances on the client's account",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "Type of balance",
"type": "object",
"properties": {
"codeOrProprietary": {
"type": "object",
"properties": {
"code": {
"description": "Balance type code",
"type": "string",
"maxLength": 4
}
},
"required": [
"code"
]
}
},
"required": [
"codeOrProprietary"
]
},
"creditLine": {
"description": "Amount of allowed debit / overdraft",
"type": "object",
"properties": {
"included": {
"type": "boolean"
},
"amount": {
"description": "Amount of allowed debit",
"type": "object",
"properties": {
"value": {
"description": "Value of allowed debit",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Currency code",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
}
}
}
},
"amount": {
"description": "Amount of the account balance",
"type": "object",
"properties": {
"value": {
"description": "Value of the account balance",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Currency code",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"value",
"currency"
]
},
"creditDebitIndicator": {
"description": "An indicative code of whether the balance of the account for which the statement is generated is positive or negative",
"type": "string",
"maxLength": 4
},
"date": {
"description": "Date(time) of account balance to which the statement is generated",
"type": "object",
"properties": {
"dateTime": {
"description": "Date(time) value. ISO 8601",
"type": "string",
"format": "date-time"
}
},
"required": [
"dateTime"
]
}
},
"required": [
"type",
"amount",
"creditDebitIndicator",
"date"
]
}
}
}
}
Sample response
HTTP/1.1 200 OK
{
"balances": [
{
"type": {
"codeOrProprietary": {
"code": "PRCD"
}
},
"amount": {
"value": 123,
"currency": "CZK"
},
"creditDebitIndicator": "CRDT",
"date": {
"dateTime": "2018-04-10T16:55:27.897+02:00"
}
}
]
}
Get transaction history
GET /api/csob/psd2/v1/my/accounts/{id}/transactions{?fromDate,toDate,currency,size,page,sort,order}
Get transaction history for an account.
Request URI parameters
- id: account identifier returned by the Get accounts call; note that the ID for an account changes over time, so make sure it is fresh and valid before making this call
- fromDate and toDate: optional filter to specify the time frame in the ISO 8601 format
- currency: optional three-digit currency code conforming to ISO 4217; applicable to multi-currency accounts
- size, page, sort, order: optional parameters to specify paging and sorting as explained in the Overview section
Request security requirements
| Feature | Required |
|---|---|
| Certificate | ✔ |
| API key header | ✔ |
| Access token header | ✔ |
Supported features
| Feature | Supported |
|---|---|
| Paging | ✔ |
| Sorting | ✔ |
| Filtering | ✔ |
Operation-specific errors
| HTTP status code | Error | Description |
|---|---|---|
| 400 | FIELD_MISSING | Missing account number |
| 400 | AC01 | Invalid account number |
| 403 | AG01 | Consent to check account balance not granted |
Please refer to the Overview section for the error response data structure and a list of errors common to all operations.
Sample request
HTTP
GET /api/csob/psd2/v1/my/accounts/20180410165435228a532fc7dde66413697ecf33d27464f8/transactions HTTP/1.1
Host: api.csob.cz
APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b
Content-Type: application/json
Authorization: Bearer 3/FPLYXU5t3muiv1DiOYWRiAZj9DXM3hYbwh2u4miKG7gg1aUPpWsVP5Nkrv9W8Zdn
Cache-Control: no-cache
cURL
curl -X GET \
https://api.csob.cz/api/csob/psd2/v1/my/accounts/20180410165435228a532fc7dde66413697ecf33d27464f8/transactions \
-H 'APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b' \
-H 'Authorization: Bearer 3/FPLYXU5t3muiv1DiOYWRiAZj9DXM3hYbwh2u4miKG7gg1aUPpWsVP5Nkrv9W8Zdn' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
Response schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"pageNumber": {
"description": "Current page number",
"type": "integer"
},
"pageCount": {
"description": "Total number of pages",
"type": "integer"
},
"nextPage": {
"description": "Current page number",
"type": "integer"
},
"pageSize": {
"description": "Number of records returned on current page",
"type": "integer"
},
"totalCount": {
"description": "Number of all records returned on all pages",
"type": "integer"
},
"transactions": {
"description": "Collection of customer's transactions",
"type": "array",
"items": {
"type": "object",
"properties": {
"entryReference": {
"description": "Transaction id",
"type": "string",
"maxLength": 35
},
"amount": {
"description": "Transaction amount corresponding to the account currency to which the statement is generated.",
"type": "object",
"properties": {
"value": {
"description": "Amount value.",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Amount currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"value",
"currency"
]
},
"creditDebitIndicator": {
"description": "Indicator of transaction type (Credit or Debit).",
"type": "string",
"enum": [
"DBIT",
"CRDT"
]
},
"reversalIndicator": {
"description": "Indicator of transaction cancellation (true=cancellation).",
"type": "boolean"
},
"status": {
"description": "Transaction status. BOOK-Accounted, PDNG-blocked.",
"type": "string",
"enum": [
"BOOK",
"PDNG"
]
},
"bookingDate": {
"description": "Transaction booking date.",
"type": "object",
"properties": {
"date": {
"description": "Date(time) value. ISO 8601.",
"type": "string",
"format": "date-time"
}
},
"required": [
"date"
]
},
"valueDate": {
"description": "Transaction value date.",
"type": "object",
"properties": {
"date": {
"description": "Date(time) value. ISO 8601.",
"type": "string",
"format": "date-time"
}
},
"required": [
"date"
]
},
"bankTransactionCode": {
"description": "Bank transaction code.",
"type": "object",
"properties": {
"proprietary": {
"type": "object",
"properties": {
"code": {
"description": "Value of bank transaction code.",
"type": "string",
"maxLength": 35
},
"issuer": {
"description": "Identity of publisher of bank transaction code numbers (Czech Banking Association).",
"type": "string",
"maxLength": 35
}
},
"required": [
"code",
"issuer"
]
}
},
"required": [
"proprietary"
]
},
"entryDetails": {
"description": "Entry details.",
"type": "object",
"properties": {
"transactionDetails": {
"description": "Transaction details.",
"type": "object",
"properties": {
"references": {
"description": "A set of references that uniquely identify the transaction.",
"type": "object",
"properties": {
"messageIdentification": {
"description": "Transaction identification or the order of the payment in the payment history statement.",
"type": "string",
"maxLength": 35
},
"accountServicerReference": {
"description": "The bank transaction reference.",
"type": "string",
"maxLength": 35
},
"paymentInformationIdentification": {
"description": "Transaction identification (Specific Symbol).",
"type": "string",
"maxLength": 35
},
"instructionIdentification": {
"description": "Transaction identification (Constant Symbol).",
"type": "string",
"maxLength": 35
},
"endToEndIdentification": {
"description": "End to End transaction identification (Variable Symbol)",
"type": "string",
"maxLength": 35
},
"mandateIdentification": {
"description": "SEPA Direct Debit mandate identification.",
"type": "string",
"maxLength": 35
},
"chequeNumber": {
"description": "Check number or card number.",
"type": "string",
"maxLength": 35
},
"clearingSystemReference": {
"description": "A bank-defined value identifying the type of payment or payment type used. For card transactions, card association identification may be indicated.",
"type": "string",
"maxLength": 35
}
}
},
"amountDetails": {
"description": "Transaction amount detail.",
"type": "object",
"properties": {
"instructedAmount": {
"description": "Amount and currency of transaction in the currency that the client was required to transfer.",
"type": "object",
"properties": {
"amount": {
"description": "Transaction amount corresponding to the account currency to which the statement is generated.",
"type": "object",
"properties": {
"value": {
"description": "Amount value.",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Amount currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"value",
"currency"
]
}
},
"required": [
"amount"
]
},
"transactionAmount": {
"description": "Transaction Amount and Currency for Accumulated transaction and Cashback.",
"type": "object",
"properties": {
"amount": {
"description": "Transaction Amount and Currency for Accumulated transaction and Cashback.",
"type": "object",
"properties": {
"value": {
"description": "Amount value.",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Amount currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"value",
"currency"
]
}
},
"required": [
"amount"
]
},
"counterValueAmount": {
"description": "Amount and currency of transaction in the currency of the client's account after recalculation of the amount that the client was required to transfer.",
"type": "object",
"properties": {
"amount": {
"description": "Amount and currency of transaction in the currency of the client's account after recalculation of the amount that the client was required to transfer.",
"type": "object",
"properties": {
"value": {
"description": "Amount value.",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Amount currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"value",
"currency"
]
},
"currencyExchange": {
"description": "Currency exchange rate used by transaction.",
"type": "object",
"properties": {
"sourceCurrency": {
"description": "Source currency (Client's account currency).",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
},
"targetCurrency": {
"description": "Target currency (Transaction currency).",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
},
"exchangeRate": {
"description": "Exchange rate",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.001
}
},
"required": [
"sourceCurrency",
"exchangeRate"
]
}
},
"required": [
"amount"
]
},
"proprietaryAmount": {
"description": "Amount of cash withdrawal realised by Cashback service.",
"type": "object",
"properties": {
"type": {
"description": "Constant CASHBACK",
"type": "string",
"maxLength": 35
},
"amount": {
"description": "Amount of cash withdrawal realised by Cashback service.",
"type": "object",
"properties": {
"value": {
"description": "Amount value.",
"type": "number",
"minimum": 0,
"maximum": 9999999999999.99,
"multipleOf": 0.01
},
"currency": {
"description": "Amount currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"value",
"currency"
]
}
}
}
}
},
"charges": {
"description": "Information about charge fees.",
"type": "object",
"properties": {
"bearer": {
"description": "Fee code value (OUR,SHA,BEN).",
"type": "string",
"enum": [
"OUR",
"SHA",
"BEN"
]
}
}
},
"relatedParties": {
"description": "Information about debtor, ultimate debtor, creditor, ultimate creditor of a transaction.",
"type": "object",
"properties": {
"debtor": {
"description": "Information related to the debtor (transaction originator). It depends on the payment direction.",
"type": "object",
"properties": {
"name": {
"description": "Debtor name.",
"type": "string",
"maxLength": 140
},
"postalAddress": {
"description": "Debtor postal address.",
"type": "object",
"properties": {
"streetName": {
"description": "Street name.",
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"description": "Building number.",
"type": "string",
"maxLength": 16
},
"postCode": {
"description": "Post code.",
"type": "string",
"maxLength": 16
},
"townName": {
"description": "Town name.",
"type": "string",
"maxLength": 35
},
"country": {
"description": "Country code. ISO 3166.",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"addressLine": {
"description": "Address value in non structured form.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
}
}
},
"identification": {
"description": "Debtor identification.",
"type": "object",
"properties": {
"organisationIdentification": {
"description": "Debtor organization (legal entity) identification.",
"type": "object",
"properties": {
"bicOrBei": {
"description": "BIC or BEI code value.",
"type": "string",
"maxLength": 70,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
},
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
},
"privateIdentification": {
"description": "Debtor personal identification.",
"type": "object",
"properties": {
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
}
},
"oneOf": [
{
"required": [
"organisationIdentification"
]
},
{
"required": [
"privateIdentification"
]
}
]
}
}
},
"debtorAccount": {
"description": "Information related to debtor (transaction originator) account.",
"type": "object",
"properties": {
"identification": {
"description": "Account identification.",
"type": "object",
"properties": {
"iban": {
"description": "Account number in IBAN format.",
"type": "string",
"minLength": 1,
"maxLength": 30,
"pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$"
},
"other": {
"description": "Account number in other (local) format.",
"type": "object",
"properties": {
"identification": {
"description": "Account number value in other format.",
"type": "string",
"maxLength": 34
}
}
}
},
"required": [
"iban"
]
},
"currency": {
"description": "Identification of the account currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
},
"name": {
"description": "Account name.",
"type": "string",
"maxLength": 70
}
},
"required": [
"identification"
]
},
"ultimateDebtor": {
"description": "Information related to ultimate debtor (transaction ultimate originator). It depends on the payment direction.",
"type": "object",
"properties": {
"name": {
"description": "Ultimate debtor (transaction ultimate originator) name.",
"type": "string",
"maxLength": 140
},
"postalAddress": {
"description": "Ultimate debtor (transaction ultimate originator) postal address.",
"type": "object",
"properties": {
"streetName": {
"description": "Street name.",
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"description": "Building number.",
"type": "string",
"maxLength": 16
},
"postCode": {
"description": "Post code.",
"type": "string",
"maxLength": 16
},
"townName": {
"description": "Town name.",
"type": "string",
"maxLength": 35
},
"country": {
"description": "Country code. ISO 3166.",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"addressLine": {
"description": "Address value in non structured form.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
}
}
},
"identification": {
"description": "Ultimate debtor (transaction ultimate originator) identification.",
"type": "object",
"properties": {
"organisationIdentification": {
"description": "Ultimate debtor (transaction ultimate originator) organization (legal entity) identification.",
"type": "object",
"properties": {
"bicOrBei": {
"description": "BIC or BEI code value.",
"type": "string",
"maxLength": 70,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
},
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
},
"privateIdentification": {
"description": "Ultimate debtor (transaction ultimate originator) personal identification.",
"type": "object",
"properties": {
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
}
},
"oneOf": [
{
"required": [
"organisationIdentification"
]
},
{
"required": [
"privateIdentification"
]
}
]
}
}
},
"creditor": {
"description": "Information related to creditor (transaction beneficiary). It depends on the payment direction.",
"type": "object",
"properties": {
"name": {
"description": "Creditor (transaction beneficiary) name.",
"type": "string",
"maxLength": 140
},
"postalAddress": {
"description": "Creditor (transaction beneficiary) postal address.",
"type": "object",
"properties": {
"streetName": {
"description": "Street name.",
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"description": "Building number.",
"type": "string",
"maxLength": 16
},
"postCode": {
"description": "Post code.",
"type": "string",
"maxLength": 16
},
"townName": {
"description": "Town name.",
"type": "string",
"maxLength": 35
},
"country": {
"description": "Country code. ISO 3166.",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"addressLine": {
"description": "Address value in non structured form.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
}
}
},
"identification": {
"description": "Creditor (transaction beneficiary) identification.",
"type": "object",
"properties": {
"organisationIdentification": {
"description": "Creditor (transaction beneficiary) organization (legal entity) identification.",
"type": "object",
"properties": {
"bicOrBei": {
"description": "BIC or BEI code value.",
"type": "string",
"maxLength": 70,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
},
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
},
"privateIdentification": {
"description": "Creditor (transaction beneficiary) personal identification.",
"type": "object",
"properties": {
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
}
},
"oneOf": [
{
"required": [
"organisationIdentification"
]
},
{
"required": [
"privateIdentification"
]
}
]
}
}
},
"creditorAccount": {
"description": "Information related to creditor (transaction beneficiary) account.",
"type": "object",
"properties": {
"identification": {
"description": "Account identification.",
"type": "object",
"properties": {
"iban": {
"description": "Account number in IBAN format.",
"type": "string",
"minLength": 1,
"maxLength": 30,
"pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$"
},
"other": {
"description": "Account number in other (local) format.",
"type": "object",
"properties": {
"identification": {
"description": "Account number value in other format.",
"type": "string",
"maxLength": 34
}
}
}
},
"required": [
"iban"
]
},
"currency": {
"description": "Identification of the account currency.",
"type": "string",
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
},
"name": {
"description": "Account name.",
"type": "string",
"maxLength": 70
}
},
"required": [
"identification"
]
},
"ultimateCretitor": {
"description": "Information related to ultimate creditor (transaction ultimate beneficiary). It depends on the payment direction.",
"type": "object",
"properties": {
"name": {
"description": "Ultimate creditor (transaction ultimate beneficiary) name.",
"type": "string",
"maxLength": 140
},
"postalAddress": {
"description": "Ultimate creditor (transaction ultimate beneficiary) postal address.",
"type": "object",
"properties": {
"streetName": {
"description": "Street name.",
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"description": "Building number.",
"type": "string",
"maxLength": 16
},
"postCode": {
"description": "Post code.",
"type": "string",
"maxLength": 16
},
"townName": {
"description": "Town name.",
"type": "string",
"maxLength": 35
},
"country": {
"description": "Country code. ISO 3166.",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"addressLine": {
"description": "Address value in non structured form.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
}
}
},
"identification": {
"description": "Ultimate creditor (transaction ultimate beneficiary) identification.",
"type": "object",
"properties": {
"organisationIdentification": {
"description": "Ultimate creditor (transaction ultimate beneficiary) organization (legal entity) identification.",
"type": "object",
"properties": {
"bicOrBei": {
"description": "BIC or BEI code value.",
"type": "string",
"maxLength": 70,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
},
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
},
"privateIdentification": {
"description": "Ultimate creditor (transaction ultimate beneficiary) personal identification.",
"type": "object",
"properties": {
"other": {
"description": "Other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
},
"schemeName": {
"description": "Code type of the scheme name.",
"type": "object",
"properties": {
"code": {
"description": "Code type value of the scheme name.",
"type": "string",
"maxLength": 4
},
"proprietary": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"issuer": {
"description": "Issuer of the code type of the scheme name.",
"type": "string",
"maxLength": 35
}
},
"required": [
"identification"
]
}
}
}
},
"oneOf": [
{
"required": [
"organisationIdentification"
]
},
{
"required": [
"privateIdentification"
]
}
]
}
}
},
"proprietary": {
"description": "Marking at which ATM there was a card transaction.",
"type": "object",
"properties": {
"type": {
"description": "To indicate whether a card transaction is a private / foreign ATM.",
"type": "string",
"maxLength": 35
},
"party": {
"description": "ATM owner",
"type": "object",
"properties": {
"name": {
"description": "Name of ATM owner",
"type": "string",
"maxLength": 140
}
}
}
}
}
}
},
"relatedAgents": {
"description": "Information about the debtor's bank and the creditor's (beneficiary) bank making the payment.",
"type": "object",
"properties": {
"debtorAgent": {
"description": "Information related to debtor's bank. It depends on the payment direction.",
"type": "object",
"properties": {
"financialInstitutionIdentification": {
"description": "Bank identification.",
"type": "object",
"properties": {
"bic": {
"description": "Bank BIC code",
"type": "string",
"maxLength": 35,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
},
"clearingSystemMemberIdentification": {
"description": "Bank identification in local clearing system format.",
"type": "object",
"properties": {
"clearingSystemIdentification": {
"description": "Bank identification in local clearing system.",
"type": "object",
"properties": {
"code": {
"description": "Code value of the bank identification in local local clearing system.",
"type": "string",
"maxLength": 5
},
"proprietary": {
"description": "Bank identification in local clearing system in non structured form.",
"type": "string",
"maxLength": 35
}
}
},
"memberIdentification": {
"description": "Bank identification in local format.",
"type": "string",
"maxLength": 35
}
}
},
"name": {
"description": "Bank name.",
"type": "string",
"maxLength": 140
},
"postalAddress": {
"description": "Bank postal address.",
"type": "object",
"properties": {
"streetName": {
"description": "Street name.",
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"description": "Building number.",
"type": "string",
"maxLength": 16
},
"postCode": {
"description": "Post code.",
"type": "string",
"maxLength": 16
},
"townName": {
"description": "Town name.",
"type": "string",
"maxLength": 35
},
"country": {
"description": "Country code. ISO 3166.",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"addressLine": {
"description": "Address value in non structured form.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
}
}
},
"other": {
"description": "Bank other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
}
}
}
}
}
},
"creditorAgent": {
"description": "Information related to creditor's bank. It depends on the payment direction.",
"type": "object",
"properties": {
"financialInstitutionIdentification": {
"description": "Creditor's bank identification.",
"type": "object",
"properties": {
"bic": {
"description": "Bank BIC code",
"type": "string",
"maxLength": 35,
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
},
"clearingSystemMemberIdentification": {
"description": "Bank identification in local clearing system format.",
"type": "object",
"properties": {
"clearingSystemIdentification": {
"description": "Bank identification in local clearing system.",
"type": "object",
"properties": {
"code": {
"description": "Code value of the bank identification in local local clearing system.",
"type": "string",
"maxLength": 5
},
"proprietary": {
"description": "Bank identification in local clearing system in non structured form.",
"type": "string",
"maxLength": 35
}
}
},
"memberIdentification": {
"description": "Bank identification in local format.",
"type": "string",
"maxLength": 35
}
}
},
"name": {
"description": "Bank name.",
"type": "string",
"maxLength": 140
},
"postalAddress": {
"description": "Bank postal address.",
"type": "object",
"properties": {
"streetName": {
"description": "Street name.",
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"description": "Building number.",
"type": "string",
"maxLength": 16
},
"postCode": {
"description": "Post code.",
"type": "string",
"maxLength": 16
},
"townName": {
"description": "Town name.",
"type": "string",
"maxLength": 35
},
"country": {
"description": "Country code. ISO 3166.",
"type": "string",
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"addressLine": {
"description": "Address value in non structured form.",
"type": "array",
"items": {
"type": "string",
"maxLength": 70
}
}
}
},
"other": {
"description": "Bank other identification.",
"type": "object",
"properties": {
"identification": {
"description": "Other identification in non structured form.",
"type": "string",
"maxLength": 35
}
}
}
}
}
}
}
}
},
"purpose": {
"type": "object",
"description": "Purpose of the transaction.",
"properties": {
"code": {
"type": "string",
"maxLength": 4,
"description": "Purpose code."
},
"proprietary": {
"type": "string",
"maxLength": 35,
"description": "Free-form text describing the purpose."
}
},
"oneOf": [
{
"required": [
"code"
]
},
{
"required": [
"proprietary"
]
}
]
},
"remittanceInformation": {
"type": "object",
"properties": {
"structured": {
"type": "object",
"properties": {
"creditorReferenceInformation": {
"type": "object",
"properties": {
"reference": {
"type": "array",
"description": "Reference for only domestic payments allowing to specify VS, KS and SS.",
"items": {
"type": "string",
"maxLength": 35
}
}
}
}
},
"required": [
"creditorReferenceInformation"
]
},
"unstructured": {
"type": "string",
"description": "Information for the creditor.",
"maxLength": 140
}
}
},
"additionalTransactionInformation": {
"type": "string",
"description": "Additional transaction information.",
"maxLength": 500
}
}
}
}
}
},
"required": [
"amount",
"creditDebitIndicator",
"status",
"bookingDate",
"valueDate",
"bankTransactionCode"
]
}
}
},
"required": [
"pageNumber",
"pageCount",
"pageSize",
"transactions"
]
}
Sample response
HTTP/1.1 200 OK
{
"pageNumber": 0,
"pageCount": 2,
"pageSize": 100,
"nextPage": 1,
"transactions": [
{
"entryReference": "RB-4567813",
"amount": {
"value": 10000,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "DBIT",
"bookingDate": {
"date": "2017-01-31T00:00:00.000+01"
},
"valueDate": {
"date": "2017-01-31T00:00:00.000+01"
},
"bankTransactionCode": {
"proprietary": {
"code": "1000010",
"issuer": "CBA"
}
},
"entryDetails": {
"transactionDetails": {
"amountDetails": {
"instructedAmount": {
"amount": {
"value": 10000,
"currency": "CZK"
}
}
},
"relatedParties": {
"debtor": {
"name": "Novák Jan"
},
"debtorAccount": {
"identification": {
"iban": "CZ0827000000002108589434",
"other": {
"identification": "000000-2108589434"
}
}
}
},
"relatedAgents": {
"debtorAgent": {
"financialInstitutionIdentification": {
"bic": "BACXCZPP",
"clearingSystemMemberIdentification": {
"memberIdentification": "2700"
}
}
}
},
"remittanceInformation": {
"unstructured": "``",
"structured": {
"creditorReferenceInformation": {
"reference": [
"VS:123456",
"KS:456789",
"SS:879213546"
]
}
}
},
"additionalTransactionInformation": "Domácí platba - S24/IB,záloha plyn Bohemia Energy"
}
}
},
{
"amount": {
"value": 105.25,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "DBIT",
"bookingDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"valueDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"bankTransactionCode": {
"proprietary": {
"code": "4000050",
"issuer": "CBA"
}
},
"entryDetails": {
"transactionDetails": {
"references": {
"chequeNumber": "xxxxxxxxxxxx1248"
},
"amountDetails": {
"instructedAmount": {
"amount": {
"value": 10,
"currency": "GBP"
}
},
"counterValueAmount": {
"amount": {
"currency": "CZK",
"value": 105.25
},
"currencyExchange": {
"sourceCurrency": "GBP",
"targetCurrency": "CZK",
"exchangeRate": 10.525
}
}
},
"additionalTransactionInformation": "PLATBA KARTOU"
}
}
},
{
"entryReference": "FC-4567513951",
"amount": {
"value": 1844777,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "CRDT",
"bookingDate": {
"date": "2017-01-31T00:00:00.000+01"
},
"valueDate": {
"date": "2017-01-31T00:00:00.000+01"
},
"bankTransactionCode": {
"proprietary": {
"code": "1000020",
"issuer": "CBA"
}
},
"entryDetails": {}
},
{
"entryReference": "CDR-13457893331",
"amount": {
"value": 2,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "DBIT",
"bookingDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"valueDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"bankTransactionCode": {
"proprietary": {
"code": "4000010",
"issuer": "CBA"
}
},
"entryDetails": {
"transactionDetails": {
"amountDetails": {
"instructedAmount": {
"amount": {
"value": 2,
"currency": "CZK"
}
}
},
"additionalTransactionInformation": "POPLATEK ZA ODCHOZÍ TRANSAKCÍ"
}
}
},
{
"amount": {
"value": 122.22,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "CRDT",
"bookingDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"valueDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"bankTransactionCode": {
"proprietary": {
"code": "9000020",
"issuer": "CBA"
}
},
"entryDetails": {
"transactionDetails": {
"amountDetails": {
"instructedAmount": {
"amount": {
"value": 122.22,
"currency": "CZK"
}
}
},
"additionalTransactionInformation": "PŘIPSÁNÍ ÚROKU ZE ZUSTATKU"
}
}
},
{
"entryReference": "FP-4156489123",
"amount": {
"value": 2328262,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "CRDT",
"bookingDate": {
"date": "2017-01-31T00:00:00.000+01"
},
"valueDate": {
"date": "2017-01-31T00:00:00.000+01"
},
"bankTransactionCode": {
"proprietary": {
"code": "1000040",
"issuer": "CBA"
}
},
"entryDetails": {
"transactionDetails": {
"references": {
"endToEndIdentification": "VS0250117002/SS0000000000/KS0000"
},
"amountDetails": {
"instructedAmount": {
"amount": {
"value": 2328262,
"currency": "CZK"
}
},
"counterValueAmount": {
"amount": {
"currency": "EUR",
"value": 86200
},
"currencyExchange": {
"sourceCurrency": "EUR",
"targetCurrency": "CZK",
"exchangeRate": 27.01
}
}
},
"relatedParties": {
"debtor": {
"name": "RENWORTH s.r.o",
"identification": {
"organisationIdentification": {
"other": {
"identification": "48135283",
"schemeName": {
"proprietary": "RENWORTH s.r.o"
}
}
}
}
},
"debtorAccount": {
"identification": {
"iban": "CZ1308001800640033122856"
}
}
},
"relatedAgents": {
"debtorAgent": {
"financialInstitutionIdentification": {
"bic": "GIBACZPXXXX"
}
}
},
"purpose": {
"proprietary": "PLATBA ZA SLUŽBY"
},
"remittanceInformation": {
"structured": {
"creditorReferenceInformation": {
"reference": [
"VS:0250117002"
]
}
}
},
"additionalTransactionInformation": "8201701069595 BIC: GIBACZPXXXX; #71A# SHA ZALOHA DLE SMLOUVY O DODAVKACH,zaloha dle smlouvy o dodavkach c. 45678/2017,VS0250117002/SS0000000000/KS0000SEPA převod"
}
}
},
{
"amount": {
"value": 105,
"currency": "CZK"
},
"status": "BOOK",
"creditDebitIndicator": "CRDT",
"bookingDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"valueDate": {
"date": "2016-09-05T00:00:00+01:00"
},
"bankTransactionCode": {
"proprietary": {
"code": "2000010",
"issuer": "CBA"
}
}
}
]
}