Global - Documentation

Type Definitions

account

Source:

account.js, line 17

Properties:

Name	Type	Description
`id`	String
`iban`	String	Account IBAN
`bic`	String	BIC
`usableBalance`	number	Usable balance
`availableBalance`	number	Available balance
`bankBalance`	number	Bank balance
`bankName`	String	Bank name
`seized`	Boolean

addresses

Source:

account.js, line 30

Properties:

Name Type Description

paging

objet

Properties

Name	Type	Description
`totalResults`	number	Total amount of addresses

data

Array.<Object>

Properties

Name	Type	Description
`id`	String
`type`	String	Type address
`addressLine1`	String	Address line 1
`streetName`	String	Street name
`houseNumberBlock`	String	Street Number
`zipCode`	String	Zip code
`cityName`	String	City
`countryName`	String	Country

barzahlen

Source:

account.js, line 198

Properties:

Name	Type	Description
`depositAllowance`	String
`withdrawAllowance`	String
`remainingAmountMonth`	String
`feeRate`	String
`cash26WithdrawalsCount`	String
`cash26WithdrawalsSum`	String
`atmWithdrawalsCount`	String
`atmWithdrawalsSum`	String
`monthlyDepositFeeThreshold`	String
`success`	Boolean

barzahlen

Source:

n26.js, line 6

cardLimit

Source:

card.js, line 7

Properties:

Name	Type	Attributes	Description
`limit`	String		Limit type
`amount`	Number	<optional>	Amount
`countryList`	Array.<String>	<optional>	Array of country code

cards

Source:

account.js, line 46

Properties:

Name Type Description

paging

objet

Properties

Name	Type	Description
`totalResults`	number	Total amount of addresses

data Array.<Card>

contact

Source:

account.js, line 231

Properties:

Name Type Description

id String

name String

subtitle String

account

Object

Properties

Name	Type	Description
`accountType`	String
`iban`	String
`bic`	String

csv

Source:

account.js, line 258

CSV file with "," delimiter

invitation

Source:

account.js, line 189

Properties:

Name	Type	Description
`invited`	String	Invited email
`status`	String	Current status
`reward`	Number	Reward amount
`created`	Number	Timestamp

limit

Source:

account.js, line 243

Properties:

Name	Type	Description
`limit`	String	Limit type, can be ATM_DAILY_ACCOUNT or POS_DAILY_ACCOUNT
`amount`	Number

me

Source:

account.js, line 54

Properties:

Name	Type	Description
`id`	String
`birthDate`	String	Birth date
`email`	String	Email
`gender`	String	Gender
`title`	String	Title (eg: Ph.)
`firstName`	String	Firstname
`lastName`	String	Lastname
`kycFirstName`	String	Firstname on KYC
`kycLastName`	String	Lastname on KYC
`mobilePhoneNumber`	String	Mobile phone number
`nationality`	String	Nationality
`passwordHash`	String
`shadowID`	String
`signupCompleted`	String
`cardName`	String
`transferWiseTermsAccepted`	String

Promise

Source:

account.js, line 10

statement

Source:

account.js, line 213

Properties:

Name	Type	Description
`id`	String
`type`	String	`pdf` for pdf buffer or `base64` for pdf in base64
`pdf`	Buffer \| String	PDF encoded

statements

Source:

account.js, line 221

Properties:

Name	Type	Description
`id`	String
`url`	String
`month`	Number
`visibleTS`	Number
`year`	Number

statuses

Source:

account.js, line 75

Properties:

Name	Type	Default
`singleStepSignup`	Number
`emailValidationInitiated`	Number
`emailValidationCompleted`	Number
`phonePairingInitiated`	Number
`phonePairingCompleted`	Number
`kycInitiated`	Number
`kycCompleted`	Number
`kycWebIDInitiated`	Number
`kycWebIDCompleted`	Number
`cardActivationCompleted`	Number
`cardIssued`	Number
`pinDefinitionCompleted`	Number
`bankAccountCreationInitiated`	Number
`bankAccountCreationSucceded`	Number
`firstIncomingTransaction`	Number
`smsVerificationCode`	String
`unpairTokenCreation`	Number
`finoIntegrationStatus`	Number \| String	`'NEVER'`
`id`	Number

transaction

Source:

account.js, line 134

Properties:

Name Type Attributes Description

id String

type String

smartLinkId String

amount String

currencyCode String

originalAmount String

originalCurrency String

exchangeRate String

merchantCity String

visibleTS String

mcc String

mccGroup String

merchantName String

merchantId String

recurring String

userId String

linkId String

accountId String

category String

cardId String

pending String

transactionNature String

partnerAccountIsSepa String

partnerName String

partnerIban String

referenceText String

userCertified String

smartContactId String

partnerBic String

confirmed String

tags Array.<String>

meta

Object

Properties

Name	Type	Attributes	Description
`memo`	String	<optional>

transactions

Source:

account.js, line 99

Properties:

Name	Type	Description
`id`	String
`type`	String
`smartLinkId`	String
`amount`	String
`currencyCode`	String
`originalAmount`	String
`originalCurrency`	String
`exchangeRate`	String
`merchantCity`	String
`visibleTS`	String
`mcc`	String
`mccGroup`	String
`merchantName`	String
`merchantId`	String
`recurring`	String
`userId`	String
`linkId`	String
`accountId`	String
`category`	String
`cardId`	String
`pending`	String
`transactionNature`	String
`partnerAccountIsSepa`	String
`partnerName`	String
`partnerIban`	String
`referenceText`	String
`userCertified`	String
`smartContactId`	String
`partnerBic`	String
`confirmed`	String

transfer

Source:

account.js, line 172

Properties:

Name	Type	Description
`id`	String
`n26Iban`	String
`referenceText`	String
`partnerName`	String
`partnerIban`	String
`partnerBic`	String
`partnerAccountIsSepa`	Boolean
`amount`	Number
`currencyCode`	String
`linkId`	String
`recurring`	String
`visibleTS`	String

Name	Type	Description
`id`	String
`base64Image`	String	PNG base64 encoded
`name`	String	Translated category name