v1

latestOpenAPI 3.1.02026-07-226250251.5 KB

Catalogue

List Account Purposes

Retrieve a list of available account purposes

get/v1/purposes

Query parameters

per_pageinteger

Number of items to return per page

current_pageinteger

The page number to retrieve

type'INDIVIDUAL' | 'BUSINESS' required

Filter account purposes by type

Response

List of account purposes retrieved successfully

Example response

{
  "data": {
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total_page": 1,
      "total": 10
    },
    "purposes": [
      {
        "id": 1,
        "title": "Personal Savings"
      }
    ]
  }
}