Syllo exposes a set of API methods ready for direct usage by mobile/web applications. Those method provide basic functionality required by front-ends to be able to build a user friendly UX/UI with following funcitonalities:

• Authentication
• KYC
• Customer data management
• Creating of accounts and ordering of payment devices (cards, wearables)
• Activation, locking/unlocking, show/change PIN on payment devices
• Transaction display with spending analytics
• Real-time push notifications for every transaction
• P2P payments

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 API calls require for user registration.

User routes.

Describes API endpoints related to authorization confirmation and challenges.

Contains endpoints for organisation management.

Contains endpoints for organisation unit management

Contains endpoints for organisation roles management.

KYC verification. KYC stands for Know Your Customer.

Account routes.