Fetch account details

GET 
/v1/accounts/account-id

Description

Retrieve a list of accounts associated with a specific user or entity.

tip

Access detailed information about each account, including account numbers, currency, balance details and more.

Request

Path Parameters

account-id stringrequired

The unique identifier of the account.

Query Parameters

withBalance boolean

If included, this function reads the list of accessible payment accounts, including the booking balance. This is only granted if the PSU has given consent in the related consent and if it is available from the ASPSP.

Header Parameters

X-Request-ID uuidrequired

ID of the request sent to the server, unique to the call, as determined by the initiating party.

Certificate stringrequired

The certificate used for signature verification.

ClientId stringrequired

The client ID associated with the request.

consentID stringrequired

The unique consent ID of the related consent.

Ocp-Apim-Subscription-Key stringrequired

A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses

200

OK

application/json

Schema

Schema

iban string
bban string
pan string
maskedPan string
msisdn string
currency string

Possible values: non-empty

resourceId string
name string
product string
cashAccountType string
status int32

Possible values: [0, 1, 2]


Description: 0 = "enabled", 1 = "deleted", 2 = "blocked"

bic string
linkedAccounts string
usage int32

Possible values: [0, 1]


Description: 0 = "PRIV", 1 = "ORGA"

details string
balances object[]
Array [
balanceAmount object
currency string
Possible values: non-empty
Amount string
Possible values: non-empty
balanceType int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7]

Description: 0 = "closingBooked", 1 = "expected", 2 = "authorised", 3 = "openingBooked", 4 = "interimAvailable", 5 = "interimBooked", 6 = "forwardAvailable", 7 = "nonInvoiced"
creditLimitIncluded boolean
lastChangeDateTime date-time
referenceDate date-time
lastCommittedTransaction string
]
links object
property name object
href string

Example (from schema)

{
  "iban": "string",
  "bban": "string",
  "pan": "string",
  "maskedPan": "string",
  "msisdn": "string",
  "currency": "string",
  "resourceId": "string",
  "name": "string",
  "product": "string",
  "cashAccountType": "string",
  "status": 0,
  "bic": "string",
  "linkedAccounts": "string",
  "usage": 0,
  "details": "string",
  "balances": [
    {
      "balanceAmount": {
        "currency": "string",
        "Amount": "string"
      },
      "balanceType": 0,
      "creditLimitIncluded": true,
      "lastChangeDateTime": "2024-11-07T10:42:52.750Z",
      "referenceDate": "2024-11-07T10:42:52.750Z",
      "lastCommittedTransaction": "string"
    }
  ],
  "links": {}
}

400

Bad Request

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

Description: 0 = "FORMATERROREnum", 1 = "PARAMETERNOTCONSISTENTEnum", 2 = "PARAMETERNOTSUPPORTEDEnum", 3 = "SERVICEINVALIDEnum", 4 = "RESOURCEUNKNOWNEnum", 5 = "RESOURCEEXPIREDEnum", 6 = "RESOURCEBLOCKEDEnum", 7 = "TIMESTAMPINVALIDEnum", 8 = "PERIODINVALIDEnum", 9 = "SCAMETHODUNKNOWNEnum", 10 = "CONSENTUNKNOWNEnum", 11 = "SESSIONSNOTSUPPORTEDEnum", 12 = "INVALIDTOTALAMOUNTEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

401

Unauthorized

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]

Description: 0 = "CERTIFICATEINVALIDEnum", 1 = "CERTIFICATEEXPIREDEnum", 2 = "CERTIFICATEBLOCKEDEnum", 3 = "CERTIFICATEREVOKEEnum", 4 = "CERTIFICATEMISSINGEnum", 5 = "SIGNATUREINVALIDEnum", 6 = "SIGNATUREMISSINGEnum", 7 = "CORPORATEIDINVALIDEnum", 8 = "PSUCREDENTIALSINVALIDEnum", 9 = "CONSENTINVALIDEnum", 10 = "CONSENTEXPIREDEnum", 11 = "TOKENUNKNOWNEnum", 12 = "TOKENINVALIDEnum", 13 = "TOKENEXPIREDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

403

Forbidden

application/json

Schema

Schema

authenticationSchemes string[]
properties object
items object
property name string
tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0, 1, 2, 3]

Description: 0 = "CONSENTUNKNOWNEnum", 1 = "SERVICEBLOCKEDEnum", 2 = "RESOURCEUNKNOWNEnum", 3 = "RESOURCEEXPIREDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "authenticationSchemes": [
    "string"
  ],
  "properties": {
    "items": {}
  },
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

404

Not found

application/json

Schema

Schema

statusCode int32
tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "UNKNOWNEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "statusCode": 0,
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

405

Method Not Allowed

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "INVALIDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

406

Not Acceptable

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "INVALIDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

409

Conflict

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "INVALIDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

429

Too Many Requests

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "EXCEEDEDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

Loading...