Skip to content

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
Overview
API Support
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Shares an affiliated package

Request

Shares an affiliated package

Security
BasicAuthCredentials
Bodyapplication/json
membershipIdstring
Example: "0000000001"
sharedClientNumberstring
Example: "0000000002"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/shareaffiliatedpackage \
  -H 'Content-Type: application/json' \
  -d '{
    "membershipId": "0000000001",
    "sharedClientNumber": "0000000002"
  }'

Responses

Package shared successfully

Bodyapplicaiton/json
messagestring
Example: ""
Response
applicaiton/json
{ "message": "" }

Unshares an affiliated package

Request

Unshares an affiliated package

Security
BasicAuthCredentials
Bodyapplication/json
membershipIdstring
Example: "0000000001"
sharedClientNumberstring
Example: "0000000002"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/unshareaffiliatedpackage \
  -H 'Content-Type: application/json' \
  -d '{
    "membershipId": "0000000001",
    "sharedClientNumber": "0000000002"
  }'

Responses

Package unshared successfully

Bodyapplicaiton/json
messagestring
Example: ""
Response
applicaiton/json
{ "message": "" }

Cancel membership

Request

Cancels an active eft membership

Security
BasicAuthCredentials
Bodyapplication/json
membershipIdstring
Example: "0000000001"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/cancelmembership \
  -H 'Content-Type: application/json' \
  -d '{
    "membershipId": "0000000001"
  }'

Responses

Membership cancelled

Bodyapplicaiton/json
messagestring
Example: "Membership cancelled successfully"
membershipIdstring
Example: "0000000001"
lastDrawDatestring(date)
Example: "2025-08-01"
expirationDatestring(date)
Example: "2025-08-31"
Response
applicaiton/json
{ "message": "Membership cancelled successfully", "membershipId": "0000000001", "lastDrawDate": "2025-08-01", "expirationDate": "2025-08-31" }

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations