Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
balance

Create a Balance Account

Opens a balance within the specified profile, in the currency and type specified in the request.

For STANDARD balances, only one can be created per currency. For SAVINGS balances, multiple in the same currency can be opened.

When creating a SAVINGS type balance, a name is required.

post/v4/profiles/{profileId}/balances

Path parameters

profileIdinteger required

The profile ID.

Headers

X-idempotence-uuidstring uuid required

Unique identifier assigned by you. Used for idempotency check purposes. Should your call fail for technical reasons then you can use the same value again for making a retry call.

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

currencystring required

Currency code (ISO 4217 Alphabetic Code).

type'STANDARD' | 'SAVINGS' required

Type of balance account.

  • STANDARD - Standard balance account. Only one per currency per profile.
  • SAVINGS - Savings balance (Jar). Multiple allowed per currency.
namestring

Name of the balance. Required for SAVINGS type balances.

Example request

{
  "currency": "EUR",
  "type": "STANDARD"
}

Response

Created - Balance successfully created.

idinteger

Balance ID.

currencystring

Currency code (ISO 4217 Alphabetic Code).

type'STANDARD' | 'SAVINGS'

Type of balance account.

  • STANDARD - Standard balance account. Only one per currency per profile.
  • SAVINGS - Savings balance (Jar). Multiple allowed per currency.
namestring nullable

Name of the balance. Required for SAVINGS balances.

investmentState'NOT_INVESTED' | 'INVESTED' | 'INVESTING' | 'DIVESTING' | 'UNKNOWN'

Investment state of the balance.

  • NOT_INVESTED - Balance is not invested.
  • INVESTED - Balance is invested in assets.
  • INVESTING - Balance is being invested into assets.
  • DIVESTING - Balance is being divested from assets.
  • UNKNOWN - Investment state is unknown.
creationTimestring date-time

Date when the balance was created.

modificationTimestring date-time

Date when the balance was last modified.

visibleboolean

Whether the balance is visible to the user.

Example response

{
  "id": 200001,
  "currency": "EUR",
  "type": "STANDARD",
  "investmentState": "NOT_INVESTED",
  "amount": {
    "value": 310.86,
    "currency": "EUR"
  },
  "reservedAmount": {
    "currency": "EUR"
  },
  "cashAmount": {
    "value": 310.86,
    "currency": "EUR"
  },
  "totalWorth": {
    "value": 310.86,
    "currency": "EUR"
  },
  "creationTime": "2020-05-20T14:43:16.658Z",
  "modificationTime": "2020-05-20T14:43:16.658Z",
  "visible": true
}