Skip to content
/
Get points balance

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
support@sunlync.com
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Get client packages

Request

Returns a list of packages for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/clientpackages?clientnumber=stringstri'

Responses

Get Client Packages

Bodyapplicaiton/json
packagesArray of objects(clientPackageInfo)
Response
applicaiton/json
{
  "packages": [
    { … }
  ]
}

Get points balance

Request

Returns points ledger balances for a given client number

Security
BasicAuthCredentials
Query
clientnumberstringrequired
Examples:
clientnumber=0000000004
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/pointsbalance?clientnumber=string'

Responses

Client Points Ledger balance

Bodyapplicaiton/json
balancenumber(float)
Example: 10
Response
applicaiton/json
{
  "balance": 10
}

Get client points transactions

Request

Returns a list of points transactions for a given client number and date range

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
startDatestringrequired
Examples:
startDate=2025-01-01
endDatestringrequired
Examples:
endDate=2025-11-01
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/getpointstransactions?clientnumber=stringstri&startDate=string&endDate=string'

Responses

Get Points Transactions

Bodyapplicaiton/json
transactionsArray of objects(pointsTransactions)
Response
applicaiton/json
{
  "transactions": [
    { … }
  ]
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations