Skip to content
/
Insert payment

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 communication preferences

Request

Update client communication preferences

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
doNotSolicitinteger
Example: 0
emailinteger
Example: 1
cellTextinteger
Example: 1
cellVoiceinteger
Example: 1
homeVoiceinteger
Example: 1
workVoiceinteger
Example: 1
mailinteger
Example: 1
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/updateclientcommpref \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "doNotSolicit": 0,
    "email": 1,
    "cellText": 1,
    "cellVoice": 1,
    "homeVoice": 1,
    "workVoice": 1,
    "mail": 1
  }'

Responses

Updated communication preferences successfully

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

Insert payment

Request

Inserts a payment

  • Transaction must be saved first
  • Receipt number is returned when inserting transaction
Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
paymentNumberstring
Example: "0000000001"
promoNumberstring
Example: ""
storecodestring
Example: "0000000001"
receiptNumberstring
Example: "0000000001"
employeeNumberstring
Example: "00000000001"
amountnumber(float)
Example: 9.99
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertpayment \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "paymentNumber": "0000000001",
    "promoNumber": "",
    "storecode": "0000000001",
    "receiptNumber": "0000000001",
    "employeeNumber": "00000000001",
    "amount": 9.99
  }'

Responses

Payment inserted

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

Insert transaction

Request

Inserts a transaction

  • Supported transaction types:
    • R = Retail Sale (productNumber is required)
    • P = Package Sale (packageId is required)
    • M = Membership Sale (membershipId is required)
    • 1 = Membership Fee (membershipId is required)
    • G = Gift Certificate Sale (giftCertNo is required)
  • Amount is total for line item before tax (pricePerUnit * units)
  • Receipt number is returned and can be used when inserting a payment
Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
storecodestring
Example: "0000000001"
employeeNumberstring
Example: "00000000001"
lineItemsArray of objects
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/inserttransaction \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "storecode": "0000000001",
    "employeeNumber": "00000000001",
    "lineItems": [
      {
        "tranType": "R",
        "description": "Lotion",
        "pricePerUnit": 19.99,
        "units": 2,
        "tax1": 2,
        "tax2": 0,
        "tax3": 0,
        "amount": 39.98,
        "membershipId": "",
        "packageId": "",
        "productNumber": "0000000001",
        "giftCertNo": ""
      }
    ]
  }'

Responses

Payment inserted

Bodyapplicaiton/json
messagestring
Example: "Transaction inserted successfully"
receiptNostring
Example: "0000000020"
Response
applicaiton/json
{
  "message": "Transaction inserted successfully",
  "receiptNo": "0000000020"
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations