IRIS (IrisPay) — Data Models (87 schemas)¶
Account¶
| Field | Type |
|---|---|
| iban | string |
ActiveUsersDTO¶
| Field | Type |
|---|---|
| bankAccounts | integer |
| users | integer |
ActiveUsersDetailsDTO¶
| Field | Type |
|---|---|
| bankAccounts | array |
| users | array |
| pages | integer |
| page | integer |
| elementsSize | integer |
ActiveUsersDetailsFilterClientDTO¶
| Field | Type |
|---|---|
| agentHash | string |
| fromDate | string |
| toDate | string |
| validUntil | string |
| page | integer |
| size | integer |
ActiveUsersFilterClientDTO¶
| Field | Type |
|---|---|
| agentHash | string |
| fromDate | string |
| toDate | string |
| validUntil | string |
AdditionalURLsHookDTO¶
| Field | Type |
|---|---|
| url | string |
| state | string |
| agentHash | string |
| optionalEvents | array |
| successUrl | string |
| errorUrl | string |
AgentUserDTO¶
| Field | Type |
|---|---|
| name | string |
| middleName | string |
| family | string |
| string | |
| uic | string |
| dateCreated | string |
| userHash | string |
| accounts | integer |
AisWithoutRightsClientDTO¶
| Field | Type |
|---|---|
| hookHash | string |
| bankHash | string |
| string |
AuthorizePaymentDTO¶
| Field | Type |
|---|---|
| code | string |
| ibanId | integer |
| smsCode | string |
BalanceDTO¶
| Field | Type |
|---|---|
| amount | number |
| currency | string |
| balanceType | string |
| referenceDate | string |
| creditLimitIncluded | boolean |
BalanceV7DTO¶
| Field | Type |
|---|---|
| amount | number |
| currency | string |
| balanceType | string |
| referenceDate | string |
| creditLimitIncluded | boolean |
BalancesDTO¶
| Field | Type |
|---|---|
| balances | array |
BankAccountCGateDTO¶
| Field | Type |
|---|---|
| ibanId | integer |
| iban | string |
| fulfilled | boolean |
| validUntil | string |
| frequencyPerDay | integer |
BankAccountDTO¶
| Field | Type |
|---|---|
| id | integer |
| name | string |
| iban | string |
| product | string |
| ownerName | string |
| currency | string |
| hasAuthorization | boolean |
| bankHash | string |
| bankName | string |
| liteLogoUrl | string |
| darkLogoUrl | string |
| country | string |
| dateCreate | string |
| consents | ConsentsStatusDTO |
| fulfilled | boolean |
| validUntil | string |
| frequencyPerDay | integer |
BankDTO¶
| Field | Type |
|---|---|
| bankHash | string |
| name | string |
| urlLogo | string |
| urlDarkLogo | string |
| sca | string |
| directPayment | boolean |
| paymentRequiresIban | boolean |
| country | string |
BankMaintenanceMessageDTO¶
| Field | Type |
|---|---|
| bankName | string |
| maintenanceMessage | string |
| fromDate | string |
| toDate | string |
BankScaDTO¶
| Field | Type |
|---|---|
| startUrl | string |
| endUrl | string |
| formText | string |
| loadingText | string |
| psuIdType | string |
| sca | string |
| gatherPsu | boolean |
| hasAuthorization | boolean |
| externalApp | boolean |
| authorizationId | string |
BankScaUrlDTO¶
| Field | Type |
|---|---|
| url | string |
| bankSCA | string |
BankV1DTO¶
| Field | Type |
|---|---|
| bankHash | string |
| name | string |
| country | string |
BankV7DTO¶
| Field | Type |
|---|---|
| bankHash | string |
| name | string |
| urlLogo | string |
| urlDarkLogo | string |
| sca | string |
| directPayment | boolean |
| paymentRequiresIban | boolean |
| country | string |
| requiresIbanForPayment | boolean |
BankV8DTO¶
| Field | Type |
|---|---|
| bankHash | string |
| name | string |
| urlLogo | string |
| urlDarkLogo | string |
| sca | string |
| directPayment | boolean |
| paymentRequiresIban | boolean |
| fullName | string |
| bic | string |
| services | string |
| country | string |
| videos | array |
| consentRequiresIban | boolean |
| consentRequiresPsu | boolean |
| paymentRequiresAuthorization | boolean |
| consentRequiresAuthorization | boolean |
| paymentRequiresPsu | boolean |
| psuType | string |
| budgetPaymentsRequirePaymentCategory | boolean |
| aisAvailable | boolean |
| pisAvailable | boolean |
BudgetNoConsentDirectRequest¶
| Field | Type |
|---|---|
| bankHash | string |
| receiverIban | string |
| receiverName | string |
| remittanceDescription | string |
| sum | number |
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| description | string |
| senderIban | string |
| psuId | string |
| bankFlowType | string |
| promoPayment | boolean |
| identifier | string |
| identifierType | string |
| paymentCategory | string |
BudgetRequestPaymentDTO¶
| Field | Type |
|---|---|
| fromIbanId | integer |
| receiverIban | string |
| receiverName | string |
| remittanceDescription | string |
| sum | number |
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| description | string |
| identifier | string |
| identifierType | string |
| paymentCategory | string |
BulkBudgetEntryDTO¶
| Field | Type |
|---|---|
| receiverIban | string |
| receiverName | string |
| remittanceDescription | string |
| sum | number |
| identifier | string |
| identifierType | string |
| paymentCategory | string |
BulkBudgetPaymentRequest¶
| Field | Type |
|---|---|
| bankHash | string |
| bankFlowType | string |
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| senderIban | string |
| psuId | string |
| requestedExecutionDate | string |
| payments | array |
BulkBudgetPaymentRequestV2¶
| Field | Type |
|---|---|
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| fromIbanId | integer |
| requestedExecutionDate | string |
| payments | array |
BulkEntryDTO¶
| Field | Type |
|---|---|
| receiverIban | string |
| receiverName | string |
| remittanceDescription | string |
| sum | number |
BulkPaymentDTO¶
| Field | Type |
|---|---|
| date | string |
| status | string |
| reasonForFail | string |
| payerBank | BankV1DTO |
| payments | array |
BulkPaymentEntryDTO¶
| Field | Type |
|---|---|
| payeeName | string |
| description | string |
| sum | number |
| payeeIban | string |
| currency | string |
| status | string |
BulkPaymentRequest¶
| Field | Type |
|---|---|
| bankHash | string |
| bankFlowType | string |
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| senderIban | string |
| psuId | string |
| requestedExecutionDate | string |
| payments | array |
BulkPaymentRequestV2¶
| Field | Type |
|---|---|
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| fromIbanId | integer |
| requestedExecutionDate | string |
| payments | array |
BulkPaymentV2DTO¶
| Field | Type |
|---|---|
| date | string |
| status | string |
| reasonForFail | string |
| payerBank | BankV1DTO |
| payments | array |
| paymentType | string |
BulkPaymentsListResponse¶
| Field | Type |
|---|---|
| pages | integer |
| page | integer |
| payments | array |
CategoryDTO¶
| Field | Type |
|---|---|
| code | string |
| name | string |
| otherSide | string |
CategorySumByOtherSideDTO¶
| Field | Type |
|---|---|
| otherSide | string |
| sum | number |
| currency | string |
| transactionCount | integer |
CategorySumDTO¶
| Field | Type |
|---|---|
| sum | number |
| currency | string |
| code | string |
| categoryName | string |
| transactionsCount | integer |
| sumByOtherSide | array |
Consent¶
| Field | Type |
|---|---|
| ibanId | integer |
| consentId | string |
| iban | string |
| consentPermissions | array |
| validUntil | string |
| frequencyPerDay | integer |
| givenAt | string |
| status | string |
| country | string |
| bankHash | string |
| bankName | string |
ConsentRequestClientDTO¶
| Field | Type |
|---|---|
| userInfo | UserDataDTO |
| ibans | array |
ConsentRequestServerDTO¶
| Field | Type |
|---|---|
| userHash | string |
| url | string |
| ibansIds | object |
ConsentStatus¶
| Field | Type |
|---|---|
| status | string |
ConsentsDTO¶
| Field | Type |
|---|---|
| consents | array |
ConsentsStatusDTO¶
| Field | Type |
|---|---|
| consents | array |
| errorCodes | string |
CreateConsentDTO¶
| Field | Type |
|---|---|
| bankHash | string |
| username | string |
| iban | string |
| hookHash | string |
| sms | string |
| authorizationUrl | string |
| authorizationId | string |
| bankFlowType | string |
| accountListOnly | boolean |
EmailAccountDTO¶
| Field | Type |
|---|---|
| userHash | string |
| name | string |
| lastname | string |
| surname | string |
EmailDTO¶
| Field | Type |
|---|---|
| string |
ExchangeRate¶
| Field | Type |
|---|---|
| currencyFrom | string |
| rateFrom | string |
| currencyTo | string |
| rateTo | string |
| rateDate | string |
HookServerDTO¶
| Field | Type |
|---|---|
| hookHash | string |
| closeSelf | integer |
| redirectTimer | integer |
IbanConsentDetailsDTO¶
| Field | Type |
|---|---|
| dateCreated | string |
| iban | string |
| currency | string |
| ownerName | string |
| consentStatus | string |
IbanOwnerDTO¶
| Field | Type |
|---|---|
| iban | string |
| ownerName | string |
IbanRequestPaymentDTO¶
| Field | Type |
|---|---|
| fromIbanId | integer |
| receiverIban | string |
| receiverName | string |
| remittanceDescription | string |
| sum | number |
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| description | string |
IbanRequestPaymentResponseDTO¶
| Field | Type |
|---|---|
| code | string |
| expiryDate | string |
| confirmUrl | string |
| ibanId | integer |
IdentitificationAccountDTO¶
| Field | Type |
|---|---|
| userHash | string |
| idUrl | string |
| identityStatusUrl | string |
| identityToken | string |
| identified | string |
JWS¶
| Field | Type |
|---|---|
| kid | string |
| kty | string |
| n | string |
| e | string |
| use | string |
| x5c | array |
JWSKeys¶
| Field | Type |
|---|---|
| keys | array |
KycStatusUpdateDTO¶
| Field | Type |
|---|---|
| submissionId | string |
| status | string |
MakePaymentDTO¶
| Field | Type |
|---|---|
| code | string |
| ibanId | integer |
NoConsentRequestPaymentDTO¶
| Field | Type |
|---|---|
| bankHash | string |
| receiverIban | string |
| receiverName | string |
| remittanceDescription | string |
| sum | number |
| currency | string |
| hookHash | string |
| emailNotification | boolean |
| description | string |
| senderIban | string |
| psuId | string |
| bankFlowType | string |
| promoPayment | boolean |
PaymentAuditBankPaymentsClientDTO¶
| Field | Type |
|---|---|
| bank | string |
| count | integer |
| sum | number |
PaymentAuditByBankClientDTO¶
| Field | Type |
|---|---|
| confirmed | array |
| failed | array |
PaymentDTO¶
| Field | Type |
|---|---|
| date | string |
| payeeName | string |
| payerName | string |
| payerBank | BankV1DTO |
| payeeBank | BankV1DTO |
| description | string |
| sum | string |
| payerIban | string |
| payeeIban | string |
| id | string |
| currency | string |
| status | string |
| reasonForFail | string |
| psuMessage | string |
| authorised | boolean |
PaymentResult¶
| Field | Type |
|---|---|
| result | string |
PaymentStatusDTO¶
| Field | Type |
|---|---|
| payment | PaymentDTO |
| urlSca | UrlsScaDTO |
| ready | boolean |
PaymentV2ForAgentDTO¶
| Field | Type |
|---|---|
| date | string |
| description | string |
| payerName | string |
| payerIban | string |
| payerBankName | string |
| payerBankCountry | string |
| sum | number |
| status | string |
| payeeName | string |
| payeeIban | string |
| currency | string |
| remittanceDescription | string |
| paymentType | string |
PaymentsFilterClientDTO¶
| Field | Type |
|---|---|
| page | integer |
| size | integer |
| status | string |
| userHash | string |
| agentHash | string |
| fromDate | string |
| toDate | string |
| noBulkPayments | boolean |
PaymentsFilterLastUpdatedClientDTO¶
| Field | Type |
|---|---|
| page | integer |
| size | integer |
| statuses | array |
| publicHash | string |
| userHash | string |
| agentHash | string |
| fromDate | string |
| toDate | string |
PaymentsList¶
| Field | Type |
|---|---|
| date | string |
| description | string |
| payerName | string |
| payerIban | string |
| sum | number |
| status | string |
PaymentsListRequest¶
| Field | Type |
|---|---|
| page | integer |
| size | integer |
| status | string |
| userHash | string |
PaymentsListResponse¶
| Field | Type |
|---|---|
| size | integer |
| page | integer |
| payments | array |
PaymentsV2ForAgentListResponse¶
| Field | Type |
|---|---|
| pages | integer |
| page | integer |
| elementsSize | integer |
| payments | array |
PublicHashIdentitificationAccountDTO¶
| Field | Type |
|---|---|
| userHash | string |
| idUrl | string |
| identityStatusUrl | string |
| identityToken | string |
| identified | string |
| publicHash | string |
RegisterHookDTO¶
| Field | Type |
|---|---|
| url | string |
| state | string |
| agentHash | string |
| optionalEvents | array |
RequestPaymentResponseDTO¶
| Field | Type |
|---|---|
| code | string |
| expiryDate | string |
| confirmUrl | string |
SignupAgentRequest¶
| Field | Type |
|---|---|
| agentHash | string |
| companyName | string |
| uic | string |
| name | string |
| middleName | string |
| family | string |
| string | |
| requiresPublicHash | boolean |
| publicHash | string |
| webhookUrl | string |
| legalEntityType | string |
| mobile | string |
SignupDTO¶
| Field | Type |
|---|---|
| agentHash | string |
| companyName | string |
| uic | string |
| name | string |
| middleName | string |
| family | string |
| identityHash | string |
| string | |
| webhookUrl | string |
Token¶
| Field | Type |
|---|---|
| id | integer |
| accountId | integer |
| token | string |
| type | string |
| bankId | integer |
| psuId | integer |
| psuIdentifier | string |
| dateCreated | string |
TransactionAmount¶
| Field | Type |
|---|---|
| amount | number |
| currency | string |
TransactionDTO¶
| Field | Type |
|---|---|
| transactionId | string |
| iban | string |
| currency | string |
| amount | string |
| description | string |
| otherSide | string |
| date | string |
TransactionV7DTO¶
| Field | Type |
|---|---|
| transactionId | string |
| bookingDate | string |
| creditorAccount | Account |
| creditorName | string |
| debtorAccount | Account |
| debtorName | string |
| entryReference | string |
| remittanceInformationUnstructured | string |
| transactionAmount | TransactionAmount |
| exchangeRate | ExchangeRate |
| valueDate | string |
| creditDebitIndicator | string |
TransactionV8DTO¶
| Field | Type |
|---|---|
| transactionId | string |
| bookingDate | string |
| creditorAccount | Account |
| creditorName | string |
| debtorAccount | Account |
| debtorName | string |
| entryReference | string |
| remittanceInformationUnstructured | string |
| transactionAmount | TransactionAmount |
| exchangeRate | ExchangeRate |
| valueDate | string |
| creditDebitIndicator | string |
| category | CategoryDTO |
TransactionsV7DTO¶
| Field | Type |
|---|---|
| transactions | array |
| balances | array |
TransactionsV8DTO¶
| Field | Type |
|---|---|
| transactions | array |
| balances | array |
| categorySums | array |
| nextPageUrl | string |
TranscardData¶
| Field | Type |
|---|---|
| token | string |
| getxRequestId | string |
| x_request_id | string |
UIConsentRequestDTO¶
| Field | Type |
|---|---|
| id | integer |
| accountId | integer |
| expirationDate | string |
| timeout | integer |
| showValidUntil | boolean |
| showFrequencyPerDay | boolean |
| expirationMessage | string |
| successMessage | string |
| deleted | boolean |
UrlsScaDTO¶
| Field | Type |
|---|---|
| startUrl | string |
| endUrl | string |
| externalApp | boolean |
UserDataDTO¶
| Field | Type |
|---|---|
| firstName | string |
| middleName | string |
| lastName | string |
| string | |
| phone | string |
| uic | string |
UsersListDTO¶
| Field | Type |
|---|---|
| pages | integer |
| size | integer |
| currPage | integer |
| list | array |
VideoDTO¶
| Field | Type |
|---|---|
| url | string |