Skip to content
/
Update billing info

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 client demographics

Request

Field is only updated if a value is passed

Security
BasicAuthCredentials
Bodyapplication/json
clientnumberstring
Example: "0000000002"
firstNamestring
Example: "John"
lastNamestring
Example: "Doe"
middleInitstring
Example: "D"
address1string
Example: "1 Main st"
address2string
Example: "Suite 10"
citystring
Example: "Buffalo"
statestring
Example: "NY"
zipstring
Example: "14220"
homePhonestring
Example: "7165551234"
workPhonestring
Example: "7165555678"
cellPhonestring
Example: "7165550987"
emailstring
Example: "test@test.com"
dobstring(date)
Example: "1980-12-25"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/updatedemographics \
  -H 'Content-Type: application/json' \
  -d '{
    "clientnumber": "0000000002",
    "firstName": "John",
    "lastName": "Doe",
    "middleInit": "D",
    "address1": "1 Main st",
    "address2": "Suite 10",
    "city": "Buffalo",
    "state": "NY",
    "zip": "14220",
    "homePhone": "7165551234",
    "workPhone": "7165555678",
    "cellPhone": "7165550987",
    "email": "test@test.com",
    "dob": "1980-12-25"
  }'

Responses

Inserts a client

Bodyapplicaiton/json
clientNumberstring
Example: "0000000001"
messagestring
Example: "Client updated successfully"
Response
applicaiton/json
{
  "clientNumber": "0000000001",
  "message": "Client updated successfully"
}

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": ""
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations