643 matches
34 actions
Swiss NextGen Banking API-Framework
34 actions
Finance/Swiss NextGen Banking API-Framework
Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances.
For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported.
{
"type": "object",
"properties": {
"Consent-ID": {
"type": "string",
"description": "ID of the corresponding consent object as returned by an account information consent request.\n"
},
"Digest": {
"type": "string"
},
"PSU-Accept": {
"type": "string"
},
"PSU-Accept-Charset": {
"type": "string"
},
"PSU-Accept-Encoding": {
"type": "string"
},
"PSU-Accept-Language": {
"type": "string"
},
"PSU-Device-ID": {
"type": "string"
},
"PSU-Geo-Location": {
"type": "string"
},
"PSU-Http-Method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"PSU-IP-Address": {
"type": "string",
"format": "ipv4"
},
"PSU-IP-Port": {
"type": "string"
},
"PSU-User-Agent": {
"type": "string"
},
"Signature": {
"type": "string"
},
"TPP-Signature-Certificate": {
"type": "string",
"format": "byte"
},
"X-Request-ID": {
"type": "string"
},
"account-id": {
"type": "string",
"description": "This identification is denoting the addressed account, where the transaction has been performed."
},
"bookingStatus": {
"type": "string",
"enum": [
"information",
"booked",
"pending",
"both"
]
},
"dateFrom": {
"type": "string",
"format": "date"
},
"dateTo": {
"type": "string",
"format": "date"
},
"deltaList": {
"type": "boolean"
},
"entryReferenceFrom": {
"type": "string"
},
"withBalance": {
"type": "boolean"
}
},
"required": [
"Consent-ID",
"X-Request-ID",
"account-id",
"bookingStatus"
],
"additionalProperties": false
}{
"type": "object",
"description": "Body of the JSON response for a successful read transaction list request.\nThis account report contains transactions resulting from the query parameters.\n",
"properties": {
"_links": {
"type": "object",
"description": "A list of hyperlinks to be recognised by the TPP.\n\nType of links admitted in this response:\n - \"download\": a link to a resource, where the transaction report might be downloaded from in\n case where transaction reports have a huge size.\n\nRemark: This feature shall only be used where camt-data is requested which has a huge size.\n",
"required": [
"download"
],
"properties": {
"download": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
}
}
},
"account": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"balances": {
"type": "array",
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list might be restricted to the current balance.\n",
"items": {
"type": "object",
"description": "A single balance element.\n",
"required": [
"balanceAmount",
"balanceType"
],
"properties": {
"balanceAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"balanceType": {
"type": "string",
"description": "The following balance types are defined:\n - \"closingBooked\":\n Balance of the account at the end of the pre-agreed account reporting period.\n It is the sum of the opening booked balance at the beginning of the period and all entries booked\n to the account during the pre-agreed account reporting period.\n\n For card-accounts, this is composed of\n\n - invoiced, but not yet paid entries\n\n - \"expected\":\n Balance composed of booked entries and pending items known at the time of calculation,\n which projects the end of day balance if everything is booked on the account and no other entry is posted.\n \n For card accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries and\n - pending items (not yet booked)\n \n For card-accounts:\n\n \"money to spend with the value of a pre-approved credit limit on the card account\"\n\n - \"openingBooked\":\n Book balance of the account at the beginning of the account reporting period.\n It always equals the closing book balance from the previous report.\n - \"interimAvailable\":\n Available balance calculated in the course of the account ?servicer?s business day,\n at the time specified, and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation\n time/period specified.\n \n For card-accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries\n - \"interimBooked\":\n Balance calculated in the course of the account servicer's business day, at the time specified,\n and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period\n specified.\n - \"forwardAvailable\":\n Forward available balance of money that is at the disposal of the account owner on the date specified.\n - \"nonInvoiced\":\n Only for card accounts, to be checked yet.\n",
"enum": [
"closingBooked",
"expected",
"openingBooked",
"interimAvailable",
"interimBooked",
"forwardAvailable",
"nonInvoiced"
]
},
"creditLimitIncluded": {
"type": "boolean",
"description": "A flag indicating if the credit limit of the corresponding account\nis included in the calculation of the balance, where applicable.\n"
},
"lastChangeDateTime": {
"type": "string",
"format": "date-time",
"description": "This data element might be used to indicate e.g. with the expected or booked balance that no action is known\non the account, which is not yet booked.\n"
},
"lastCommittedTransaction": {
"type": "string",
"description": "\"entryReference\" of the last commited transaction to support the TPP in identifying whether all\nPSU transactions are already known.\n"
},
"referenceDate": {
"type": "string",
"format": "date",
"description": "Indicates the date of the balance."
}
}
}
},
"transactions": {
"type": "object",
"description": "JSON based account report.\nThis account report contains transactions resulting from the query parameters.\n\n'booked' shall be contained if bookingStatus parameter is set to \"booked\" or \"both\".\n\n'pending' is not contained if the bookingStatus parameter is set to \"booked\" or \"information\".\n\n'information' Only contained if the bookingStatus is set to \"information\" and if supported by ASPSP.\n",
"required": [
"_links"
],
"properties": {
"_links": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
},
"first": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
},
"last": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
},
"next": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
},
"previous": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
}
}
},
"booked": {
"type": "array",
"description": "Array of transaction details.",
"items": {
"type": "object",
"description": "Transaction details.",
"required": [
"transactionAmount"
],
"properties": {
"_links": {
"type": "object",
"required": [
"transactionDetails"
],
"properties": {
"transactionDetails": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
}
}
},
"additionalInformation": {
"type": "string",
"description": "Might be used by the ASPSP to transport additional transaction related information to the PSU\n"
},
"additionalInformationStructured": {
"type": "object",
"description": "Is used if and only if the bookingStatus entry equals \"information\". \nEvery active standing order related to the dedicated payment account result into one entry.\n",
"required": [
"standingOrderDetails"
],
"properties": {
"standingOrderDetails": {
"type": "object",
"description": "Details of underlying standing orders.\n",
"required": [
"startDate",
"frequency"
],
"properties": {
"dayOfExecution": {
"type": "string",
"description": "Day of execution as string.\n\nThis string consists of up two characters.\nLeading zeroes are not allowed.\n\n31 is ultimo of the month.\n",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
]
},
"endDate": {
"type": "string",
"format": "date",
"description": "The last applicable day of execution.\nIf not given, it is an infinite standing order.\n"
},
"executionRule": {
"type": "string",
"description": "\"following\" or \"preceding\" supported as values.\nThis data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday.\nThe payment is then executed either the \"preceding\" or \"following\" working day.\nASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting\nthis execution rule.\n",
"enum": [
"following",
"preceding"
]
},
"frequency": {
"type": "string",
"description": "The following codes from the \"EventFrequency7Code\" of ISO 20022 are supported:\n- \"Daily\"\n- \"Weekly\"\n- \"EveryTwoWeeks\"\n- \"Monthly\"\n- \"EveryTwoMonths\"\n- \"Quarterly\"\n- \"SemiAnnual\"\n- \"Annual\"\n- \"MonthlyVariable\"\n",
"enum": [
"Daily",
"Weekly",
"EveryTwoWeeks",
"Monthly",
"EveryTwoMonths",
"Quarterly",
"SemiAnnual",
"Annual",
"MonthlyVariable"
]
},
"limitAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"monthsOfExecution": {
"type": "array",
"description": "The format is following the regular expression \\d{1,2}. \nThe array is restricted to 11 entries. \nThe values contained in the array entries shall all be different and the maximum value of one entry is 12.\nThis attribute is contained if and only if the frequency equals \"MonthlyVariable\".\nExample: An execution on January, April and October each year is addressed by [\"1\", \"4\", \"10\"].\n",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12"
]
}
},
"multiplicator": {
"type": "integer",
"description": "This is multiplying the given frequency resulting the exact frequency,\ne.g. Frequency=weekly and multiplicator=3 means every 3 weeks.\nRemark: This attribute is rarely supported in the market.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The first applicable day of execution starting from this date is the first payment.\n"
},
"withinAMonthFlag": {
"type": "boolean",
"description": "This element is only used in case of frequency equals \"Monthly\".\n\nIf this element equals false it has no effect.\nIf this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule.\n\nExample: executionRule equals \"preceding\", dayOfExecution equals \"02\" and the second of a month is a Sunday. \nIn this case, the transaction date would be on the last day of the month before.\n This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month.\nRemark: This attribute is rarely supported in the market.\n"
}
}
}
}
},
"balanceAfterTransaction": {
"type": "object",
"description": "A single balance element.\n",
"required": [
"balanceAmount",
"balanceType"
],
"properties": {
"balanceAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"balanceType": {
"type": "string",
"description": "The following balance types are defined:\n - \"closingBooked\":\n Balance of the account at the end of the pre-agreed account reporting period.\n It is the sum of the opening booked balance at the beginning of the period and all entries booked\n to the account during the pre-agreed account reporting period.\n\n For card-accounts, this is composed of\n\n - invoiced, but not yet paid entries\n\n - \"expected\":\n Balance composed of booked entries and pending items known at the time of calculation,\n which projects the end of day balance if everything is booked on the account and no other entry is posted.\n \n For card accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries and\n - pending items (not yet booked)\n \n For card-accounts:\n\n \"money to spend with the value of a pre-approved credit limit on the card account\"\n\n - \"openingBooked\":\n Book balance of the account at the beginning of the account reporting period.\n It always equals the closing book balance from the previous report.\n - \"interimAvailable\":\n Available balance calculated in the course of the account ?servicer?s business day,\n at the time specified, and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation\n time/period specified.\n \n For card-accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries\n - \"interimBooked\":\n Balance calculated in the course of the account servicer's business day, at the time specified,\n and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period\n specified.\n - \"forwardAvailable\":\n Forward available balance of money that is at the disposal of the account owner on the date specified.\n - \"nonInvoiced\":\n Only for card accounts, to be checked yet.\n",
"enum": [
"closingBooked",
"expected",
"openingBooked",
"interimAvailable",
"interimBooked",
"forwardAvailable",
"nonInvoiced"
]
},
"creditLimitIncluded": {
"type": "boolean",
"description": "A flag indicating if the credit limit of the corresponding account\nis included in the calculation of the balance, where applicable.\n"
},
"lastChangeDateTime": {
"type": "string",
"format": "date-time",
"description": "This data element might be used to indicate e.g. with the expected or booked balance that no action is known\non the account, which is not yet booked.\n"
},
"lastCommittedTransaction": {
"type": "string",
"description": "\"entryReference\" of the last commited transaction to support the TPP in identifying whether all\nPSU transactions are already known.\n"
},
"referenceDate": {
"type": "string",
"format": "date",
"description": "Indicates the date of the balance."
}
}
},
"bankTransactionCode": {
"type": "string",
"description": "Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.\n\nThis code type is concatenating the three ISO20022 Codes\n * Domain Code,\n * Family Code, and\n * SubFamiliy Code\nby hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'.\n"
},
"batchIndicator": {
"type": "boolean",
"description": "If this indicator equals true, then the related entry is a batch entry.\n"
},
"batchNumberOfTransactions": {
"type": "integer",
"description": "Shall be used if and only if the batchIndicator is contained and equals true.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The date when an entry is posted to an account on the ASPSPs books.\n"
},
"checkId": {
"type": "string",
"description": "Identification of a Cheque."
},
"creditorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"creditorAgent": {
"type": "string",
"description": "BICFI\n"
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID."
},
"creditorName": {
"type": "string",
"description": "Creditor name."
},
"currencyExchange": {
"type": "array",
"description": "Array of exchange rates.",
"items": {
"type": "object",
"description": "Exchange Rate.",
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
],
"properties": {
"contractIdentification": {
"type": "string"
},
"exchangeRate": {
"type": "string"
},
"quotationDate": {
"type": "string",
"format": "date"
},
"sourceCurrency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"targetCurrency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"unitCurrency": {
"type": "string"
}
}
}
},
"debtorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"debtorAgent": {
"type": "string",
"description": "BICFI\n"
},
"debtorName": {
"type": "string",
"description": "Debtor name."
},
"endToEndId": {
"type": "string",
"description": "Unique end to end identity."
},
"entryDetails": {
"type": "array",
"description": "Might be used by the ASPSP to transport details about transactions within a batch.\n",
"items": {
"type": "object",
"required": [
"transactionAmount"
],
"properties": {
"checkId": {
"type": "string",
"description": "Identification of a Cheque."
},
"creditorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"creditorAgent": {
"type": "string",
"description": "BICFI\n"
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID."
},
"creditorName": {
"type": "string",
"description": "Creditor name."
},
"currencyExchange": {
"type": "array",
"description": "Array of exchange rates.",
"items": {
"type": "object",
"description": "Exchange Rate.",
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
],
"properties": {
"contractIdentification": {
"type": "object",
"additionalProperties": true
},
"exchangeRate": {
"type": "object",
"additionalProperties": true
},
"quotationDate": {
"type": "object",
"additionalProperties": true
},
"sourceCurrency": {
"type": "object",
"additionalProperties": true
},
"targetCurrency": {
"type": "object",
"additionalProperties": true
},
"unitCurrency": {
"type": "object",
"additionalProperties": true
}
}
}
},
"debtorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"debtorAgent": {
"type": "string",
"description": "BICFI\n"
},
"debtorName": {
"type": "string",
"description": "Debtor name."
},
"endToEndId": {
"type": "string",
"description": "Unique end to end identity."
},
"mandateId": {
"type": "string",
"description": "Identification of Mandates, e.g. a SEPA Mandate ID."
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code from ISO 20022.\n\nValues from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.\n",
"enum": [
"SALA",
"PENS"
]
},
"remittanceInformationStructured": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "string",
"enum": [
"SCOR",
"QRR",
"IPI"
]
},
"additionalRemittanceInformation": {
"type": "string"
},
"reference": {
"type": "string"
},
"referenceIssuer": {
"type": "string"
},
"referenceType": {
"type": "string"
}
}
},
"remittanceInformationStructuredArray": {
"type": "array",
"description": "Array of structured remittance information.\n",
"items": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "object",
"additionalProperties": true
},
"additionalRemittanceInformation": {
"type": "object",
"additionalProperties": true
},
"reference": {
"type": "object",
"additionalProperties": true
},
"referenceIssuer": {
"type": "object",
"additionalProperties": true
},
"referenceType": {
"type": "object",
"additionalProperties": true
}
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Unstructured remittance information.\n"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"description": "Array of unstructured remittance information.\n",
"items": {
"type": "string",
"description": "Unstructured remittance information.\n"
}
},
"transactionAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"ultimateCreditor": {
"type": "string",
"description": "Ultimate creditor."
},
"ultimateDebtor": {
"type": "string",
"description": "Ultimate debtor."
}
}
}
},
"entryReference": {
"type": "string",
"description": "Is the identification of the transaction as used e.g. for reference for deltafunction on application level.\nThe same identification as for example used within camt.05x messages.\n"
},
"mandateId": {
"type": "string",
"description": "Identification of Mandates, e.g. a SEPA Mandate ID."
},
"proprietaryBankTransactionCode": {
"type": "string",
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g.\nfor MT94x based transaction reports.\n"
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code from ISO 20022.\n\nValues from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.\n",
"enum": [
"SALA",
"PENS"
]
},
"remittanceInformationStructured": {
"type": "string",
"description": "Structured remittance information Max\n"
},
"remittanceInformationStructuredArray": {
"type": "array",
"description": "Array of structured remittance information.\n",
"items": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "string",
"enum": [
"SCOR",
"QRR",
"IPI"
]
},
"additionalRemittanceInformation": {
"type": "string"
},
"reference": {
"type": "string"
},
"referenceIssuer": {
"type": "string"
},
"referenceType": {
"type": "string"
}
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Unstructured remittance information.\n"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"description": "Array of unstructured remittance information.\n",
"items": {
"type": "string",
"description": "Unstructured remittance information.\n"
}
},
"transactionAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"transactionId": {
"type": "string",
"description": "This identification is given by the attribute transactionId of the corresponding entry of a transaction list.\n"
},
"ultimateCreditor": {
"type": "string",
"description": "Ultimate creditor."
},
"ultimateDebtor": {
"type": "string",
"description": "Ultimate debtor."
},
"valueDate": {
"type": "string",
"format": "date",
"description": "The Date at which assets become available to the account owner in case of a credit."
}
}
}
},
"information": {
"type": "array",
"description": "Array of transaction details.",
"items": {
"type": "object",
"description": "Transaction details.",
"required": [
"transactionAmount"
],
"properties": {
"_links": {
"type": "object",
"required": [
"transactionDetails"
],
"properties": {
"transactionDetails": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
}
}
},
"additionalInformation": {
"type": "string",
"description": "Might be used by the ASPSP to transport additional transaction related information to the PSU\n"
},
"additionalInformationStructured": {
"type": "object",
"description": "Is used if and only if the bookingStatus entry equals \"information\". \nEvery active standing order related to the dedicated payment account result into one entry.\n",
"required": [
"standingOrderDetails"
],
"properties": {
"standingOrderDetails": {
"type": "object",
"description": "Details of underlying standing orders.\n",
"required": [
"startDate",
"frequency"
],
"properties": {
"dayOfExecution": {
"type": "string",
"description": "Day of execution as string.\n\nThis string consists of up two characters.\nLeading zeroes are not allowed.\n\n31 is ultimo of the month.\n",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
]
},
"endDate": {
"type": "string",
"format": "date",
"description": "The last applicable day of execution.\nIf not given, it is an infinite standing order.\n"
},
"executionRule": {
"type": "string",
"description": "\"following\" or \"preceding\" supported as values.\nThis data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday.\nThe payment is then executed either the \"preceding\" or \"following\" working day.\nASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting\nthis execution rule.\n",
"enum": [
"following",
"preceding"
]
},
"frequency": {
"type": "string",
"description": "The following codes from the \"EventFrequency7Code\" of ISO 20022 are supported:\n- \"Daily\"\n- \"Weekly\"\n- \"EveryTwoWeeks\"\n- \"Monthly\"\n- \"EveryTwoMonths\"\n- \"Quarterly\"\n- \"SemiAnnual\"\n- \"Annual\"\n- \"MonthlyVariable\"\n",
"enum": [
"Daily",
"Weekly",
"EveryTwoWeeks",
"Monthly",
"EveryTwoMonths",
"Quarterly",
"SemiAnnual",
"Annual",
"MonthlyVariable"
]
},
"limitAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"monthsOfExecution": {
"type": "array",
"description": "The format is following the regular expression \\d{1,2}. \nThe array is restricted to 11 entries. \nThe values contained in the array entries shall all be different and the maximum value of one entry is 12.\nThis attribute is contained if and only if the frequency equals \"MonthlyVariable\".\nExample: An execution on January, April and October each year is addressed by [\"1\", \"4\", \"10\"].\n",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12"
]
}
},
"multiplicator": {
"type": "integer",
"description": "This is multiplying the given frequency resulting the exact frequency,\ne.g. Frequency=weekly and multiplicator=3 means every 3 weeks.\nRemark: This attribute is rarely supported in the market.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The first applicable day of execution starting from this date is the first payment.\n"
},
"withinAMonthFlag": {
"type": "boolean",
"description": "This element is only used in case of frequency equals \"Monthly\".\n\nIf this element equals false it has no effect.\nIf this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule.\n\nExample: executionRule equals \"preceding\", dayOfExecution equals \"02\" and the second of a month is a Sunday. \nIn this case, the transaction date would be on the last day of the month before.\n This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month.\nRemark: This attribute is rarely supported in the market.\n"
}
}
}
}
},
"balanceAfterTransaction": {
"type": "object",
"description": "A single balance element.\n",
"required": [
"balanceAmount",
"balanceType"
],
"properties": {
"balanceAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"balanceType": {
"type": "string",
"description": "The following balance types are defined:\n - \"closingBooked\":\n Balance of the account at the end of the pre-agreed account reporting period.\n It is the sum of the opening booked balance at the beginning of the period and all entries booked\n to the account during the pre-agreed account reporting period.\n\n For card-accounts, this is composed of\n\n - invoiced, but not yet paid entries\n\n - \"expected\":\n Balance composed of booked entries and pending items known at the time of calculation,\n which projects the end of day balance if everything is booked on the account and no other entry is posted.\n \n For card accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries and\n - pending items (not yet booked)\n \n For card-accounts:\n\n \"money to spend with the value of a pre-approved credit limit on the card account\"\n\n - \"openingBooked\":\n Book balance of the account at the beginning of the account reporting period.\n It always equals the closing book balance from the previous report.\n - \"interimAvailable\":\n Available balance calculated in the course of the account ?servicer?s business day,\n at the time specified, and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation\n time/period specified.\n \n For card-accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries\n - \"interimBooked\":\n Balance calculated in the course of the account servicer's business day, at the time specified,\n and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period\n specified.\n - \"forwardAvailable\":\n Forward available balance of money that is at the disposal of the account owner on the date specified.\n - \"nonInvoiced\":\n Only for card accounts, to be checked yet.\n",
"enum": [
"closingBooked",
"expected",
"openingBooked",
"interimAvailable",
"interimBooked",
"forwardAvailable",
"nonInvoiced"
]
},
"creditLimitIncluded": {
"type": "boolean",
"description": "A flag indicating if the credit limit of the corresponding account\nis included in the calculation of the balance, where applicable.\n"
},
"lastChangeDateTime": {
"type": "string",
"format": "date-time",
"description": "This data element might be used to indicate e.g. with the expected or booked balance that no action is known\non the account, which is not yet booked.\n"
},
"lastCommittedTransaction": {
"type": "string",
"description": "\"entryReference\" of the last commited transaction to support the TPP in identifying whether all\nPSU transactions are already known.\n"
},
"referenceDate": {
"type": "string",
"format": "date",
"description": "Indicates the date of the balance."
}
}
},
"bankTransactionCode": {
"type": "string",
"description": "Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.\n\nThis code type is concatenating the three ISO20022 Codes\n * Domain Code,\n * Family Code, and\n * SubFamiliy Code\nby hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'.\n"
},
"batchIndicator": {
"type": "boolean",
"description": "If this indicator equals true, then the related entry is a batch entry.\n"
},
"batchNumberOfTransactions": {
"type": "integer",
"description": "Shall be used if and only if the batchIndicator is contained and equals true.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The date when an entry is posted to an account on the ASPSPs books.\n"
},
"checkId": {
"type": "string",
"description": "Identification of a Cheque."
},
"creditorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"creditorAgent": {
"type": "string",
"description": "BICFI\n"
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID."
},
"creditorName": {
"type": "string",
"description": "Creditor name."
},
"currencyExchange": {
"type": "array",
"description": "Array of exchange rates.",
"items": {
"type": "object",
"description": "Exchange Rate.",
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
],
"properties": {
"contractIdentification": {
"type": "string"
},
"exchangeRate": {
"type": "string"
},
"quotationDate": {
"type": "string",
"format": "date"
},
"sourceCurrency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"targetCurrency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"unitCurrency": {
"type": "string"
}
}
}
},
"debtorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"debtorAgent": {
"type": "string",
"description": "BICFI\n"
},
"debtorName": {
"type": "string",
"description": "Debtor name."
},
"endToEndId": {
"type": "string",
"description": "Unique end to end identity."
},
"entryDetails": {
"type": "array",
"description": "Might be used by the ASPSP to transport details about transactions within a batch.\n",
"items": {
"type": "object",
"required": [
"transactionAmount"
],
"properties": {
"checkId": {
"type": "string",
"description": "Identification of a Cheque."
},
"creditorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"creditorAgent": {
"type": "string",
"description": "BICFI\n"
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID."
},
"creditorName": {
"type": "string",
"description": "Creditor name."
},
"currencyExchange": {
"type": "array",
"description": "Array of exchange rates.",
"items": {
"type": "object",
"description": "Exchange Rate.",
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
],
"properties": {
"contractIdentification": {
"type": "object",
"additionalProperties": true
},
"exchangeRate": {
"type": "object",
"additionalProperties": true
},
"quotationDate": {
"type": "object",
"additionalProperties": true
},
"sourceCurrency": {
"type": "object",
"additionalProperties": true
},
"targetCurrency": {
"type": "object",
"additionalProperties": true
},
"unitCurrency": {
"type": "object",
"additionalProperties": true
}
}
}
},
"debtorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"debtorAgent": {
"type": "string",
"description": "BICFI\n"
},
"debtorName": {
"type": "string",
"description": "Debtor name."
},
"endToEndId": {
"type": "string",
"description": "Unique end to end identity."
},
"mandateId": {
"type": "string",
"description": "Identification of Mandates, e.g. a SEPA Mandate ID."
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code from ISO 20022.\n\nValues from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.\n",
"enum": [
"SALA",
"PENS"
]
},
"remittanceInformationStructured": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "string",
"enum": [
"SCOR",
"QRR",
"IPI"
]
},
"additionalRemittanceInformation": {
"type": "string"
},
"reference": {
"type": "string"
},
"referenceIssuer": {
"type": "string"
},
"referenceType": {
"type": "string"
}
}
},
"remittanceInformationStructuredArray": {
"type": "array",
"description": "Array of structured remittance information.\n",
"items": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "object",
"additionalProperties": true
},
"additionalRemittanceInformation": {
"type": "object",
"additionalProperties": true
},
"reference": {
"type": "object",
"additionalProperties": true
},
"referenceIssuer": {
"type": "object",
"additionalProperties": true
},
"referenceType": {
"type": "object",
"additionalProperties": true
}
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Unstructured remittance information.\n"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"description": "Array of unstructured remittance information.\n",
"items": {
"type": "string",
"description": "Unstructured remittance information.\n"
}
},
"transactionAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"ultimateCreditor": {
"type": "string",
"description": "Ultimate creditor."
},
"ultimateDebtor": {
"type": "string",
"description": "Ultimate debtor."
}
}
}
},
"entryReference": {
"type": "string",
"description": "Is the identification of the transaction as used e.g. for reference for deltafunction on application level.\nThe same identification as for example used within camt.05x messages.\n"
},
"mandateId": {
"type": "string",
"description": "Identification of Mandates, e.g. a SEPA Mandate ID."
},
"proprietaryBankTransactionCode": {
"type": "string",
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g.\nfor MT94x based transaction reports.\n"
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code from ISO 20022.\n\nValues from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.\n",
"enum": [
"SALA",
"PENS"
]
},
"remittanceInformationStructured": {
"type": "string",
"description": "Structured remittance information Max\n"
},
"remittanceInformationStructuredArray": {
"type": "array",
"description": "Array of structured remittance information.\n",
"items": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "string",
"enum": [
"SCOR",
"QRR",
"IPI"
]
},
"additionalRemittanceInformation": {
"type": "string"
},
"reference": {
"type": "string"
},
"referenceIssuer": {
"type": "string"
},
"referenceType": {
"type": "string"
}
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Unstructured remittance information.\n"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"description": "Array of unstructured remittance information.\n",
"items": {
"type": "string",
"description": "Unstructured remittance information.\n"
}
},
"transactionAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"transactionId": {
"type": "string",
"description": "This identification is given by the attribute transactionId of the corresponding entry of a transaction list.\n"
},
"ultimateCreditor": {
"type": "string",
"description": "Ultimate creditor."
},
"ultimateDebtor": {
"type": "string",
"description": "Ultimate debtor."
},
"valueDate": {
"type": "string",
"format": "date",
"description": "The Date at which assets become available to the account owner in case of a credit."
}
}
}
},
"pending": {
"type": "array",
"description": "Array of transaction details.",
"items": {
"type": "object",
"description": "Transaction details.",
"required": [
"transactionAmount"
],
"properties": {
"_links": {
"type": "object",
"required": [
"transactionDetails"
],
"properties": {
"transactionDetails": {
"type": "object",
"description": "Link to a resource.",
"properties": {
"href": {
"type": "string",
"description": "Link to a resource."
}
}
}
}
},
"additionalInformation": {
"type": "string",
"description": "Might be used by the ASPSP to transport additional transaction related information to the PSU\n"
},
"additionalInformationStructured": {
"type": "object",
"description": "Is used if and only if the bookingStatus entry equals \"information\". \nEvery active standing order related to the dedicated payment account result into one entry.\n",
"required": [
"standingOrderDetails"
],
"properties": {
"standingOrderDetails": {
"type": "object",
"description": "Details of underlying standing orders.\n",
"required": [
"startDate",
"frequency"
],
"properties": {
"dayOfExecution": {
"type": "string",
"description": "Day of execution as string.\n\nThis string consists of up two characters.\nLeading zeroes are not allowed.\n\n31 is ultimo of the month.\n",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
]
},
"endDate": {
"type": "string",
"format": "date",
"description": "The last applicable day of execution.\nIf not given, it is an infinite standing order.\n"
},
"executionRule": {
"type": "string",
"description": "\"following\" or \"preceding\" supported as values.\nThis data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday.\nThe payment is then executed either the \"preceding\" or \"following\" working day.\nASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting\nthis execution rule.\n",
"enum": [
"following",
"preceding"
]
},
"frequency": {
"type": "string",
"description": "The following codes from the \"EventFrequency7Code\" of ISO 20022 are supported:\n- \"Daily\"\n- \"Weekly\"\n- \"EveryTwoWeeks\"\n- \"Monthly\"\n- \"EveryTwoMonths\"\n- \"Quarterly\"\n- \"SemiAnnual\"\n- \"Annual\"\n- \"MonthlyVariable\"\n",
"enum": [
"Daily",
"Weekly",
"EveryTwoWeeks",
"Monthly",
"EveryTwoMonths",
"Quarterly",
"SemiAnnual",
"Annual",
"MonthlyVariable"
]
},
"limitAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"monthsOfExecution": {
"type": "array",
"description": "The format is following the regular expression \\d{1,2}. \nThe array is restricted to 11 entries. \nThe values contained in the array entries shall all be different and the maximum value of one entry is 12.\nThis attribute is contained if and only if the frequency equals \"MonthlyVariable\".\nExample: An execution on January, April and October each year is addressed by [\"1\", \"4\", \"10\"].\n",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12"
]
}
},
"multiplicator": {
"type": "integer",
"description": "This is multiplying the given frequency resulting the exact frequency,\ne.g. Frequency=weekly and multiplicator=3 means every 3 weeks.\nRemark: This attribute is rarely supported in the market.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The first applicable day of execution starting from this date is the first payment.\n"
},
"withinAMonthFlag": {
"type": "boolean",
"description": "This element is only used in case of frequency equals \"Monthly\".\n\nIf this element equals false it has no effect.\nIf this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule.\n\nExample: executionRule equals \"preceding\", dayOfExecution equals \"02\" and the second of a month is a Sunday. \nIn this case, the transaction date would be on the last day of the month before.\n This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month.\nRemark: This attribute is rarely supported in the market.\n"
}
}
}
}
},
"balanceAfterTransaction": {
"type": "object",
"description": "A single balance element.\n",
"required": [
"balanceAmount",
"balanceType"
],
"properties": {
"balanceAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"balanceType": {
"type": "string",
"description": "The following balance types are defined:\n - \"closingBooked\":\n Balance of the account at the end of the pre-agreed account reporting period.\n It is the sum of the opening booked balance at the beginning of the period and all entries booked\n to the account during the pre-agreed account reporting period.\n\n For card-accounts, this is composed of\n\n - invoiced, but not yet paid entries\n\n - \"expected\":\n Balance composed of booked entries and pending items known at the time of calculation,\n which projects the end of day balance if everything is booked on the account and no other entry is posted.\n \n For card accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries and\n - pending items (not yet booked)\n \n For card-accounts:\n\n \"money to spend with the value of a pre-approved credit limit on the card account\"\n\n - \"openingBooked\":\n Book balance of the account at the beginning of the account reporting period.\n It always equals the closing book balance from the previous report.\n - \"interimAvailable\":\n Available balance calculated in the course of the account ?servicer?s business day,\n at the time specified, and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation\n time/period specified.\n \n For card-accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries\n - \"interimBooked\":\n Balance calculated in the course of the account servicer's business day, at the time specified,\n and subject to further changes during the business day.\n The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period\n specified.\n - \"forwardAvailable\":\n Forward available balance of money that is at the disposal of the account owner on the date specified.\n - \"nonInvoiced\":\n Only for card accounts, to be checked yet.\n",
"enum": [
"closingBooked",
"expected",
"openingBooked",
"interimAvailable",
"interimBooked",
"forwardAvailable",
"nonInvoiced"
]
},
"creditLimitIncluded": {
"type": "boolean",
"description": "A flag indicating if the credit limit of the corresponding account\nis included in the calculation of the balance, where applicable.\n"
},
"lastChangeDateTime": {
"type": "string",
"format": "date-time",
"description": "This data element might be used to indicate e.g. with the expected or booked balance that no action is known\non the account, which is not yet booked.\n"
},
"lastCommittedTransaction": {
"type": "string",
"description": "\"entryReference\" of the last commited transaction to support the TPP in identifying whether all\nPSU transactions are already known.\n"
},
"referenceDate": {
"type": "string",
"format": "date",
"description": "Indicates the date of the balance."
}
}
},
"bankTransactionCode": {
"type": "string",
"description": "Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.\n\nThis code type is concatenating the three ISO20022 Codes\n * Domain Code,\n * Family Code, and\n * SubFamiliy Code\nby hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'.\n"
},
"batchIndicator": {
"type": "boolean",
"description": "If this indicator equals true, then the related entry is a batch entry.\n"
},
"batchNumberOfTransactions": {
"type": "integer",
"description": "Shall be used if and only if the batchIndicator is contained and equals true.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The date when an entry is posted to an account on the ASPSPs books.\n"
},
"checkId": {
"type": "string",
"description": "Identification of a Cheque."
},
"creditorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"creditorAgent": {
"type": "string",
"description": "BICFI\n"
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID."
},
"creditorName": {
"type": "string",
"description": "Creditor name."
},
"currencyExchange": {
"type": "array",
"description": "Array of exchange rates.",
"items": {
"type": "object",
"description": "Exchange Rate.",
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
],
"properties": {
"contractIdentification": {
"type": "string"
},
"exchangeRate": {
"type": "string"
},
"quotationDate": {
"type": "string",
"format": "date"
},
"sourceCurrency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"targetCurrency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"unitCurrency": {
"type": "string"
}
}
}
},
"debtorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"debtorAgent": {
"type": "string",
"description": "BICFI\n"
},
"debtorName": {
"type": "string",
"description": "Debtor name."
},
"endToEndId": {
"type": "string",
"description": "Unique end to end identity."
},
"entryDetails": {
"type": "array",
"description": "Might be used by the ASPSP to transport details about transactions within a batch.\n",
"items": {
"type": "object",
"required": [
"transactionAmount"
],
"properties": {
"checkId": {
"type": "string",
"description": "Identification of a Cheque."
},
"creditorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"creditorAgent": {
"type": "string",
"description": "BICFI\n"
},
"creditorId": {
"type": "string",
"description": "Identification of Creditors, e.g. a SEPA Creditor ID."
},
"creditorName": {
"type": "string",
"description": "Creditor name."
},
"currencyExchange": {
"type": "array",
"description": "Array of exchange rates.",
"items": {
"type": "object",
"description": "Exchange Rate.",
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
],
"properties": {
"contractIdentification": {
"type": "object",
"additionalProperties": true
},
"exchangeRate": {
"type": "object",
"additionalProperties": true
},
"quotationDate": {
"type": "object",
"additionalProperties": true
},
"sourceCurrency": {
"type": "object",
"additionalProperties": true
},
"targetCurrency": {
"type": "object",
"additionalProperties": true
},
"unitCurrency": {
"type": "object",
"additionalProperties": true
}
}
}
},
"debtorAccount": {
"type": "object",
"description": "Reference to an account by either\n * IBAN, of a payment accounts, or\n * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
"properties": {
"cashAccountType": {
"type": "string",
"description": "ExternalCashAccountType1Code from ISO 20022.\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
},
"iban": {
"type": "string",
"description": "IBAN of an account."
},
"otherAccountIdentification": {
"type": "string",
"description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
}
}
},
"debtorAgent": {
"type": "string",
"description": "BICFI\n"
},
"debtorName": {
"type": "string",
"description": "Debtor name."
},
"endToEndId": {
"type": "string",
"description": "Unique end to end identity."
},
"mandateId": {
"type": "string",
"description": "Identification of Mandates, e.g. a SEPA Mandate ID."
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code from ISO 20022.\n\nValues from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.\n",
"enum": [
"SALA",
"PENS"
]
},
"remittanceInformationStructured": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "string",
"enum": [
"SCOR",
"QRR",
"IPI"
]
},
"additionalRemittanceInformation": {
"type": "string"
},
"reference": {
"type": "string"
},
"referenceIssuer": {
"type": "string"
},
"referenceType": {
"type": "string"
}
}
},
"remittanceInformationStructuredArray": {
"type": "array",
"description": "Array of structured remittance information.\n",
"items": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "object",
"additionalProperties": true
},
"additionalRemittanceInformation": {
"type": "object",
"additionalProperties": true
},
"reference": {
"type": "object",
"additionalProperties": true
},
"referenceIssuer": {
"type": "object",
"additionalProperties": true
},
"referenceType": {
"type": "object",
"additionalProperties": true
}
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Unstructured remittance information.\n"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"description": "Array of unstructured remittance information.\n",
"items": {
"type": "string",
"description": "Unstructured remittance information.\n"
}
},
"transactionAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"ultimateCreditor": {
"type": "string",
"description": "Ultimate creditor."
},
"ultimateDebtor": {
"type": "string",
"description": "Ultimate debtor."
}
}
}
},
"entryReference": {
"type": "string",
"description": "Is the identification of the transaction as used e.g. for reference for deltafunction on application level.\nThe same identification as for example used within camt.05x messages.\n"
},
"mandateId": {
"type": "string",
"description": "Identification of Mandates, e.g. a SEPA Mandate ID."
},
"proprietaryBankTransactionCode": {
"type": "string",
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g.\nfor MT94x based transaction reports.\n"
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code from ISO 20022.\n\nValues from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.\n",
"enum": [
"SALA",
"PENS"
]
},
"remittanceInformationStructured": {
"type": "string",
"description": "Structured remittance information Max\n"
},
"remittanceInformationStructuredArray": {
"type": "array",
"description": "Array of structured remittance information.\n",
"items": {
"type": "object",
"description": "Structured remittance information.\n",
"required": [
"reference"
],
"properties": {
"SCORorQRRorIPI": {
"type": "string",
"enum": [
"SCOR",
"QRR",
"IPI"
]
},
"additionalRemittanceInformation": {
"type": "string"
},
"reference": {
"type": "string"
},
"referenceIssuer": {
"type": "string"
},
"referenceType": {
"type": "string"
}
}
}
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Unstructured remittance information.\n"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"description": "Array of unstructured remittance information.\n",
"items": {
"type": "string",
"description": "Unstructured remittance information.\n"
}
},
"transactionAmount": {
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78\n"
},
"currency": {
"type": "string",
"description": "ISO 4217 Alpha 3 currency code.\n"
}
}
},
"transactionId": {
"type": "string",
"description": "This identification is given by the attribute transactionId of the corresponding entry of a transaction list.\n"
},
"ultimateCreditor": {
"type": "string",
"description": "Ultimate creditor."
},
"ultimateDebtor": {
"type": "string",
"description": "Ultimate debtor."
},
"valueDate": {
"type": "string",
"format": "date",
"description": "The Date at which assets become available to the account owner in case of a credit."
}
}
}
}
}
}
}
}