#ResponseWrapperAccountListDto

Response for list of Accounts

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS

messagestring

Message describing the response

Example: Request failed/Request successful

codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001

data object

Represents paginated results.

content object[]

The list of items in the current page.

Array [

idinteger<int64>

Unique ID of the account

Example: 776914

versioninteger<int64>

Version of the account

Example: 0

detailedAccountTitlestring

Detailed account title

Example: 0074618257 test, 98 884,624 TND

unformattedInternalIdentifierstring

Unformatted internal identifier

Example: 74618257

ribstring

RIB (Relevé d'Identité Bancaire)

Example: 4012086007461825500

ibanstring

International Bank Account Number (IBAN).

Example: TN59BIAT123456789012345

externalStatusstring

External account status.

Example: ACTIVE

pivotCurrencystring

Pivot currency

Example: TND

exchangeSuccessboolean

Indicate if there is no exchange available between source and target

Example: false

overdraftFlagboolean

Overdraft flag.

Example: true

includedTransactionstring

Included transaction indicator.

Example: VIREMENT,DEMANDE_SERVICE,REMISES_ORDRE,CONSULTATION

totalnumber

Total account value

formattedFundReservationstring

Formatted fund reservation.

Example: 15 000,00

valueCurrencyBalancenumber

Value currency balance.

pivotCurrencyValueBalancestring

Pivot currency value balance.

Example: 55,000.250

formattedBalanceValuestring

Account balance formatted according to currency

Example: 98 884,624

accountingBalanceCurrencynumber

Accounting balance in the pivot currency

Example: 98884.624

formattedAccountingBalanceCurrencystring

Formatted accounting balance in pivot currency

Example: 98 884,624

balanceCurrencynumber

Balance currency

Example: 98884.624

formattedBalanceCurrencystring

Formatted balance currency

Example: 98 884,624

formattedAuthorizationstring

Formatted authorization

Example: -

realCurrencyBalancenumber

Real currency balance

Example: 2894.706

pivotCurrencyRealBalancestring

Pivot currency balance for real-time data

Example: 2 894,706

elligibleLCNboolean

Indicates if LCN is allowed

Example: false

createdByEerboolean

Indicates whether the account was created by EER.

Example: true

realTimeDataSucessboolean

Indicates if real-time data is successfully retrieved

Example: true

accountNumberstring

Account number.

Example: 12345678

titlestring

Account title

Example: test

accountTypestring

Account type.

Example: Compte Courant

internalIdentifierstring

Internal identifier

Example: 74618257

swiftCodestring

Bank identifier code.

Example: BIATTNTT

bankCodestring

Bank code

Example: 00004

associatedCountryCodestring

Associated country code

Example: TN

controlKeystring

Control key for account verification.

Example: 97

keyRibstring

RIB (Relevé d'Identité Bancaire) key.

Example: 12345

accountActivestring

Account status indicator.

Example: Yes

accountStatusstring

Account status.

Example: Active

accountWorkflowStatusstring

Workflow status of the account.

Example: Approved

currencyLabelstring

Currency label

Example: TND

currencystring

Currency code Alpha

Example: 788

mobilePhoneNumberstring

Mobile phone number.

Example: +216 20 123 456

fixedPhoneNumberstring

Fixed phone number associated with the account.

Example: +123456789

professionalPhoneNumberstring

Professional phone number associated with the account.

Example: +123456789

phoneNumberstring

Contact telephone number associated with the account.

Example: +216 20 123 456

gsmPhoneNumberstring

GSM phone number associated with the account.

Example: +123456789

accountOpeningDatestring<date-time>

Date when the account was opened.

lastUpdatedDatestring<date-time>

Date when the account was last updated.

accountClosureDatestring<date-time>

Account closure date.

authorizationExpirationDatestring<date-time>

Overdraft expiration date.

authorizationnumber

Overdraft authorization amount.

formattedAuthorizationExpirationDatestring

Formatted authorization expiration date.

Example: 31/12/2024

agencyLabelstring

Agency label

Example: AGENCE LE PASSAGE

agencystring

Agency code

Example: 86

agencyNamestring

Bank branch name.

Example: BIAT Tunis Centre

agencyCodestring

Bank branch code.

Example: 001

tradeRegisterAgencyCodestring

Trade register agency code.

Example: TUN_RC_001

productCodestring

Product code

Example: 2222

productCodeLabelstring

Product code associated with the account.

Example: CPTE_COURANT_TUN

accountNaturestring

Account nature.

Example: Courant

accountNatureLabelstring

Label for the account nature.

Example: Savings Account

accountTypeLabelstring

Label for the account type.

Example: Checking Account

createdByUserstring

User who created the account.

Example: admin_biat

productSellerUserstring

User who sold the product associated with the account.

Example: john.doe

closureInitiatorUserstring

User who initiated the account closure instance.

Example: jane.doe

closureFinalizerUserstring

User who finalized the account closure.

Example: admin.user

clientAccountTitlestring

Client account title.

Example: Compte M. Ahmed Ben Ali

commercialRelationshipTitlestring

Commercial relationship title

Example: Commercial relationship title

commercialRelationshipIdinteger<int64>

Commercial relationship identifier.

Example: 12345

clientSegmentstring

Client segmentation category.

Example: Premium

accountStatementFrequencystring

Account statement frequency.

Example: Monthly

accountStatementFrequencyLabelstring

Label for the account statement frequency.

Example: Monthly

statementCodeLabelstring

Label for the account statement code.

Example: Monthly Statement

statementCodestring

Account statement code.

Example: REL_MENS_2024

accountRadicalstring

Account radical (base identifier).

Example: 98765432

includesTransferstring

Indicates whether the account includes transfers.

Example: true

includesServiceRequeststring

Indicates whether the account includes service requests.

Example: true

includesBulkTransfersstring

Indicates whether the account includes order deposits.

Example: true

includesConsultationstring

Indicates whether the account includes consultation operations.

Example: true

accountingBalancenumber

Account balance (in accounting terms)

realTimeBalancenumber

Real-time balance

unavailableBalancenumber

Unavailable balance

availableBalancenumber

Available balance

offSicavBalancenumber

Balance excluding investments

SICAVBalancenumber

SICAV balance

formattedAccountingBalancestring

Formatted accounting balance

Example: 15 000,000

formattedRealTimeBalancestring

Formatted real-time balance

Example: 20 000,000

formattedUnavailableBalancestring

Formatted unavailable balance

Example: 5 000,000

formattedAvailableBalancestring

Formatted available balance

Example: 10 000,000

offSicavBalanceFormattedstring

Formatted off-SICAV balance

Example: 8 000,000

sicavBalanceFormattedstring

Formatted SICAV balance

Example: 12 000,000

totalFormattedstring

Total formatted balance

Example: 50 000,000

balanceValuenumber

Account value balance.

Example: 55000.25

reservedFundsnumber

Reserved funds amount.

Example: 15000

reservedFundsAmountnumber

Amount of reserved funds associated with the account.

Example: 1000.5

associatedCashAccountBalancenumber

Account balance for the associated cash account.

primaryAddressstring

Primary address

Example: Rue de la Liberté 12, Tunis, Tunisia

secondaryPrimaryAddressstring

Secondary line of primary address

Example: Résidence El Manar

primaryAddressLine3string

Third line of primary address

Example: Floor 5

primaryAddressPostalCodestring

Postal code for primary address

Example: 1002

mainAddressCountrystring

Main address country

Example: Tunisia

mainCitystring

City of main address

Example: Tunis

mainAddressCountryLabelstring

Label for the main address country

Example: France

mainCityLabelstring

Label for the main city

Example: Tunis

temporaryAddressstring

Temporary address

Example: Avenue Habib Bourguiba 45, Sousse, Tunisia

secondaryTemporaryAddressstring

Second line of temporary address

Example: Appartement 7

temporaryAddressLine3string

Third line of temporary address

Example: Floor 3

temporaryAddressPostalCodestring

Postal code for temporary address

Example: 4000

temporaryAddressCountrystring

Temporary address country

Example: Tunisia

temporaryCitystring

Temporary city

Example: Sousse

temporaryAddressCountryLabelstring

Label for the temporary address country

Example: Germany

temporaryCityLabelstring

Label for the temporary city

Example: Sousse

temporaryAddressStartDatestring<date-time>

Start date for the temporary address

temporaryAddressEndDatestring<date-time>

End date for the temporary address

startDateTemporaryAddressstring

endDateTemporaryAddressstring

clientAddressLine1string

First line of client address

Example: Rue de Palestine

clientAddressLine2string

Second line of client address

Example: Immeuble Carthage

clientAddressLine3string

Third line of client address

Example: Résidence El Moez

clientCitystring

Client's city

Example: Tunis

clientPostalCodestring

Client's postal code

Example: 1002

eligibleCreditTransferboolean

Indicates if credit transfer is allowed

Example: false

eligibleDebitTransferboolean

Indicates if debit transfer is allowed

Example: false

eligibleDemandboolean

Indicates if demand is allowed

Example: false

eligibleDirectDebitboolean

Indicates if direct debit is allowed

Example: false

eligibleBeneficiaryAdditionboolean

Indicates if beneficiary addition is allowed

Example: false

eligibleBillPaymentboolean

Indicates if bill payment is allowed

Example: false

eligibleBulkTransfersboolean

Indicates if remittance order is allowed

Example: false

eligibleInternationalTransferboolean

Indicates if international transfer is allowed

Example: false

convertibleLabelstring

Convertible label

Example: 86

accountDirectionstring

Account direction indicating the nature of operations.

Example: DEBIT

accountChapterstring

Account chapter, representing the hierarchical grouping of accounts.

Example: CHAP_001

internalCashAccountIdentifierstring

Internal identifier for the associated cash account.

Example: BIAT_0123456789

externalAccountIdentifierstring

External account identifier.

Example: TN59BIAT123456789012345

accountClosureReasonstring

Account closure reason.

Example: Client Request

accountingCategorystring

Accounting category.

Example: Asset

accountActiveLabelstring

Label for the account active status.

Example: Active

accountOpeningLabelstring

Label for the account opening date.

Example: Opened on 2020-01-01

isFavoriteAccountboolean

Indicates whether the account is marked as a favorite.

Example: true

accountingCategoryLabelstring

Label for the accounting category.

Example: Asset

convertibilityStatusstring

Convertibility status.

Example: true

languagestring

Language associated with the account.

Example: en

]

totalElementsinteger<int64>

The total number of elements across all pages.

Example: 100

totalPagesinteger<int32>

The total number of pages available.

Example: 10

numberinteger<int32>

The current page number (zero-based).

Example: 0

sizeinteger<int32>

The number of items per page.

Example: 10

error object

Detailed information about the error response

codestring

Error code

Example: ERR-142

messagestring

Error message

Example: Resource not found / Internal server error

details object[]

List of error details

Array [

codestring

Error code

Example: ER4001

messagestring

Detailed error message

Example: Invalid input

targetstring

Target of the error

Example: username

]

suggestionsstring[]

List of suggestions for resolving the error

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Additional metadata about the error, that could help in debugging

property name*string

Additional metadata about the error, that could help in debugging

Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}

timestampstring<date-time>

Timestamp of when the response was generated

ResponseWrapperAccountListDto

{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "content": [
      {
        "id": 776914,
        "version": 0,
        "detailedAccountTitle": "0074618257 test, 98 884,624 TND",
        "unformattedInternalIdentifier": 74618257,
        "rib": 4012086007461825500,
        "iban": "TN59BIAT123456789012345",
        "externalStatus": "ACTIVE",
        "pivotCurrency": "TND",
        "exchangeSuccess": false,
        "overdraftFlag": true,
        "includedTransaction": "VIREMENT,DEMANDE_SERVICE,REMISES_ORDRE,CONSULTATION",
        "total": 0,
        "formattedFundReservation": "15 000,00",
        "valueCurrencyBalance": 0,
        "pivotCurrencyValueBalance": "55,000.250",
        "formattedBalanceValue": "98 884,624",
        "accountingBalanceCurrency": 98884.624,
        "formattedAccountingBalanceCurrency": "98 884,624",
        "balanceCurrency": 98884.624,
        "formattedBalanceCurrency": "98 884,624",
        "formattedAuthorization": "-",
        "realCurrencyBalance": 2894.706,
        "pivotCurrencyRealBalance": "2 894,706",
        "elligibleLCN": false,
        "createdByEer": true,
        "realTimeDataSucess": true,
        "accountNumber": "12345678",
        "title": "test",
        "accountType": "Compte Courant",
        "internalIdentifier": 74618257,
        "swiftCode": "BIATTNTT",
        "bankCode": "00004",
        "associatedCountryCode": "TN",
        "controlKey": "97",
        "keyRib": "12345",
        "accountActive": "Yes",
        "accountStatus": "Active",
        "accountWorkflowStatus": "Approved",
        "currencyLabel": "TND",
        "currency": "788",
        "mobilePhoneNumber": "+216 20 123 456",
        "fixedPhoneNumber": "+123456789",
        "professionalPhoneNumber": "+123456789",
        "phoneNumber": "+216 20 123 456",
        "gsmPhoneNumber": "+123456789",
        "accountOpeningDate": "2024-07-29T15:51:28.071Z",
        "lastUpdatedDate": "2024-07-29T15:51:28.071Z",
        "accountClosureDate": "2024-07-29T15:51:28.071Z",
        "authorizationExpirationDate": "2024-07-29T15:51:28.071Z",
        "authorization": 0,
        "formattedAuthorizationExpirationDate": "31/12/2024",
        "agencyLabel": "AGENCE LE PASSAGE",
        "agency": 86,
        "agencyName": "BIAT Tunis Centre",
        "agencyCode": "001",
        "tradeRegisterAgencyCode": "TUN_RC_001",
        "productCode": "2222",
        "productCodeLabel": "CPTE_COURANT_TUN",
        "accountNature": "Courant",
        "accountNatureLabel": "Savings Account",
        "accountTypeLabel": "Checking Account",
        "createdByUser": "admin_biat",
        "productSellerUser": "john.doe",
        "closureInitiatorUser": "jane.doe",
        "closureFinalizerUser": "admin.user",
        "clientAccountTitle": "Compte M. Ahmed Ben Ali",
        "commercialRelationshipTitle": "Commercial relationship title",
        "commercialRelationshipId": 12345,
        "clientSegment": "Premium",
        "accountStatementFrequency": "Monthly",
        "accountStatementFrequencyLabel": "Monthly",
        "statementCodeLabel": "Monthly Statement",
        "statementCode": "REL_MENS_2024",
        "accountRadical": "98765432",
        "includesTransfer": "true",
        "includesServiceRequest": "true",
        "includesBulkTransfers": "true",
        "includesConsultation": "true",
        "accountingBalance": 0,
        "realTimeBalance": 0,
        "unavailableBalance": 0,
        "availableBalance": 0,
        "offSicavBalance": 0,
        "SICAVBalance": 0,
        "formattedAccountingBalance": "15 000,000",
        "formattedRealTimeBalance": "20 000,000",
        "formattedUnavailableBalance": "5 000,000",
        "formattedAvailableBalance": "10 000,000",
        "offSicavBalanceFormatted": "8 000,000",
        "sicavBalanceFormatted": "12 000,000",
        "totalFormatted": "50 000,000",
        "balanceValue": 55000.25,
        "reservedFunds": 15000,
        "reservedFundsAmount": 1000.5,
        "associatedCashAccountBalance": 0,
        "primaryAddress": "Rue de la Liberté 12, Tunis, Tunisia",
        "secondaryPrimaryAddress": "Résidence El Manar",
        "primaryAddressLine3": "Floor 5",
        "primaryAddressPostalCode": "1002",
        "mainAddressCountry": "Tunisia",
        "mainCity": "Tunis",
        "mainAddressCountryLabel": "France",
        "mainCityLabel": "Tunis",
        "temporaryAddress": "Avenue Habib Bourguiba 45, Sousse, Tunisia",
        "secondaryTemporaryAddress": "Appartement 7",
        "temporaryAddressLine3": "Floor 3",
        "temporaryAddressPostalCode": "4000",
        "temporaryAddressCountry": "Tunisia",
        "temporaryCity": "Sousse",
        "temporaryAddressCountryLabel": "Germany",
        "temporaryCityLabel": "Sousse",
        "temporaryAddressStartDate": "2024-07-29T15:51:28.071Z",
        "temporaryAddressEndDate": "2024-07-29T15:51:28.071Z",
        "startDateTemporaryAddress": "string",
        "endDateTemporaryAddress": "string",
        "clientAddressLine1": "Rue de Palestine",
        "clientAddressLine2": "Immeuble Carthage",
        "clientAddressLine3": "Résidence El Moez",
        "clientCity": "Tunis",
        "clientPostalCode": "1002",
        "eligibleCreditTransfer": false,
        "eligibleDebitTransfer": false,
        "eligibleDemand": false,
        "eligibleDirectDebit": false,
        "eligibleBeneficiaryAddition": false,
        "eligibleBillPayment": false,
        "eligibleBulkTransfers": false,
        "eligibleInternationalTransfer": false,
        "convertibleLabel": "86",
        "accountDirection": "DEBIT",
        "accountChapter": "CHAP_001",
        "internalCashAccountIdentifier": "BIAT_0123456789",
        "externalAccountIdentifier": "TN59BIAT123456789012345",
        "accountClosureReason": "Client Request",
        "accountingCategory": "Asset",
        "accountActiveLabel": "Active",
        "accountOpeningLabel": "Opened on 2020-01-01",
        "isFavoriteAccount": true,
        "accountingCategoryLabel": "Asset",
        "convertibilityStatus": "true",
        "language": "en"
      }
    ],
    "totalElements": 100,
    "totalPages": 10,
    "number": 0,
    "size": 10
  },
  "error": {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "username"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {
      "requestId": "3c5e4cebf39cbc5b",
      "operationId": "66fd4d2ae6b6"
    }
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}