Get all person account

GET /api/v1/PersonAccounts/get-all

Description

This endpoint is used to retrieve all person accounts based on provided query parameters.

Tags:
PersonAccounts

URL:
/api/v{version}/PersonAccounts/get-all

ApiKey:
No API key required

Content-Type:
None

Query Parameters:

• PersonId (string, optional, uuid): The ID of the person.

• TenantId (string, optional, uuid): The ID of the tenant.

• SearchText (string, optional): Text to search for in account details.

• Descending (boolean, optional): Sort accounts in descending order if true.

• Status (AccountStatus, optional): Status of the account. Available values: Pending, Approved, Rejected, Expired.

• PageNumber (integer, required): Page number for pagination (starting from 1).

• PageSize (integer, required): Number of items per page.

Path Parameters:

• version (string, required): The API version.

Request Body:
None

Response:
Success, returns a paged list of person accounts.

Error Codes:
None

Example:

/api/v1/PersonAccounts/get-all?PersonId=<uuid>&TenantId=<uuid>&SearchText=<string>&Descending=<boolean>&Status=1&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
PersonId	<uuid>
TenantId	<uuid>
SearchText	<string>
Descending	<boolean>
Status	1
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "personId": `<uuid>`,
    "accountId": `<string>`,
    "accountBIC": `<string>`,
    "accountType": `<string>`,
    "accountName": `<string>`,
    "currency": `<string>`,
    "availableBalance": `<double>`,
    "accountLimit": `<double>`,
    "statusDescription": `<string>`,
    "created": `<dateTime>`,
    "nubanOrIban": `<string>`,
    "purpose": `<string>`,
    "comment": `<string>`,
    "status": `<string>`,
    "productId": `<string>`,
    "clientId": `<string>`
  }
}