Retrieve an account

This API endpoint is used to retrieve comprehensive details about an account. It serves as a valuable tool for accessing specific account data within your system, given the presence of fields like "currency," "availableBalance," and "forecastedBalance."

Path Parameters

• id string required

  Account identifier

Responses

• 200
• 401
• 403
• 404

---

OK - The request was processed successfully.

application/json

• Schema
• Example (from schema)

---

Schema

• id integer
• type string

  Possible values: [normal, collateral, guarantee, escrow]

• currency string
• baseCurrency string
• availableBalance number
• baseCurrencyBalance number
• forecastedBalance number
• ibans object[]

  Array [

  type string

  Possible values: [normal, qr]

  value string

  Can be IBAN or account number. If the first 2 characters are letters, it is an IBAN, otherwise, an account number.

  routingType string

  routingCode string

  ]

{
  "id": 1,
  "type": "normal",
  "currency": "CHF",
  "baseCurrency": "CHF",
  "availableBalance": "1000.00",
  "baseCurrencyBalance": "1000.00",
  "forecastedBalance": "950.00",
  "ibans": [
    {
      "type": "normal",
      "value": "DE89370400440532013000",
      "routingType": "BLZ",
      "routingCode": "37040044"
    }
  ]
}

Unauthorised -- Your access token is wrong.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Forbidden -- Access to the requested resource or action is forbidden.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Not Found -- The requested resource could not be found.

Loading...