flow test - monetplus/IDport GitHub Wiki

Method and instance management

This section documents API callbacks for management of methods and instances, i.e. manual un/blocking, deactivating.

  • SMS, ACTIVATION_CODE - auto-activated single-instance methods, i.e. instance is activated with method activation and method can only have one instance
  • PASSWORD - single-instance method, i.e. method can only have one instance, activate instance is deactivated if new one is activated
  • CM - multi-instance method, i.e. there can be more active instances of a method

State of the method is prioritized over state of the instance. State change of the method does not influence state of its instance(s) and vice versa, the only exception is that with method activation all usable instances are deactivated. You must have active method and active instance to be able to authorize transactions.

  1. Get method information IAPI/methodInfo
  2. Block instance IAPI/blockInstance
  3. Unblock instance IAPI/unblockInstance
  4. Deactivate instance IAPI/deactivateInstance
  5. Block method IAPI/blockMethod
  6. Unblock method IAPI/unblockMethod
  7. Deactivate method IAPI/deactivateMethod

Get method information

  • get information about state and blocking rules of specified method types
  • used parameters:
Parameter Description Optional Value example
methodTypes array of types of used methods false ["PASSWORD"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/methodInfo
POST http://${BASE_URL}/case-iapi/v1/methodInfo
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodTypes": [
    "PASSWORD"
  ]
}
{
  "status": "success",
  "data": {
    "methodInfo": [
      {
        "methodType": "PASSWORD",
        "state": "ACTIVE",
        "activeInstances": 0,
        "instances": [],
        "failedAttempts": 0,
        "remainingAttempts": 3
      }
    ]
  }
}

Block instance

  • manually block specified instance
  • method state remains unchanged
  • used parameters:
Parameter Description Optional Value example
instanceId instance identifier false PASSWORD:cg2t1:nL6ZlKzC06ecUQV9yQs7ghx37jgutgwa
methodType type of used method false ["PASSWORD","ACTIVATION_CODE","SMS","CM"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/blockInstance
POST http://${BASE_URL}/case-iapi/v1/blockInstance
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodType": "PASSWORD",
  "instanceId": "PASSWORD:cg2t1:20785b01-6d2b-4016-b2e4-a8185be3cb28"
}
{
  "status": "success",
  "data": {}
}

Unblock instance

  • unblock specified instance
  • method state remains unchanged
  • used parameters:
Parameter Description Optional Value example
instanceId instance identifier false PASSWORD:cg2t1:nL6ZlKzC06ecUQV9yQs7ghx37jgutgwa
methodType type of used method false ["PASSWORD","ACTIVATION_CODE","SMS","CM"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/unblockInstance
POST http://${BASE_URL}/case-iapi/v1/unblockInstance
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodType": "PASSWORD",
  "instanceId": "PASSWORD:cg2t1:20785b01-6d2b-4016-b2e4-a8185be3cb28"
}
{
  "status": "success",
  "data": {}
}

Deactivate instance

  • deactivate specified instance
  • deactivated instance cannot be re-activated
  • method state remains unchanged
  • used parameters:
Parameter Description Optional Value example
instanceId instance identifier false PASSWORD:cg2t1:nL6ZlKzC06ecUQV9yQs7ghx37jgutgwa
methodType type of used method false ["PASSWORD","ACTIVATION_CODE","SMS","CM"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/deactivateInstance
POST http://${BASE_URL}/case-iapi/v1/deactivateInstance
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodType": "PASSWORD",
  "instanceId": "PASSWORD:cg2t1:20785b01-6d2b-4016-b2e4-a8185be3cb28"
}
{
  "status": "success",
  "data": {}
}

Block method

  • manually block method
  • instances state remains unchanged but their usage is limited
  • used parameters:
Parameter Description Optional Value example
methodType type of used method false ["PASSWORD","ACTIVATION_CODE","SMS","CM"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/blockMethod
POST http://${BASE_URL}/case-iapi/v1/blockMethod
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodType": "PASSWORD"
}
{
  "status": "success",
  "data": {}
}

Unblock method

  • unblock method
  • instances state remains unchanged
  • used parameters:
Parameter Description Optional Value example
methodType type of used method false ["PASSWORD","ACTIVATION_CODE","SMS","CM"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/unblockMethod
POST http://${BASE_URL}/case-iapi/v1/unblockMethod
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodType": "PASSWORD"
}
{
  "status": "success",
  "data": {}
}

Deactivate method

  • deactivate method
  • all usable instances are deactivated
  • used parameters:
Parameter Description Optional Value example
methodType type of used method false ["PASSWORD","ACTIVATION_CODE","SMS","CM"]
muid user identifier false cg2t1
tenant organisation name, if not supplied, default value from configuration is taken true Monet+
  • REST API callback: IAPI/deactivateMethod
POST http://${BASE_URL}/case-iapi/v1/deactivateMethod
{
  "tenant": "Monet+",
  "muid": "cg2t1",
  "methodType": "PASSWORD"
}
{
  "status": "success",
  "data": {}
}