Skip to main content

Accounts by IDs

POST /api/v{version}/Accounts/by-ids

Description​

This endpoint is used to retrieve account details for a list of specified account IDs. The request includes an array of account IDs, and the response will return the details for each corresponding account.

Parameters​

  • version (string, path, required): The version of the API.
  • Accept-Language (string, header, optional): Change the default response message language from English (en). Available languages are fr and en.

Request Body​

  • Media Type: application/json

Example Value​

{
  "ids": [
    "string"
  ]
}

###Responses

Success Response (200)

Example Value​

{
  "succeeded": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "accountId": "string",
      "accountBIC": "string",
      "accountType": "string",
      "accountName": "string",
      "accountOwner": 1,
      "currency": "string",
      "comment": "string",
      "availableBalance": 0,
      "accountLimit": 0,
      "created": "2024-07-19T08:22:29.080Z",
      "nubanOrIban": "string",
      "purpose": "string",
      "lastTransaction": "2024-07-19T08:22:29.080Z",
      "ledgerBalance": 0,
      "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": 1,
      "clientId": "string",
      "savingsAccountId": 0,
      "productName": "string",
      "productId": "string",
      "bankName": "string",
      "onHoldFund": 0,
      "statusDescription": "string"
    }
  ]
}

Bad Request (400)​

The Bad Request (400) response indicates that the request was invalid. This may happen if required parameters are missing or invalid.

Example Value

{
  "succeeded": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": "string"
}

Not Found (404)​

The Not Found (404) response indicates that no accounts were found for the specified IDs.

Example Value

{
  "succeeded": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": "string"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  https://api.blochq.io/v1/accounts \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!