Sign in

099ef636a5a1

latestOpenAPI 3.0.12026-08-0660121245.3 KB
Accounts

Index accounts

Returns all accounts (both personal & business) managed under a partner.

get/v1/accounts

Query parameters

page[number]string

Returns a specific page of results.

page[size];integer

Determines the size of each page of results.The maximum value is 200

filter[type]string

Filters the returned accounts by type.

filter[iban]string

Filters the returned accounts by IBAN.

filter[id]string

Filters the returned accounts by ID

Response

The operation was successful.

idstring

ID of the account.

ibanstring

IBAN associated with the account.

bicstring

BIC associated with the account.

type'CHECKING_PERSONAL' | 'CHECKING_BUSINESS'

Type of the account.

locking_status'NO_BLOCK' | 'CREDIT_BLOCK' | 'DEBIT_BLOCK' | 'BLOCK'

Read-only booking block indicating whether funds can be transferred to/from the account. The default status is NO_BLOCK. Other status values indicate that funds may neither be credited to, nor debited from, the account. Only authorized Solaris employees can change the status of this value. Attempting to perform an action not compliant with the current blocking status (e.g., initiating a transaction to or from a blocked account) will cause either a return of the transaction or an exception.

locking_reasonsstring[]

Read-only indicator of the reason a block was applied to the account. If the account is not blocked, then this value will contain an empty array.

person_idstring

ID of the person for whom the account was created.

business_idstring

ID of the business for whom the account was created. Only filled if the account owner is a legal entity.

Example response

[
  {
    "id": "5526853938474f3e92b22a03ea57a544cacc",
    "iban": "DE76110101001100000999",
    "bic": "SOBKDEBBXXX",
    "type": "CHECKING_PERSONAL",
    "person_id": "bb66a0161a0a4066abfe133412f6236dcper",
    "business_id": "a9a25dc10aa74244bd0bb75d1ce6b3b5cbiz",
    "overdraft": {
      "rate": 12.5,
      "limit": 10000
    }
  }
]