Account

Account

N26 Account

Constructor

new Account(auth)

Source:

Create new account instance

Parameters:
Name Type Description
auth Object

Object from auth()

Methods

account() → {Promise.<account>}

Source:

Get account details

Returns:
Type
Promise.<account>

addresses() → {Promise.<addresses>}

Source:

Get addresses

Returns:
Type
Promise.<addresses>

auth() → {Promise.<Account>}

Source:

authentication

Returns:
Type
Promise.<Account>

barzahlen() → {Promise.<barzahlen>}

Source:

Check barzahlen

Returns:
Type
Promise.<barzahlen>

cards(cardIdopt) → {Promise.<Card>|Promise.<cards>}

Source:

Get one specific or all cards

Parameters:
Name Type Attributes Description
cardId String <optional>

Card Id - Don't use, some info like status is missing

Returns:
Type
Promise.<Card> | Promise.<cards>

categories() → {Promise.<Array.<category>>}

Source:

Get transaction categories

Returns:
Type
Promise.<Array.<category>>

contacts() → {Promise.<Array.<contact>>}

Source:

Get contacts

Returns:
Type
Promise.<Array.<contact>>

csv(from, toopt) → {Promise.<csv>}

Source:

Get transactions CSV

Parameters:
Name Type Attributes Default Description
from Date | Number

From date

to Date | Number <optional>
now()

To date

Returns:
Type
Promise.<csv>

invitations(emailsopt) → {Promise|Promise.<Array.<invitation>>}

Source:

Get / send invitations emails

Parameters:
Name Type Attributes Description
emails String | Array.<String> <optional>

Emails to send an invitation

Returns:
Type
Promise | Promise.<Array.<invitation>>

limits(limitsopt) → {Promise|Promise.<Array.<limit>>}

Source:

Get / Set limits

Parameters:
Name Type Attributes Description
limits Object <optional>
Properties
Name Type Attributes Description
atm Number <optional>

Set daily limit for ATM withdraw

pos Number <optional>

Set daily limit for POS payment

Returns:
Type
Promise | Promise.<Array.<limit>>

me(full) → {Promise.<me>}

Source:

Get information about current user

Parameters:
Name Type Description
full Boolean

Return full informations

Returns:
Type
Promise.<me>

memo(smartLinkId, memo)

Source:

Create or update Meme

Parameters:
Name Type Description
smartLinkId String

SmartLinkId

memo String

Memo text

statement() → {Promise.<statement>}

Source:

Return pdf buffer or base64 encoded

Returns:
Type
Promise.<statement>

statements() → {Promise.<Array.<statements>>}

Source:

Get statements

Returns:
Type
Promise.<Array.<statements>>

stats(from, to, interval)

Source:

Get stats

Parameters:
Name Type Description
from Date | Number

From date (native date or timestamp)

to Date | Number

To date (native date or timestamp)

interval String

Interval data per "days" / "weeks" / "months" / "years"

statuses() → {Promise.<statuses>}

Source:

Get statuses

Return many timestamps about this account

Returns:
Type
Promise.<statuses>

transaction(id, options) → {Promise.<transaction>}

Source:

Get transaction detail

Parameters:
Name Type Description
id String

Transaction number

options Object
Properties
Name Type Description
meta Boolean

With meta

Returns:
Type
Promise.<transaction>

transactions(optionsopt) → {Promise.<Array.<transactions>>}

Source:

Get transactions

Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Default Description
limit Number <optional>

Limit results

categories Array.<String> <optional>

Filter by categories

from Number <optional>

"From" timestamp limit

to Number <optional>

"To" timestamp limit

text String <optional>

Text search

pending String <optional>
false

Pending transaction

Returns:
Type
Promise.<Array.<transactions>>

transfer(data) → {Promise.<transfer>}

Source:

Create transfer

Parameters:
Name Type Description
data Object
Properties
Name Type Description
pin Number | String

Credit card pin

bic String

BIC recipient

iban String

IBAN recipient

name String

Recipient name

amount Number

Amount

reference String

Reference

Returns:
Type
Promise.<transfer>

unpairConfirm(smsNumber) → {Promise}

Source:

Confirm unpairing

Confirm unpairing Use the number on the sms message.

Parameters:
Name Type Description
smsNumber Number

The 5 digits received on the phone

Returns:
Type
Promise

unpairInit(pin, cardNumber) → {Promise}

Source:

Init unpair device

Init unpair process. Will receive an email (ignore it) + sms.

Parameters:
Name Type Description
pin Number
cardNumber Number

The 10 digits on the card, below name

Returns:
Type
Promise