Get Customer Account List

POST 
/v1.2/customer/accounts

This is used to get the list of sub accounts created under a Fintech.

Only support for server token.

Request

Header Parameters

Throttle-Key string

application/json

Body

pageNo integerrequired
pageWidth integerrequired

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode integer

Find error codes here

isNextPageAvailable boolean
pageNo integer
pageWidth integer
totalNoOfRecords integer
list object[]
Array [
customerNumber string
firstName string
lastName string
passportNumber string
nin string
National identity card number
drivingLicense string
homeTel string
officeTel string
mobile string
email string
profession string
address1 string
address2 string
city string
gender string
birthDate string
nationality string
]

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "isNextPageAvailable": true,
  "pageNo": 0,
  "pageWidth": 0,
  "totalNoOfRecords": 0,
  "list": [
    {
      "customerNumber": "string",
      "firstName": "string",
      "lastName": "string",
      "passportNumber": "string",
      "nin": "string",
      "drivingLicense": "string",
      "homeTel": "string",
      "officeTel": "string",
      "mobile": "string",
      "email": "string",
      "profession": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "gender": "string",
      "birthDate": "string",
      "nationality": "string"
    }
  ]
}

example

{
  "status": "SUCCESS",
  "reason": "successfully retrieved customer details",
  "rejectCode": 0,
  "isNextPageAvailable": true,
  "pageNo": 10,
  "pageWidth": 10,
  "totalNoOfRecords": 874,
  "list": [
    {
      "customerNumber": "ASI876133082",
      "firstName": "Fname",
      "lastName": "Lname",
      "passportNumber": "23422",
      "nin": "963214547",
      "drivingLicense": "1234564765",
      "homeTel": "+94112410225",
      "officeTel": "+94112410225",
      "mobile": "+94112410225",
      "email": "[email protected]",
      "profession": "SE",
      "address1": "No 1, colombo road",
      "address2": "colombo 02",
      "city": "kollupitiya",
      "gender": "Male",
      "birthDate": "1990/02/25",
      "nationality": "376"
    },
    {
      "customerNumber": "ASI635120470",
      "firstName": "Fname",
      "lastName": "Lname",
      "passportNumber": "23422",
      "nin": "963265147",
      "drivingLicense": "1234564765",
      "homeTel": "+94112410225",
      "officeTel": "+94112410225",
      "mobile": "+94112410225",
      "email": "[email protected]",
      "profession": "SE",
      "address1": "No 1, colombo road",
      "address2": "colombo 02",
      "city": "kollupitiya",
      "gender": "Male",
      "birthDate": "1990/02/25",
      "nationality": "1"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.2/customer/accounts",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.2/customer/accounts",
  "rejectCode": "1007"
}

Loading...