Skip to content
/
Insert client comment

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

Update billing info

Request

Update billing info for a client

  • membershipId identifiies the membership the billing account is associated with
  • type must be one of the following values

    • CARD Credit card type, must include lastFour, expMonth, expYear. and tokenId. vaultToken is recommened when using the Cayan processor but is not reqruired.

    • CHECKING Checking account type, must include accountNo and routingNo

  • deductType must be a value returned by getEFTDeductTypes endpoint
Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipIdstring
Example: "0000000999"
typestring
Example: "CARD"
deductTypestring
Example: "Visa"
lastFourstring
Example: "0026"
expMonthstring
Example: "08"
expYearstring
Example: "2029"
tokenIdstring
Example: "123456789"
vaultTokenstring
Example: "1234abcd6789"
accountNostring
Example: "1234567890"
routingNostring
Example: "123456789"
nameOnAccountstring
Example: "John Doe"
billingAddressstring
Example: "1 Main St"
billingCitystring
Example: "Buffalo"
billingStatestring
Example: "NY"
billingZipstring
Example: "14220"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/updatebillinginfo \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipId": "0000000999",
    "type": "CARD",
    "deductType": "Visa",
    "lastFour": "0026",
    "expMonth": "08",
    "expYear": "2029",
    "tokenId": "123456789",
    "vaultToken": "1234abcd6789",
    "accountNo": "1234567890",
    "routingNo": "123456789",
    "nameOnAccount": "John Doe",
    "billingAddress": "1 Main St",
    "billingCity": "Buffalo",
    "billingState": "NY",
    "billingZip": "14220"
  }'

Responses

Update billing info for a client

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

Insert client comment

Request

Inserts a client comment

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
employeeNumberstring
Example: "0000000001"
commentstring
Example: "This is a test comment"
showAtPosinteger
Example: 0
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertcomment \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "employeeNumber": "0000000001",
    "comment": "This is a test comment",
    "showAtPos": 0
  }'

Responses

Inserts a client comment

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

Insert client membership

Request

Inserts a client membership

  • storecode is the storecode of the store location
  • empNo is the employee number of the employee inserting the client
  • drawDay must be value returned by the getEFTDrawDays endpoint
Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipNumberstring
Example: "0000000001"
storecodestring
Example: "0000000001"
employeeNumberstring
Example: "0000000001"
drawDaystring
Example: "01"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertMembership \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipNumber": "0000000001",
    "storecode": "0000000001",
    "employeeNumber": "0000000001",
    "drawDay": "01"
  }'

Responses

Inserts a client membership

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

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations