Paytronix · JSON Structure

Server Api Create And Register Request Structure

CreateAndRegisterRequest schema from Paytronix Server API

Type: object Properties: 7 Required: 3
RestaurantLoyaltyGift CardsOnline OrderingGuest EngagementPaymentsMessaging

CreateAndRegisterRequest is a JSON Structure definition published by Paytronix, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

merchantId cardTemplateCode enforceUniqueFields setUserFields setAccountFields sendSmsVerification smsVerificationCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paytronix/refs/heads/main/json-structure/server-api-create-and-register-request-structure.json",
  "name": "CreateAndRegisterRequest",
  "description": "CreateAndRegisterRequest schema from Paytronix Server API",
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "int32",
      "example": 1000
    },
    "cardTemplateCode": {
      "type": "string",
      "example": "1"
    },
    "enforceUniqueFields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "email"
      ]
    },
    "setUserFields": {
      "type": "object",
      "additionalProperties": true,
      "example": {
        "username": "jdoe",
        "password": "s3cret",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane@example.com"
      }
    },
    "setAccountFields": {
      "type": "object",
      "additionalProperties": true
    },
    "sendSmsVerification": {
      "type": "boolean"
    },
    "smsVerificationCode": {
      "type": "string"
    }
  },
  "required": [
    "merchantId",
    "cardTemplateCode",
    "setUserFields"
  ]
}