When used behind another backend, as a proxy, Syllo provides following benefits:

• Syllo abstraction layer enables the backend to use the same API methods and data structure for several diferent vendors
• Syllo will aggregate data from multiple vendors and proxy it in a generalized format back to the backend
• The transaction parsing service in Syllo parses the realtime transaction data and proxies it back to the backend
• The Syllo's event service notifies the backend when any asynchronous action happens
• The Syllo's database stores data in a PCI compliant manner
• If needed, Syllo exposes direct access to vendor services by proxying the request from the backend to the vendor directly. A secure secrets storage is used in order to store API keys and other credentials to avoid having them transferred between the customer's backend and the Syllo

The Syllo API authenticates users by using username-password credentials and issuing an access token. Access token should be sent in headers of all subsequent calls:

Authoroziation: Bearer {access_token}

All responses received from the Syllo API comply to a specific structure:

{
  "code": number,
  "success": boolean,
  "errors": Error[]
  "data": Map<string, object>
}

• code

  Code field represent status of the response. For successful responses the code is always 200.

• success

  Success boolean field returns status of the operation.

• data

  Data object returns actual data returned by the API.

• errors

  Errors key stores all errors which happened during the execution of the request. Usually empty array ([]) for successful API calls.

All erros are implementing following data structure:

{
  "message": string,
  "code": number,
  "name": string,
  "payload": Map<string, object>|null
}

• message

  A user-readable message.

• code

  Code representing an error.

• name

  Textual representation of the error, eg "INVALID_USERNAME_OR_PASSWORD"

• payload

  If required, error can contain some payload which may help with identifying the offending field or pinpointing the exact issue.

If API needs to return paginated data, following structure is used:

{
  "success": boolean,
  "data": {
    "items": [],
    "meta": {
      "itemCount": number,
      "totalItems": number,
      "itemsPerPage": number,
      "totalPages": number,
      "currentPage": number
    }
  }
}

Contains routes for logging in and out.

Contains endpoints for organisation management.

Contains endpoints for organisation unit management

Contains endpoints for organisation roles management.

Operate on users.

Admin account routes.

Admin payment Device routes.

Transaction routes releated to admin management.

System report endpoints.