providers

Version 0.1.03 operations

Enabled providers with their credential schemas (fields, never values)

GET/providers

Parameters

No parameters.

Responses

200
- codestringrequired
- namestringrequired
- enabledbooleanrequired
- capabilitiesProviderCapabilitiesDtorequired
  - initbooleanrequired
  - statusbooleanrequired
  - callbackbooleanrequired
  - refundbooleanrequired
  - statementbooleanrequired
  - verifyCredentialsbooleanrequired
- credentialSchemaCredentialFieldDto[]required
  - namestringrequired
  - labelstringrequired
  - typestringrequired
    - enum: "text", "password", "select"
  - secretbooleanrequired
    Secret fields are encrypted at rest and never returned by the API.
  - helpstring
  - optionsstring[]
- onboardingGuideOnboardingGuideDtorequired
  - selfstringrequired
    Markdown: steps when the merchant applies directly to the provider.
  - viaKonnectstringrequired
    Markdown: steps when Konnect handles the application.
  - delaystringrequired
  - linksOnboardingLinkDto[]required
    - labelstringrequired
    - urlstringrequired
- settlementInfostring | null

Code samples

curl -X GET "$KONNECT_API_URL/providers"

Example: 200

[
  {
    "code": "clictopay",
    "name": "ClicToPay",
    "enabled": true,
    "capabilities": {
      "init": true,
      "status": true,
      "callback": true,
      "refund": true,
      "statement": true,
      "verifyCredentials": true
    },
    "credentialSchema": [
      {
        "name": "userName",
        "label": "Affiliation login",
        "type": "text",
        "secret": true,
        "help": "help",
        "options": [
          "string"
        ]
      }
    ],
    "onboardingGuide": {
      "self": "self",
      "viaKonnect": "viaKonnect",
      "delay": "5 to 10 working days",
      "links": [
        {
          "label": "label",
          "url": "url"
        }
      ]
    },
    "settlementInfo": "settlementInfo"
  }
]

One enabled provider

GET/providers/{code}

Parameters

codestringpathrequired

Responses

200
- codestringrequired
- namestringrequired
- enabledbooleanrequired
- capabilitiesProviderCapabilitiesDtorequired
  - initbooleanrequired
  - statusbooleanrequired
  - callbackbooleanrequired
  - refundbooleanrequired
  - statementbooleanrequired
  - verifyCredentialsbooleanrequired
- credentialSchemaCredentialFieldDto[]required
  - namestringrequired
  - labelstringrequired
  - typestringrequired
    - enum: "text", "password", "select"
  - secretbooleanrequired
    Secret fields are encrypted at rest and never returned by the API.
  - helpstring
  - optionsstring[]
- onboardingGuideOnboardingGuideDtorequired
  - selfstringrequired
    Markdown: steps when the merchant applies directly to the provider.
  - viaKonnectstringrequired
    Markdown: steps when Konnect handles the application.
  - delaystringrequired
  - linksOnboardingLinkDto[]required
    - labelstringrequired
    - urlstringrequired
- settlementInfostring | null
404Unknown or disabled provider

Code samples

curl -X GET "$KONNECT_API_URL/providers/code"

Example: 200

{
  "code": "clictopay",
  "name": "ClicToPay",
  "enabled": true,
  "capabilities": {
    "init": true,
    "status": true,
    "callback": true,
    "refund": true,
    "statement": true,
    "verifyCredentials": true
  },
  "credentialSchema": [
    {
      "name": "userName",
      "label": "Affiliation login",
      "type": "text",
      "secret": true,
      "help": "help",
      "options": [
        "string"
      ]
    }
  ],
  "onboardingGuide": {
    "self": "self",
    "viaKonnect": "viaKonnect",
    "delay": "5 to 10 working days",
    "links": [
      {
        "label": "label",
        "url": "url"
      }
    ]
  },
  "settlementInfo": "settlementInfo"
}

Konnect admin: update the published view (enabled, onboardingGuide, settlementInfo)

PATCH/providers/{code}Dashboard session

Capabilities and credential schema come from the connector and are synced at boot; they cannot be set here. Requires a Konnect admin session.

Parameters

codestringpathrequired

Request body application/json

enabledboolean
onboardingGuideOnboardingGuideDto
- selfstringrequired
  Markdown: steps when the merchant applies directly to the provider.
- viaKonnectstringrequired
  Markdown: steps when Konnect handles the application.
- delaystringrequired
- linksOnboardingLinkDto[]required
  - labelstringrequired
  - urlstringrequired
settlementInfostring | null

Responses

200
- codestringrequired
- namestringrequired
- enabledbooleanrequired
- capabilitiesProviderCapabilitiesDtorequired
  - initbooleanrequired
  - statusbooleanrequired
  - callbackbooleanrequired
  - refundbooleanrequired
  - statementbooleanrequired
  - verifyCredentialsbooleanrequired
- credentialSchemaCredentialFieldDto[]required
  - namestringrequired
  - labelstringrequired
  - typestringrequired
    - enum: "text", "password", "select"
  - secretbooleanrequired
    Secret fields are encrypted at rest and never returned by the API.
  - helpstring
  - optionsstring[]
- onboardingGuideOnboardingGuideDtorequired
  - selfstringrequired
    Markdown: steps when the merchant applies directly to the provider.
  - viaKonnectstringrequired
    Markdown: steps when Konnect handles the application.
  - delaystringrequired
  - linksOnboardingLinkDto[]required
    - labelstringrequired
    - urlstringrequired
- settlementInfostring | null
400Invalid body or a field the connector owns
403Not a Konnect admin
404Unknown provider

Code samples

curl -X PATCH "$KONNECT_API_URL/providers/code" \
  -H "Cookie: konnect_session=$KONNECT_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "onboardingGuide": {
    "self": "self",
    "viaKonnect": "viaKonnect",
    "delay": "5 to 10 working days",
    "links": [
      {
        "label": "label",
        "url": "url"
      }
    ]
  },
  "settlementInfo": "settlementInfo"
}'

Example: request body

{
  "enabled": true,
  "onboardingGuide": {
    "self": "self",
    "viaKonnect": "viaKonnect",
    "delay": "5 to 10 working days",
    "links": [
      {
        "label": "label",
        "url": "url"
      }
    ]
  },
  "settlementInfo": "settlementInfo"
}

Example: 200

{
  "code": "clictopay",
  "name": "ClicToPay",
  "enabled": true,
  "capabilities": {
    "init": true,
    "status": true,
    "callback": true,
    "refund": true,
    "statement": true,
    "verifyCredentials": true
  },
  "credentialSchema": [
    {
      "name": "userName",
      "label": "Affiliation login",
      "type": "text",
      "secret": true,
      "help": "help",
      "options": [
        "string"
      ]
    }
  ],
  "onboardingGuide": {
    "self": "self",
    "viaKonnect": "viaKonnect",
    "delay": "5 to 10 working days",
    "links": [
      {
        "label": "label",
        "url": "url"
      }
    ]
  },
  "settlementInfo": "settlementInfo"
}