v2

latestSwagger 2.02026-08-0610101.9 MB

Bank accounts

List bank accounts

Yields a list of all bank accounts under the control of this Organization.

get/v0/organizations/{organization-id}/bank/accounts

Path parameters

organization-idstring required

Query parameters

filter[account-restricted][eq]boolean

Specifies whether the bank account has restrictions applied by Griffin.

filter[beneficiary-url][eq]string

Link to the legal person that represents the beneficiary of the account.

page[size]integer

includestring[]

For each bank account returned, include its owner and/or beneficiary in the response under the included.legal-persons attribute.

filter[account-status][in][]string[]

sort'-created-at' | 'display-name' | 'created-at' | '-display-name'

page[after]string byte

A base64 encoded opaque string returned in paginated responses.

filter[pooled-funds][eq]boolean

Specifies whether the bank account holds funds belonging to multiple beneficiaries.

filter[bank-product-type][in][]string[]

filter[owner-url][eq]string

Link to the legal person that represents the owner of the account.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

{"stackTrail":"paths:/v0/organizations/{organization-id}/bank/accounts:get:responses:200:content:application/json:schema:properties:included","oasType":"schema","type":"unknown","title":"","description":"Present only when the request uses the `include` parameter."}

Example response

{
  "accounts": [
    {
      "display-name": "Reserve a/c",
      "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
      "accrued-interest": {
        "currency": "GBP",
        "value": "1000.00"
      },
      "available-balance": {
        "currency": "GBP",
        "value": "1000.00"
      },
      "bank-addresses": [
        {
          "bank-id": "123456",
          "account-number": "12345678"
        }
      ],
      "account-balance": {
        "currency": "GBP",
        "value": "1000.00"
      }
    }
  ]
}