Account Information Service (2.3)

The Berlin Group - A European Standards Initiative | info@: info@berlin-group.org | URL: https://www.berlin-group.org/

License: Creative Commons Attribution 4.0 International Public License

Retrieve a PSU's account information — account details, balances, transactions, and statements — for the accounts covered by a valid consent.

Get account

GET /v2/accounts/{account-id}

Returns the details of a single account, with balances where the consent and bank allow.

Path parameters

Parameter	Type	Description
account-id	string , required	Identifier of the account, returned as `resourceId` in the account list. It stays constant for the account's lifetime. Example: `Text, maximum of 70 characters.` Allowed length: max: 70

Query parameters

Parameter	Type	Description
withBalance	boolean , optional	Include the account's balances in the response, when the consent and bank allow. Example: `true`

Header parameters

Header	Type	Description
Digest	string , optional	Integrity hash of the request body in the form `SHA-256=<base64>`. For an empty body, use the hash of an empty string. See Signing requests for how the Digest and signature are built. Example: `SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=`
x-jws-signature	string , optional	Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed.
X-Request-ID	string , required	Unique ID of the request, set by the initiating party and echoed back in the response. Example: `99391c7e-ad88-49ec-a2ad-99ddcb1f7721` Format: uuid
PSU-IP-Address	string , optional	IP address of the PSU's device as forwarded by the TPP. If unavailable, use the IP address the TPP used for this request. Example: `192.168.8.78` Format: ipv4
Consent-ID	string , required	Identifier of the consent that authorises this access, as returned when the consent was created. Example: `123cons456` Allowed length: max: 70

Responses

Select a status code to see the structure and an example of the response.

Field	Type	Description
account	object , required	Details of a payment account.
bic	string , optional	The BIC associated to the account.
iban	string , required	IBAN of the account.
name	string , optional	Name of the account, assigned by the bank.
product	string , optional	Product Name of the Bank for this account, proprietary definition
balances	array[object] , optional	A balance of the account.
balanceType	string , required	The type of balance. Values are described in Balance types. Allowed values: interimAvailable
balanceAmount	object , required	The balance amount and its currency.
amount	string , required	Amount with decimal digits and a dot as the decimal separator. Example: `42.50` Pattern: ^-?[0-9]{1,14}(\.[0-9]{1,3})?$
currency	string , required	ISO 4217 Alpha 3 currency code
currency	string , required	Account currency
resourceId	string , required	Identifier used in the path to address this account — the same value as `account-id`.
cashAccountType	string , optional	ExternalCashAccountType1Code from ISO 20022 Allowed values: CACC
_links	object , optional	Links to this account's balances and transactions.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	Link to this resource.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST). Allowed values: FORMAT_ERROR, PARAMETER_NOT_CONSISTENT, PARAMETER_NOT_SUPPORTED, SERVICE_INVALID, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED, RESOURCE_BLOCKED, TIMESTAMP_INVALID, PERIOD_INVALID, SCA_METHOD_UNKNOWN, SCA_INVALID, CONSENT_TYPE_NOT_SUPPORTED, SESSIONS_NOT_SUPPORTED Example: `FORMAT_ERROR`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Only "ERROR" or "WARNING" permitted
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	Link to this resource.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED). Allowed values: CERTIFICATE_INVALID, ROLE_INVALID, CERTIFICATE_EXPIRED, CERTIFICATE_BLOCKED, CERTIFICATE_REVOKED, CERTIFICATE_MISSING, CLIENT_INVALID, CLIENT_INCONSISTENT, API_CONTRACT_ID_INVALID, SIGNATURE_INVALID, SIGNATURE_MISSING, PSU_CREDENTIALS_INVALID, CORPORATE_ID_INVALID, CONSENT_INVALID, CONSENT_EXPIRED, TOKEN_UNKNOWN, TOKEN_INVALID, TOKEN_EXPIRED Example: `CERTIFICATE_INVALID`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Only "ERROR" or "WARNING" permitted
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	Link to this resource.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN). Allowed values: SERVICE_BLOCKED, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED Example: `SERVICE_BLOCKED`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Only "ERROR" or "WARNING" permitted
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	Link to this resource.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED). Allowed values: SERVICE_INVALID Example: `SERVICE_INVALID`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Only "ERROR" or "WARNING" permitted
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	Link to this resource.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required

curl -X GET \
  "https://openfinance.saltedge.com/ria_money_transfer_sandbox/api/v2/accounts/{account-id}" \
  -H "X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721" \
  -H "Consent-ID: 123cons456"

{
  "account": {
    "bic": "ECBFDEFFFIM",
    "iban": "LT121000011101001000",
    "name": "Ria Payment Account",
    "product": "Ria Payment Account",
    "balances": [
      {
        "balanceType": "interimAvailable",
        "balanceAmount": {
          "amount": "42.50",
          "currency": "EUR"
        }
      }
    ],
    "currency": "EUR",
    "resourceId": "Text, maximum of 70 characters.",
    "cashAccountType": "CACC",
    "_links": {
      "last": {
        "href": "string"
      },
      "next": {
        "href": "string"
      },
      "self": {
        "href": "string"
      },
      "first": {
        "href": "string"
      },
      "status": {
        "href": "string"
      },
      "account": {
        "href": "string"
      },
      "balances": {
        "href": "string"
      },
      "transactions": {
        "href": "string"
      }
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "FORMAT_ERROR",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "CERTIFICATE_INVALID",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "SERVICE_BLOCKED",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "SERVICE_INVALID",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    }
  }
}

No response body.