Config for pesapal

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

{
  "consumer_key": "GA2PNftcXvv2uC2VdgNjxXyvF8eZ4td6iBsL7N7N2ZFnXzf3",
  "consumer_secret": "zKjr2j0jjihCtzIwzGtgnV0YgP82jZf1hY9RW6HygntWG6AGuf4tAUe3E5tPtiyA"
}

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",
          "description": "The base URL (https://pay.pesapal.com)",
          "format": "uri",
          "minLength": 1,
          "default": "https://pay.pesapal.com",
          "examples": [
              "https://pay.pesapal.com",
              "https://cybaq.pesapal.com"
          ]
      },
      "consumer_key": {
          "title": "Consumer key",
          "type": "string",
          "description": "Your app's consumer key sent to you via email once you go live",
          "examples": [
              "GA2PNftcXvv2uC2VdgNjxXyvF8eZ4td6iBsL7N7N2ZFnXzf3"
          ]
      },
      "consumer_secret": {
          "title": "Consumer key",
          "type": "string",
          "description": "Your app's consumer secret sent to you via email once you go live",
          "examples": [
              "zKjr2j0jjihCtzIwzGtgnV0YgP82jZf1hY9RW6HygntWG6AGuf4tAUe3E5tPtiyA"
          ]
      },
      "apiVersion": {
          "title": "Api Version",
          "type": "string",
          "placeholder": "v3",
          "description": "Pesapal api version",
          "default": "v3",
          "examples": [
              "v3",
              "pesapalv3"
          ]
      },
      "access_token": {
          "title": "Access Token",
          "type": "string",
          "description": "Your Pesapal access token",
          "examples": [
              "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "consumer_key",
      "consumer_secret"
  ]
}