Retrieve an account

GET 
/api/accounts/:id

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."

Request

Path Parameters

id stringrequired

Account identifier

Responses

200

OK - The request was processed successfully.

application/json

Schema

Schema

id integer
type string

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

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
]

Example (from schema)

{
  "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"
    }
  ]
}

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

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

403

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

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

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

404

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

application/json

Schema

Schema

title stringnullable

A short, human-readable summary of the problem.

detail stringnullable

A human-readable explanation specific to this occurrence of the problem.

status numbernullable

Default value: 400

instance stringnullable

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

type string

A URI reference that identifies the problem type

Example (from schema)

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

Loading...