retrieves the balances of a deposit account by its code.

HEAD 
/Deposits/accounts/:code/Balances

retrieves the balances of a deposit account by its code.

Request

Path Parameters

code stringrequired

Query Parameters

api-version string

Header Parameters

X-Request-ID stringrequired

Responses

200

application/json

Schema

Schema

accountId int32required

Internal account identifier.

availableBalance decimalrequired

Available balance of the account.

bookBalance decimalrequired

Book or ledger balance of the account.

blockBalance decimalrequired

Blocked or reserved amount on the account.

overdraftBalance decimalrequired

Overdraft balance or overdraft limit used.

currency stringrequired

Account currency code.

lastInterestPostingDate date-timenullablerequired

Date of last interest posting.

Example (from schema)

{
  "accountId": 0,
  "availableBalance": 0,
  "bookBalance": 0,
  "blockBalance": 0,
  "overdraftBalance": 0,
  "currency": "string",
  "lastInterestPostingDate": "2024-07-29T15:51:28.071Z"
}

404

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...