Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Workflows

Create a new workflow

put/workflows

Request body

idstring

The internal identifier of the schedule. Required only for updates.

templateIdstring

The internal id of the template to be used for defining the schedule. Can be used in place of defining individual events for a schedule; in this case, the events will be automatically copied from the template. This streamlines the process and ensures consistency across schedules.

namestring

The name of the schedule to be created for the customer. It must contain only alphanumeric characters, and be limited to a maximum of 50 characters.

type'ONE_TIME_PAYMENT' | 'DD_MANDATE_AUTHORISATION' | 'DD_PAYMENT' | 'CUSTOMER_STATEMENT' required

The type of the schedule to be created for the customer

customMessagestring

The (optional) custom message to be added to notification

Example request

{
  "customerDetails": {
    "id": "80349480-490b-4234-92e7-fad697e3d446"
  }
}

Response

The request was successful, resulting in the creation of one workflow.

idstring required

The internal id of the workflow created

templateIdstring

The internal id of the template used to define the workflow. This template id has been utilized to automatically copy events into the instance, streamlining the process and ensuring consistency throughout

namestring

The name of the workflow created for the customer

type'ONE_TIME_PAYMENT' | 'DD_MANDATE_AUTHORISATION' | 'DD_PAYMENT' | 'CUSTOMER_STATEMENT' required

Attribute that specifies the type of workflow

state'DRAFT' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'COMPLETED' | 'TERMINATED' required

The current state of the workflow

paymentInitiationDatestring date-time

The payment initiation date of Auto Collect workflows

creationTimestring date-time required

The creation time of the workflow

lastUpdatedTimestring date-time

Last time the workflow was updated

autopilotReasoningstring

The overall strategy reasoning provided by the LLM, present only for autopilot workflows

Example response

{
  "customerDetails": {
    "id": "80349480-490b-4234-92e7-fad697e3d446"
  },
  "settings": [
    {
      "customerDetails": {
        "id": "80349480-490b-4234-92e7-fad697e3d446"
      }
    }
  ],
  "workflowSettings": {
    "reminderSettings": [
      {
        "customerDetails": {
          "id": "80349480-490b-4234-92e7-fad697e3d446"
        }
      }
    ]
  }
}