Create a client account

Parameters

namestringrequired

The account name.

currencyenumrequired

The account's currency.

ISO 4217 3 character currency code.

Note: Lune does not support all currency codes.

Enum:

beneficiarystring

The account beneficiary. Leading and trailing spaces are removed.

handlestring^[a-z0-9-_]+$

handle is a client defined URL-friendly string that identifies the account.

The handle is unique per organisation and account type.

external_pages_visibilityenum

Enum to control the visibility of external pages such as sustainability and analytics pages.

Enum:

public
hidden

Returns

Returns: ClientAccount object

idstringrequired

The Account's unique identifier

namestringrequired

The Account's name

organisation_idstringrequired

The unique identifier of the organisation this account belongs to

handlestring^[a-z0-9-_]+$required

handle is a client defined URL-friendly string that identifies the account.

The handle is unique per organisation and account type.

currencyenumrequired

The account's currency.

ISO 4217 3 character currency code.

Note: Lune does not support all currency codes.

Enum:

typeenumrequired

The account's type.

Enum:

live
test

logostringrequired

The account logo

beneficiarystringrequired

Retirement beneficiary

This is the name that appears on future retirements that are made in this account. If none is present, the organisation beneficiary will be used instead.

bundle_portfolio_idstringrequired

Bundle portfolio id tied to the account.

external_pages_visibilityenumrequired

Enum to control the visibility of external pages such as sustainability and analytics pages.

Enum:

public
hidden

POST /accounts/client

curl 'https://api.lune.co/v1/accounts/client' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -X POST \
  -d '{
    "name": "ACME",
    "beneficiary": "ACME Inc",
    "currency": "USD"
  }'

Response

{
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "name": "ACME",
  "beneficiary": "ACME Inc",
  "currency": "USD",
  "type": "live",
  "organisation_id": "VndoQ0PZjGMzvYOZGwqy6kbgN1eOJx9B",
  "logo": null,
  "bundle_portfolio_id": null
}