Lively Experience API (v3) API Reference

Lively Experience API (version 3)

Contact: payactiv.it@payactiv.com
Version: v3

Campaign

Campaign

Gets the referral incentive information.

GET /api/Campaigns/GetReferralIncentiveInformation
200 OK

Success

Campaign

Gets the referrals.

GET /api/Campaigns/GetReferrals
200 OK

Success

Campaign

Saves the referral.

POST /api/Campaigns/SaveReferral
201 Created

Success

204 No Content

Success

Contract

Contract

GetContract.

GET /api/Contract/Contract/{contractType}

Gets the contract.

contractType: object
in path

Type of the contract.

200 OK

Returns the available funds for user in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Contract

GET /api/Contract/TransactionContract

200 OK

Success

Enrollment

Enrollment

Gets the state.

GET /api/Enrollments/State
referralCode: object
in query

(no description)

200 OK

Success

Enrollment

Saves the state.

POST /api/Enrollments/State
201 Created

Success

204 No Content

Success

Enrollment

Finds the user.

POST /api/Enrollments/Find
201 Created

Success

204 No Content

Success

Enrollment

Enrolls the user.

POST /api/Enrollments/Enroll
201 Created

Success

204 No Content

Success

Enrollment

Finds the and enrolled user.

POST /api/Enrollments/FindAndEnroll
201 Created

Success

204 No Content

Success

Instrument

Instrument

GetInstrumentTypes.

GET /api/Instruments/Types

GetInstrumentTypes.

200 OK

Returns the instruments info for user in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Instrument

GetInstruments.

GET /api/Instruments

GetInstruments.

200 OK

Returns the instruments info for user in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Instrument

SaveInstrumentDetail.

POST /api/Instruments

SaveInstrumentDetail

200 OK

Success

201 Created

Created for POST request. Returns the saved InstrumentDetail in payload of response.

204 No Content

No content for PUT request.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Instrument

GetInstrumentsAndTypes.

GET /api/Instruments/InstrumentsAndTypes

GetInstrumentsAndTypes.

200 OK

Returns the instruments info for user in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Instrument

GetInstrumentByID

GET /api/Instruments/{instrumentType}/{instrumentID}

GetInstrumentByID.

instrumentID: object
in path

The instrument identifier.

instrumentType: object
in path

Type of the instrument.

200 OK

Returns the InstrumentDetail in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Instrument

DeleteInstrumentDetail.

DELETE /api/Instruments/{instrumentType}/{instrumentID}

DeleteInstrumentDetail.

instrumentID: object
in path

The instrument identifier.

instrumentType: object
in path

Type of the instrument.

204 No Content

No content is returned if the instrument is deleted.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Instrument

GetInstrumentBalanceByID

GET /api/Instruments/instrumentBalance/{instrumentID}

GetInstrumentByID.

instrumentID: object
in path

The instrument identifier.

200 OK

Returns the InstrumentDetail in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Lookup

Lookup

GetBanks.

GET /api/Lookup/Banks

GetBanks.

200 OK

GetBanks

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Lookup

GetBillers.

GET /api/Lookup/Billers/{billerCategoryID}

GetBillers.

billerCategoryID: object
in path

int billerCategoryID.

200 OK

Returns the upcoming expenses of user.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Lookup

GetBillerCategories.

GET /api/Lookup/BillerCategories

GetBillerCategories.

200 OK

Returns the biller categories.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Lookup

GetEmployers.

GET /api/Lookup/Employers

GetEmployers.

recordCount: object
in query

The record count.

employerName: object
in query

Name of the employer.

200 OK

Returns the employers.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Lookup

GetPartners.

GET /api/Lookup/Partners

GetPartners.

200 OK

Returns the partners.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Pay

Pay

Get available funds for user.

GET /api/Pay/UpcomingExpenses

Gets the upcoming expenses for user.

200 OK

Returns the upcoming expenses of user.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Pay

SaveUserBiller.

POST /api/Pay/UserBiller

SaveUserBiller

201 Created

Created for POST request. Returns the saved UserData in payload of response.

204 No Content

No content for PUT request.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Pay

GetBillers.

GET /api/Pay/DueAmount/{employeeBillerID}

GetDueAmount.

employeeBillerID: object
in path

int employeeBillerID.

200 OK

Returns the due amount.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Pay

SaveUserBiller.

POST /api/Pay/UpcomingExpense

SaveUserBiller

201 Created

Created for POST request. Returns the saved UserData in payload of response.

204 No Content

No content for PUT request.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Savings

Savings

Gets the savings summary.

GET /api/Savings/SavingsSummary
200 OK

Success

Savings

Gets the safe to save details.

GET /api/Savings/SafeToSaveDetails
200 OK

Success

Savings

Saves the plan.

POST /api/Savings/SavePlan
201 Created

Success

204 No Content

Success

Savings

Updates the plan.

PUT /api/Savings/UpdatePlan
201 Created

Success

204 No Content

Success

Savings

Gets the plan.

GET /api/Savings/GetPlan
200 OK

Success

Savings

Sends the receipt.

POST /api/Savings/SendReceipt
200 OK

Success

204 No Content

Success

Status

Status

Test.

GET /api/Status/Test

Test call to the api.

200 OK

Returns the confirmation message about the status of API.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Status

Test.

GET /api/Status/Test.{format}

Test call to the api.

format: object
in path

(no description)

200 OK

Returns the confirmation message about the status of API.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Status

Clear Cache.

GET /api/Status/ClearCache

Clears the cache.

200 OK

Returns the confirmation message about the status of API.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Status

Clear Cache.

GET /api/Status/ClearCache.{format}

Clears the cache.

format: object
in path

(no description)

200 OK

Returns the confirmation message about the status of API.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Transaction

Transaction

Gets the transaction history.

POST /api/Transaction/History
200 OK

Success

204 No Content

Success

Transaction

Previews the transaction.

POST /api/Transaction/Preview
200 OK

Success

204 No Content

Success

Transaction

Performs the transaction.

POST /api/Transaction
200 OK

Success

204 No Content

Success

Transaction

Previews the recurring transaction.

POST /api/Transaction/Recurring/Preview
200 OK

Success

204 No Content

Success

Transaction

Saves the recurring transaction detail.

POST /api/Transaction/Recurring
200 OK

Success

204 No Content

Success

Transaction

Sends the receipt.

POST /api/Transaction/SendReceipt
200 OK

Success

204 No Content

Success

Transaction

Cancel.

PUT /api/Transaction/Cancel/{transactionID}

CancelTransaction.

transactionID: object
in path

The transaction identifier.

204 No Content

No content is returned if the instrument is deleted.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

Transaction

PUT /api/Transaction/CancelScheduled/{transactionID}

transactionID: object
in path

(no description)

204 No Content

Success

Transaction

POST /api/Transaction/ScheduledTransactions

200 OK

Success

User

User

Get available funds for user.

GET /api/User/Funds

Gets the available funds for user.

200 OK

Returns the available funds for user in payload of response.

400 Bad Request

Bad request. See the apiErrorString of response.

401 Unauthorized

Unauthorized. See the apiErrorString of response.

403 Forbidden

Forbidden. See the apiErrorString of response.

500 Internal Server Error

Internal server error. See the apiErrorString of response.

501 Not Implemented

Not implemented. See the apiErrorString of response.

User

Gets the startup data.

GET /api/User/ApplicationSettings
200 OK

Success

User

Saves the action.

POST /api/User/SaveAction
201 Created

Success

204 No Content

Success

User

Saves the profile.

POST /api/User/UserProfile
201 Created

Success

204 No Content

Success

User

Gets the earnings.

GET /api/User/EmployeeEarnings
200 OK

Success

User

Gets the tickers.

GET /api/User/Tickers/{tickerType}
tickerType: object
in path

Type of the ticker.

200 OK

Success

User

Gets the shortcuts.

GET /api/User/Shortcuts
200 OK

Success

User

Gets the services.

GET /api/User/DashboardServices
200 OK

Success

User

Gets the assets.

GET /api/User/Assets
200 OK

Success

User

Gets the shortcut details By id.

GET /api/User/ShortcutDetails/{shortcutId}
shortcutId: object
in path

shortcutId.

200 OK

Success

User

GET /api/User/EarningsDayWise

200 OK

Success

User

POST /api/User/DisposeTickers

201 Created

Success

204 No Content

Success

User

POST /api/User/SaveShortcut

201 Created

Success

204 No Content

Success

User

DELETE /api/User/DeleteShortcut/{shortcutID}

shortcutID: object
in path

(no description)

204 No Content

Success

Verification

Verification

Validates the phone.

POST /api/Verification/ValidatePhone
200 OK

Success

204 No Content

Success

Verification

Generates the pin.

POST /api/Verification/Generate
200 OK

Success

204 No Content

Success

Verification

Validates the pin.

POST /api/Verification/Validate
200 OK

Success

204 No Content

Success

Verification

Validates the and generate pin.

POST /api/Verification/ValidateAndGenerate
200 OK

Success

204 No Content

Success

Verification

Initiates the digital verification.

POST /api/Verification/DigitalVerification
200 OK

Success

204 No Content

Success

Verification

Gets the digital data.

POST /api/Verification/DigitalData
200 OK

Success

204 No Content

Success

Documentation by Spectacle