get business account details

GET /api/v1/BusinessAccounts/:id/get

Description

This endpoint allows you to retrieve details of a business account by its ID.

Request

• Path Parameters:

  • id: The ID of the business account to retrieve (string, format: uuid)

  • version: API version (string)

• Headers:

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

Responses

• 200: Success. Returns an AccountResponse.

• 400: Bad Request. The request is not valid.

• 404: Not Found. The requested resource was not found.

Examples

Request

httpCopy codeGET /api/v{version}/BusinessAccounts/1234-5678-91011-21314/get HTTP/1.1
Host: example.com
Accept-Language: en

Response

httpCopy codeHTTP/1.1 200 OK
{
  "accountId": "1234-5678-91011-21314",
  "name": "Example Business",
  "industry": "Technology",
  "email": "example@example.com",
  "phone": "+123456789",
  "address": {
    "street": "123 Example Street",
    "city": "Exampleville",
    "state": "Ex",
    "country": "Exampleland",
    "zip": "12345"
  },
  "status": "ACTIVE",
  "createdDate": "2024-02-16T09:00:00Z"
}

Error Response

httpCopy codeHTTP/1.1 404 Not Found
{
  "message": "Resource not found."
}

/api/v`{{version}}`/BusinessAccounts/:id/get

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": <boolean>,
  "message": <string>,
  "errors": [
    <string>,
    <string>
  ],
  "data": {
    "id": <uuid>,
    "ownerId": <uuid>,
    "accountId": <string>,
    "accountBIC": <string>,
    "accountType": <string>,
    "accountName": <string>,
    "accountOwner": 1,
    "currency": <string>,
    "comment": <string>,
    "availableBalance": <double>,
    "accountLimit": <double>,
    "created": <dateTime>,
    "nubanOrIban": <string>,
    "purpose": <string>,
    "lastTransaction": <dateTime>,
    "ledgerBalance": <double>,
    "tenantId": <uuid>,
    "status": 4,
    "clientId": <string>,
    "savingsAccountId": <integer>,
    "productName": <string>,
    "productId": <string>,
    "bankName": <string>,
    "onHoldFund": <double>,
    "statusDescription": <string>
  }
}

Response: 400

{
  "succeeded": <boolean>,
  "message": <string>,
  "errors": [
    <string>,
    <string>
  ],
  "data": <string>
}

Response: 404

{
  "succeeded": <boolean>,
  "message": <string>,
  "errors": [
    <string>,
    <string>
  ],
  "data": <string>
}