BankAccount (GET/api/bankaccount/{accountId}, GET /api/bankaccount)
Model
Tables
BankAccount - list of payment accounts in unified LDS format
PSD2BankAccount - staging list of payment accounts with original ASPSP response (data XML)
Transaction - list of transactions in a unified LDS format. Each transaction is linked to one BankAccount
PSD2Transaction- list of transactions with the original ASPSP response (data XML). Each transaction is linked to one PSD2BankAccount
TransactionDetail - transaction details (extending attributes for Transaction record)
Bank - list od ASPSP
BankIdentifier
BankIdentifierSchema
Currency
BankAccountBalance
BalanceHistory
Details
Bank
bankOrder - order of bank
color - color
swiftBicCode- business code of a bank following ISO_9362 (https://en.wikipedia.org/wiki/ISO_9362)
logoUrlHash- Unique identifier of image resource (hash value of the URL). This is used to identify the resources stored locally at TPP app (**). SHA1 algorithm is used.
logoSmall- URL with small version of bank logo image
logo - URL with bank logo image
country- an embedded object representing bank (see below)
migrateToBankId - used only for scraping to PSD2 migration workflow
isPisp - flag indicating if bank supports PIS
isPisForceAccount - flag indicating if the bank supports PIS with selecting debtor account after redirection or not
provider- an embedded object representing connector
providerId- an embedded object representing connector
provider - connector name
providerType - connector type (scraping/api/reverse)
dynamicDataPath- scraping only
dynamicDataRegex- scraping only
config - config from Psd2Provider (PSD2 only)
isAisForceAccount- flag indicating if the bank supports AIS with selecting account after redirection or not
id - Unique identifier
name - Full name of the bank
officialName - Registry bank name (full name)
BankAccount (GET/api/bankaccount/{accountId}
|
accountName - Name of the account (can by customized by the user)
balances - Balances of the account
bank- an embedded object representing bank
consent - an embedded object representing consent
consentId - Internal identifier of consent
currencyCode - Default currency for the account (ISO 4217 code)
errorMessage- error message for the failed session
externalConsents - User's consents in which context this bank account has been retrieved
generateNotifications- scraping only
hasImage - boolean
holderInfo - PSU’s Name Surname or Business Name
holderType - Type of account holder
iban - Bank account IBAN
id - unique bank account identifier (technical key) assigned by LDS
importDate - timestamp when the account was added to LDS
isActive- active/ inactive flag on the account (api returns only active accounts)
isBusiness- retail (false) or business account (true)
lastTransactionDate - timestamp when the account was refreshed last time
manualHolderInfo - PSU’s Name set manually
manualRelation - type of relation between PSU and an Account set manually
providerType - type of provider (API/Scraping)
raw - Object contains selected fields from ASPSP response (e.g. accountType.Code and accountType.Description)
relations - Type of relations between PSU and Account
retrievedName- scraping only
secondaryIdentifiers- collection of alternative bank account identifiers (IBAN/BBAN/ resourceID/email/phone).
syncError - account synchronization error details
aspspResponse - httpStatusCode and content of error from ASPSP
errorType - types of error
executionId - traceid
message - error message for internal issues
syncExecutionId - ExecutionId of last synchronization
syncOffline- flag indicating if the bank account is refreshed with RefreshActiveAccount=true and batch process
syncStatus - Account synchronization status
transactionSyncDate - Last successful transaction history synchronization date
transactionSyncStatus - Account transaction history synchronization status
type - account type mapped from ASPSP response
typeName - Account type name
BalanceTypes:
ClosingAvailable
ClosingBooked
ClosingAvailable
ClosingBooked
Expected
ForwardAvailable
Information
InterimAvailable
InterimBooked
OpeningAvailable
OpeningBooked
PreviouslyClosedBooked
Reference material: Balance types
Attributes balance and balanceOverdraft are kept for backward compatibility purposes. For new implementation please use only balances object
HolderType:
individual
corporation
RelationTypes:
Owner
Borrower
Guarantor
ProxyOwnerGeneral
ProxyOwnerSpecial
ProxyOwnerAdministrator
ProxyOwnerUser
Beneficiary
Trustee
PL translations are available here: PSU relation type (PL)
Types:
ChargeCard
CreditCard
CurrentAccount
EMoney
Loan
Mortgage
PrePaidCard
Savings
ErrorTypes:
accountMissing - account is no longer sent
aspspResponse - error from ASPSP
signature - error during signing
internal - internal error
missingDetails - no information about account details (available only IBAN information from token message)
Transaction (GET /api/transaction)
|
Statuses:
Unauthorised
Confirmed
Added
Booked
Done
Pending
Rejected
Cancelled
Scheduled
Hold
TransactionDetails (GET /api/transaction/{transactionId})
|
sii prefix identifies details of Social Insurance Institution transaction (SII) types
tax prefix identifies details of tax transaction types
card prefix identifies details of card transaction types