Schema for Moneta Provider Settings

From ProviderSettings.schema.yaml (moneta/ProviderSettings.schema)

---
$id: https://skeleton.botmd.io/moneta/ProviderSettings.schema
$schema: http://json-schema.org/draft-07/schema#4

title: Provider Settings
description: "`ProviderApplication.provider_settings` are used to store provider-specific settings such as API keys."

oneOf:
  - $ref: "#/definitions/HitPay"
  - $ref: "/skeleton/Empty.schema"
#end oneOf

definitions:
  HitPay:
    title: HitPay
    description: Settings for HitPay.

    type: object
    additionalProperties: false
    required: [hitpay]

    properties:
      hitpay:
        type: object
        additionalProperties: false
        required: [api_key, base_url, salt]

        properties:
          base_url:
            title: Base URL
            description: Base URL for API calls including trailing slash if present. See [HitPay Setup](https://hit-pay.com/docs.html#setup).
            type: string
            format: uri
            minLength: 1

          api_key:
            title: API key
            description: API key to authenticate requests which can be found in `Settings > Payment Gateway > API Keys`.
            type: string
            minLength: 1

          salt:
            title: Salt
            description: The HMAC key for the signature generation is the secret `salt` from your dashboard under `Settings > Payment Gateway > API Keys`.
            type: string
            minLength: 1
      #end hitpay
    #end properties
  #end HitPay
#end definitions

[Main Page] [Schema Documentation] [Examples]