1. Documentation
  2. Onboarding
  3. Integration
  4. API

Workflow Manager REST API

The Workflow Manager REST API provides endpoints to initiate workflows such as for onboarding and to query for the status of previously initiated workflows.

Release notes

1.0.0

  • Support for onboard workflow for onboarding terminals
  • Integration with AEVI CloudFlow, AEVI SmartPOS (DMS) and AEVI TMS (GemView).

Documentation & Downloads

The APIs are defined and documented using OpenAPI / Swagger. Below is a table of links to API documentation and Swagger downloads for import into tools such as Postman or other HTTP clients.

Version Documentation Swagger yaml
1.0.0 View Download

Case sensitivity

Note that all fields and parameters used in the Onboarding API are case sensitive.

Endpoints

POST initiate

Initiate a new workflow.

The body of the request must specify the following mandatory fields for the API to identify the correct flow to execute.

  • partnerId => Provided by AEVI to represent a partner/client of the API
  • type => The type of flow to execute, such as onboard for onboarding
  • format => The format of the request data
  • contextData => The request data, bespoke to the type and format provided

Additionally, merchantAcquirerId can optionally be specified where required.

See the relevant integration guides for further information about the data models based on the flow type and format.

GET status

Retrieve the status of a previously initiated workflow.

This returns information about the outcome of the overall flow as well as the outcome of each individual stage the flow executed.

HTTP error codes

Any errors as a result of calling a HTTP endpoint will return a status code and a response body, as per the below format:

{
    "errorMessage": "someMessage",
    "errorCode": "someErrorCode"
}

Below is a table of the various errors.

HTTP status code Error code Description
400 failed Unexpected failure
401 unauthorized Missing or invalid Authorization bearer token
403 forbidden The operation attempted is not allowed
404 notFound The item requested or referenced does not exist
409 duplicateItem The item can not be created as it already exists
410 connectionLost The target the request was intended for is not available
412 preconditionFailed The operation attempted can not be carried out due to existing preconditions
417 storageFailed The item could not be persisted
422 invalidData The request is missing required data or the data defined is invalid