IRIS (IrisPay) — Data Models

Schema field reference for the IrisPay API V6. Interactive request/response: the API page.

87 schemas. Types and field names are shown exactly as in the OpenAPI spec.

Account

Field	Type	Required	Description
iban	string	—

ActiveUsersDTO

Field	Type	Required	Description
bankAccounts	integer (int32)	—
users	integer (int32)	—

ActiveUsersDetailsDTO

Field	Type	Required	Description
bankAccounts	array[integer (int64)]	—
users	array[string]	—
pages	integer (int32)	—
page	integer (int32)	—
elementsSize	integer (int32)	—

ActiveUsersDetailsFilterClientDTO

Field	Type	Required	Description
agentHash	string	—
fromDate	string (date-time)	—
toDate	string (date-time)	—
validUntil	string (date-time)	—
page	integer (int32)	—
size	integer (int32)	—

ActiveUsersFilterClientDTO

Field	Type	Required	Description
agentHash	string	—
fromDate	string (date-time)	—
toDate	string (date-time)	—
validUntil	string (date-time)	—

AdditionalURLsHookDTO

Field	Type	Required	Description
url	string	—
state	string	—
agentHash	string	—
optionalEvents	array[string]	—
successUrl	string	—
errorUrl	string	—

AgentUserDTO

Field	Type	Required	Description
name	string	—
middleName	string	—
family	string	—
email	string	—
uic	string	—
dateCreated	string (date-time)	—
userHash	string	—
accounts	integer (int32)	—

AisWithoutRightsClientDTO

Field	Type	Required	Description
hookHash	string	—
bankHash	string	—
email	string	—

AuthorizePaymentDTO

Field	Type	Required	Description
code	string	—
ibanId	integer (int64)	—
smsCode	string	—

BalanceDTO

Field	Type	Required	Description
amount	number	—
currency	string	—

BalanceV7DTO

Field	Type	Required	Description
amount	number	—
currency	string	—
balanceType	string	—
referenceDate	string	—
creditLimitIncluded	boolean	—

BalancesDTO

Field	Type	Required	Description
balances	array[BalanceV7DTO]	—

BankAccountCGateDTO

Field	Type	Required	Description
ibanId	integer (int64)	—
iban	string	—
fulfilled	boolean	—
validUntil	string	—
frequencyPerDay	integer (int32)	—

BankAccountDTO

Field	Type	Required	Description
id	integer (int64)	—
name	string	—
iban	string	—
product	string	—
ownerName	string	—
currency	string	—
hasAuthorization	boolean	—
bankHash	string	—
bankName	string	—
liteLogoUrl	string	—
darkLogoUrl	string	—
country	string	—
dateCreate	string (date-time)	—
consents	ConsentsStatusDTO	—
fulfilled	boolean	—
validUntil	string	—
frequencyPerDay	integer (int32)	—

BankDTO

Field	Type	Required	Description
bankHash	string	—
name	string	—
urlLogo	string	—
urlDarkLogo	string	—
sca	string	—	Enum: REDIRECT_URL, PUSH, CODE_REDIRECT_URL, OAUTH_REDIRECT_URL
directPayment	boolean	—
paymentRequiresIban	boolean	—
country	string	—

BankMaintenanceMessageDTO

Field	Type	Required	Description
bankName	string	—
maintenanceMessage	string	—
fromDate	string	—
toDate	string	—

BankScaDTO

Field	Type	Required	Description
startUrl	string	—
endUrl	string	—
formText	string	—
loadingText	string	—
psuIdType	string	—	Enum: USERNAME, MSISDN, USERNAME_AND_CLIENT_NUMBER, ZB_RETAIL, OIB_HR, TOKEN_SN
sca	string	—	Enum: REDIRECT_URL, PUSH, CODE_REDIRECT_URL, OAUTH_REDIRECT_URL
gatherPsu	boolean	—
hasAuthorization	boolean	—
externalApp	boolean	—
authorizationId	string	—

BankScaUrlDTO

Field	Type	Required	Description
url	string	—
bankSCA	string	—	Enum: REDIRECT_URL, PUSH, CODE_REDIRECT_URL, OAUTH_REDIRECT_URL

BankV1DTO

Field	Type	Required	Description
bankHash	string	—
name	string	—
country	string	—

BankV7DTO

Field	Type	Required	Description
bankHash	string	—
name	string	—
urlLogo	string	—
urlDarkLogo	string	—
sca	string	—	Enum: REDIRECT_URL, PUSH, CODE_REDIRECT_URL, OAUTH_REDIRECT_URL
directPayment	boolean	—
paymentRequiresIban	boolean	—
country	string	—
requiresIbanForPayment	boolean	—

BankV8DTO

Field	Type	Required	Description
bankHash	string	—
name	string	—
urlLogo	string	—
urlDarkLogo	string	—
sca	string	—	Enum: REDIRECT_URL, PUSH, CODE_REDIRECT_URL, OAUTH_REDIRECT_URL
directPayment	boolean	—
paymentRequiresIban	boolean	—
fullName	string	—
bic	string	—
services	string	—
country	string	—
videos	array[VideoDTO]	—
consentRequiresIban	boolean	—
consentRequiresPsu	boolean	—
paymentRequiresAuthorization	boolean	—
consentRequiresAuthorization	boolean	—
paymentRequiresPsu	boolean	—
psuType	string	—	Enum: USERNAME, MSISDN, USERNAME_AND_CLIENT_NUMBER, ZB_RETAIL, OIB_HR, TOKEN_SN
budgetPaymentsRequirePaymentCategory	boolean	—
aisAvailable	boolean	—
pisAvailable	boolean	—

BudgetNoConsentDirectRequest

Field	Type	Required	Description
bankHash	string	—
receiverIban	string	—
receiverName	string	—
remittanceDescription	string	—
sum	number	—
currency	string	—
hookHash	string	—
emailNotification	boolean	—
description	string	—
senderIban	string	—
psuId	string	—
bankFlowType	string	—	Enum: DEFAULT, PC, MOBILE
promoPayment	boolean	—
identifier	string	—
identifierType	string	—	Enum: EGN, EIK, PNF
paymentCategory	string	—

BudgetRequestPaymentDTO

Field	Type	Required	Description
fromIbanId	integer (int64)	—
receiverIban	string	—
receiverName	string	—
remittanceDescription	string	—
sum	number	—
currency	string	—
hookHash	string	—
emailNotification	boolean	—
description	string	—
identifier	string	—
identifierType	string	—	Enum: EGN, EIK, PNF
paymentCategory	string	—

BulkBudgetEntryDTO

Field	Type	Required	Description
receiverIban	string	—
receiverName	string	—
remittanceDescription	string	—
sum	number	—
identifier	string	—
identifierType	string	—	Enum: EGN, EIK, PNF
paymentCategory	string	—

BulkBudgetPaymentRequest

Field	Type	Required	Description
bankHash	string	—
bankFlowType	string	—	Enum: DEFAULT, PC, MOBILE
currency	string	—
hookHash	string	—
emailNotification	boolean	—
senderIban	string	—
psuId	string	—
requestedExecutionDate	string (date-time)	—
payments	array[BulkBudgetEntryDTO]	—

BulkBudgetPaymentRequestV2

Field	Type	Required	Description
currency	string	—
hookHash	string	—
emailNotification	boolean	—
fromIbanId	integer (int64)	—
requestedExecutionDate	string (date-time)	—
payments	array[BulkBudgetEntryDTO]	—

BulkEntryDTO

Field	Type	Required	Description
receiverIban	string	—
receiverName	string	—
remittanceDescription	string	—
sum	number	—

BulkPaymentDTO

Field	Type	Required	Description
date	string (date-time)	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED
reasonForFail	string	—
payerBank	BankV1DTO	—
payments	array[BulkPaymentEntryDTO]	—

BulkPaymentEntryDTO

Field	Type	Required	Description
payeeName	string	—
description	string	—
sum	number	—
payeeIban	string	—
currency	string	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED

BulkPaymentRequest

Field	Type	Required	Description
bankHash	string	—
bankFlowType	string	—	Enum: DEFAULT, PC, MOBILE
currency	string	—
hookHash	string	—
emailNotification	boolean	—
senderIban	string	—
psuId	string	—
requestedExecutionDate	string (date-time)	—
payments	array[BulkEntryDTO]	—

BulkPaymentRequestV2

Field	Type	Required	Description
currency	string	—
hookHash	string	—
emailNotification	boolean	—
fromIbanId	integer (int64)	—
requestedExecutionDate	string (date-time)	—
payments	array[BulkEntryDTO]	—

BulkPaymentV2DTO

Field	Type	Required	Description
date	string	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED
reasonForFail	string	—
payerBank	BankV1DTO	—
payments	array[BulkPaymentEntryDTO]	—
paymentType	string	—	Enum: DOMESTIC_CREDIT_TRANSFER, DOMESTIC_BUDGET_TRANSFER, SEPA_CREDIT_TRANSFER, CROSS_BORDER_TRANSFER, BULK_DOMESTIC_CREDIT_TRANSFER, BULK_DOMESTIC_BUDGET_TRANSFER, BULK_SEPA_CREDIT_TRANSFER, BULK_ENTRY, SEPA_BUDGET_TRANSFER, BULK_SEPA_BUDGET_TRANSFER

BulkPaymentsListResponse

Field	Type	Required	Description
pages	integer (int32)	—
page	integer (int32)	—
payments	array[BulkPaymentV2DTO]	—

CategoryDTO

Field	Type	Required	Description
code	string	—
name	string	—
otherSide	string	—

CategorySumByOtherSideDTO

Field	Type	Required	Description
otherSide	string	—
sum	number	—
currency	string	—
transactionCount	integer (int32)	—

CategorySumDTO

Field	Type	Required	Description
sum	number	—
currency	string	—
code	string	—
categoryName	string	—
transactionsCount	integer (int32)	—
sumByOtherSide	array[CategorySumByOtherSideDTO]	—

Consent

Field	Type	Required	Description
ibanId	integer (int64)	—
consentId	string	—
iban	string	—
consentPermissions	array[string]	—
validUntil	string	—
frequencyPerDay	integer (int32)	—
givenAt	string	—
status	string	—
country	string	—
bankHash	string	—
bankName	string	—

ConsentRequestClientDTO

Field	Type	Required	Description
userInfo	UserDataDTO	—
ibans	array[string]	—

ConsentRequestServerDTO

Field	Type	Required	Description
userHash	string	—
url	string	—
ibansIds	object	—

ConsentStatus

Field	Type	Required	Description
status	string	—

ConsentsDTO

Field	Type	Required	Description
consents	array[Consent]	—

ConsentsStatusDTO

Field	Type	Required	Description
consents	array[ConsentStatus]	—
errorCodes	string	—	Enum: CONSENT_EXPIRED, BALANCE_FAILED, TRANSACTIONS_FAILED, CONSENT_DETAILS_FAILED

CreateConsentDTO

Field	Type	Required	Description
bankHash	string	—
username	string	—
iban	string	—
hookHash	string	—
sms	string	—
authorizationUrl	string	—
authorizationId	string	—
bankFlowType	string	—	Enum: DEFAULT, PC, MOBILE
accountListOnly	boolean	—

EmailAccountDTO

Field	Type	Required	Description
userHash	string	—
name	string	—
lastname	string	—
surname	string	—

EmailDTO

Field	Type	Required	Description
email	string	—

ExchangeRate

Field	Type	Required	Description
currencyFrom	string	—
rateFrom	string	—
currencyTo	string	—
rateTo	string	—
rateDate	string	—

HookServerDTO

Field	Type	Required	Description
hookHash	string	—
closeSelf	integer (int32)	—
redirectTimer	integer (int32)	—

IbanConsentDetailsDTO

Field	Type	Required	Description
dateCreated	string (date-time)	—
iban	string	—
currency	string	—
ownerName	string	—
consentStatus	string	—

IbanOwnerDTO

Field	Type	Required	Description
iban	string	—
ownerName	string	—

IbanRequestPaymentDTO

Field	Type	Required	Description
fromIbanId	integer (int64)	—
receiverIban	string	—
receiverName	string	—
remittanceDescription	string	—
sum	number	—
currency	string	—
hookHash	string	—
emailNotification	boolean	—
description	string	—

IbanRequestPaymentResponseDTO

Field	Type	Required	Description
code	string	—
expiryDate	string (date-time)	—
confirmUrl	string	—
ibanId	integer (int64)	—

IdentitificationAccountDTO

Field	Type	Required	Description
userHash	string	—
idUrl	string	—
identityStatusUrl	string	—
identityToken	string	—
identified	string	—	Enum: SUCCESS, PENDING, FAIL, NOT_STARTED

JWS

Field	Type	Required	Description
kid	string	—
kty	string	—
n	string	—
e	string	—
use	string	—
x5c	array[string]	—

JWSKeys

Field	Type	Required	Description
keys	array[JWS]	—

KycStatusUpdateDTO

Field	Type	Required	Description
submissionId	string	—
status	string	—

MakePaymentDTO

Field	Type	Required	Description
code	string	—
ibanId	integer (int64)	—

NoConsentRequestPaymentDTO

Field	Type	Required	Description
bankHash	string	—
receiverIban	string	—
receiverName	string	—
remittanceDescription	string	—
sum	number	—
currency	string	—
hookHash	string	—
emailNotification	boolean	—
description	string	—
senderIban	string	—
psuId	string	—
bankFlowType	string	—	Enum: DEFAULT, PC, MOBILE
promoPayment	boolean	—

PaymentAuditBankPaymentsClientDTO

Field	Type	Required	Description
bank	string	—
currency	string	—
count	integer (int32)	—
sum	number	—

PaymentAuditByBankClientDTO

Field	Type	Required	Description
confirmed	array[PaymentAuditBankPaymentsClientDTO]	—
failed	array[PaymentAuditBankPaymentsClientDTO]	—

PaymentDTO

Field	Type	Required	Description
date	string (date-time)	—
payeeName	string	—
payerName	string	—
payerBank	BankV1DTO	—
payeeBank	BankV1DTO	—
description	string	—
sum	string	—
payerIban	string	—
payeeIban	string	—
id	string	—
currency	string	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED
reasonForFail	string	—
psuMessage	string	—
authorised	boolean	—

PaymentResult

Field	Type	Required	Description
result	string	—	Enum: SUCCESS, BAD_AUTHENTICATION

PaymentStatusDTO

Field	Type	Required	Description
payment	PaymentDTO	—
urlSca	UrlsScaDTO	—
ready	boolean	—

PaymentV2ForAgentDTO

Field	Type	Required	Description
date	string (date-time)	—
description	string	—
payerName	string	—
payerIban	string	—
payerBankName	string	—
payerBankCountry	string	—
sum	number	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED
payeeName	string	—
payeeIban	string	—
currency	string	—
remittanceDescription	string	—
paymentType	string	—	Enum: DOMESTIC, BUDGET, SEPA, CROSS_BORDER, BULK_DOMESTIC, BULK_SEPA, BULK_BUDGET, INSTANT_DOMESTIC, SEPA_BUDGET, BULK_SEPA_BUDGET, PERIODIC, PERIODIC_DOMESTIC, PERIODIC_SEPA

PaymentsFilterClientDTO

Field	Type	Required	Description
page	integer (int32)	—
size	integer (int32)	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED
userHash	string	—
agentHash	string	—
fromDate	string (date-time)	—
toDate	string (date-time)	—
noBulkPayments	boolean	—

PaymentsFilterLastUpdatedClientDTO

Field	Type	Required	Description
page	integer (int32)	—
size	integer (int32)	—
statuses	array[string]	—
publicHash	string	—
userHash	string	—
agentHash	string	—
fromDate	string (date-time)	—
toDate	string (date-time)	—

PaymentsList

Field	Type	Required	Description
date	string (date-time)	—
description	string	—
payerName	string	—
payerIban	string	—
sum	number	—
status	string	—	Enum: WAITING, CONFIRMED, REJECTED, SCA_REDIRECTED, FAILED, CREATED, BULK_PROCESSED

PaymentsListRequest

Field	Type	Required	Description
page	integer (int32)	—
size	integer (int32)	—
status	string	—
userHash	string	—

PaymentsListResponse

Field	Type	Required	Description
size	integer (int32)	—
page	integer (int32)	—
payments	array[PaymentsList]	—

PaymentsV2ForAgentListResponse

Field	Type	Required	Description
pages	integer (int32)	—
page	integer (int32)	—
elementsSize	integer (int32)	—
payments	array[PaymentV2ForAgentDTO]	—

PublicHashIdentitificationAccountDTO

Field	Type	Required	Description
userHash	string	—
idUrl	string	—
identityStatusUrl	string	—
identityToken	string	—
identified	string	—	Enum: SUCCESS, PENDING, FAIL, NOT_STARTED
publicHash	string	—

RegisterHookDTO

Field	Type	Required	Description
url	string	—
state	string	—
agentHash	string	—
optionalEvents	array[string]	—

RequestPaymentResponseDTO

Field	Type	Required	Description
code	string	—
expiryDate	string (date-time)	—
confirmUrl	string	—

SignupAgentRequest

Field	Type	Required	Description
agentHash	string	—
companyName	string	—
uic	string	—
name	string	—
middleName	string	—
family	string	—
email	string	—
requiresPublicHash	boolean	—
publicHash	string	—
webhookUrl	string	—
legalEntityType	string	—	Enum: SOLEOWNER, LTD, SOLTD, JSC, SOJSC, SD, CD, CDA, DZZD, NPO, BRANCH, NOT, OTHERPROF, OFFSHORE, OTHER JRD, PUBLIC, VCC, OTHER
mobile	string	—

SignupDTO

Field	Type	Required	Description
agentHash	string	—
companyName	string	—
uic	string	—
name	string	—
middleName	string	—
family	string	—
identityHash	string	—
email	string	—
webhookUrl	string	—

Token

Field	Type	Required	Description
id	integer (int64)	—
accountId	integer (int64)	—
token	string	—
type	string	—	Enum: AUTH_AIS, AUTH_PIS, REFRESH_AIS, REFRESH_PIS, CONSENT_RECEIVED, CONSENT_VALID
bankId	integer (int64)	—
psuId	integer (int64)	—
psuIdentifier	string	—
dateCreated	string (date-time)	—

TransactionAmount

Field	Type	Required	Description
amount	number	—
currency	string	—

TransactionDTO

Field	Type	Required	Description
transactionId	string	—
iban	string	—
currency	string	—
amount	string	—
description	string	—
otherSide	string	—
date	string	—

TransactionV7DTO

Field	Type	Required	Description
transactionId	string	—
bookingDate	string	—
creditorAccount	Account	—
creditorName	string	—
debtorAccount	Account	—
debtorName	string	—
entryReference	string	—
remittanceInformationUnstructured	string	—
transactionAmount	TransactionAmount	—
exchangeRate	ExchangeRate	—
valueDate	string	—
creditDebitIndicator	string	—	Enum: CREDIT, DEBIT

TransactionV8DTO

Field	Type	Required	Description
transactionId	string	—
bookingDate	string	—
creditorAccount	Account	—
creditorName	string	—
debtorAccount	Account	—
debtorName	string	—
entryReference	string	—
remittanceInformationUnstructured	string	—
transactionAmount	TransactionAmount	—
exchangeRate	ExchangeRate	—
valueDate	string	—
creditDebitIndicator	string	—	Enum: CREDIT, DEBIT
category	CategoryDTO	—

TransactionsV7DTO

Field	Type	Required	Description
transactions	array[TransactionV7DTO]	—
balances	array[BalanceDTO]	—

TransactionsV8DTO

Field	Type	Required	Description
transactions	array[TransactionV8DTO]	—
balances	array[BalanceDTO]	—
categorySums	array[CategorySumDTO]	—
nextPageUrl	string	—

TranscardData

Field	Type	Required	Description
token	string	—
getxRequestId	string	—
x_request_id	string	—

UIConsentRequestDTO

Field	Type	Required	Description
id	integer (int64)	—
accountId	integer (int64)	—
expirationDate	string (date-time)	—
timeout	integer (int32)	—
showValidUntil	boolean	—
showFrequencyPerDay	boolean	—
expirationMessage	string	—
successMessage	string	—
deleted	boolean	—

UrlsScaDTO

Field	Type	Required	Description
startUrl	string	—
endUrl	string	—
externalApp	boolean	—

UserDataDTO

Field	Type	Required	Description
firstName	string	—
middleName	string	—
lastName	string	—
email	string	—
phone	string	—
uic	string	—

UsersListDTO

Field	Type	Required	Description
pages	integer (int32)	—
size	integer (int32)	—
currPage	integer (int32)	—
list	array[AgentUserDTO]	—

VideoDTO

Field	Type	Required	Description
url	string	—