Skip to main content

Config for monnify

Jobs that use the monnify adaptor may require authentication. A "credential" for the monnify 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.

{
"baseUrl": "https://sandbox.monnify.com",
"apiKey": "MK_TEST_YRP3AJ7RQ2",
"secretKey": "JKML52W7XQ43L02VRFDNQ8KLAU459W8B"
}

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": "The base URL",
"format": "uri",
"minLength": 1,
"examples": [
"https://sandbox.monnify.com"
]
},
"apiKey": {
"title": "API Key",
"type": "string",
"description": "This is required together with your secret key to generate your bearer token",
"examples": [
"MK_TEST_YRP3AJ7RQ2"
]
},
"secretKey": {
"title": "Secret key",
"type": "string",
"description": "The secret key is used to authorize all your API calls on Monnify.",
"writeOnly": true,
"examples": [
"JKML52W7XQ43L02VRFDNQ8KLAU459W8B"
]
}
},
"type": "object",
"additionalProperties": true,
"required": [
"baseUrl",
"apiKey",
"secretKey"
]
}