Skip to main content

Config for mtn-momo

Jobs that use the mtn-momo adaptor may require authentication. A "credential" for the mtn-momo adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "api_key": "630ee209443d787927b08b3c57902",
  "api_user": "630ee209443d787927b08b3c57902",
  "subscription_key": "630ee209443d787927b08b3c57902",
  "baseUrl": "https://sandbox.momodeveloper.mtn.com/"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "baseUrl": {
          "title": "Base URL",
          "anyOf": [
              {
                  "type": "string"
              },
              {
                  "type": "null"
              }
          ],
          "description": "",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://sandbox.momodeveloper.mtn.com/"
          ]
      },
      "subscription_key": {
          "title": "subscription Key",
          "type": "string",
          "description": "The subscription key is part of the header of all requests sent to the API Manager",
          "examples": [
              "630ee209443d787927b08b3c57902"
          ]
      },
      "api_key": {
          "title": "API Key",
          "type": "string",
          "description": "",
          "writeOnly": true,
          "examples": [
              "630ee209443d787927b08b3c57902"
          ]
      },
      "api_user": {
          "title": "API User",
          "type": "string",
          "description": "",
          "writeOnly": true,
          "examples": [
              "630ee209443d787927b08b3c57902"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "api_key",
      "api_user",
      "subscription_key",
      "baseUrl"
  ]
}