hypercharge-schema 1.24.5

data/json/sale.json

@@ -0,0 +1,77 @@
+{
+  "description" : "Hypercharge sale Transaction request",
+  "type":"object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "additionalProperties":false,
+  "properties": {
+    "payment_transaction": {
+      "type":"object",
+      "required":true,
+      "additionalProperties":false,
+      "properties": {
+        "transaction_type": {
+          "description": "Type of the Transaction => static 'sale'",
+          "required":true,
+          "type" : "string",
+          "pattern" : "^sale$"
+        },
+        "transaction_id": {
+          "required":true,
+          "extends" : "types.json#/transaction_id"
+        },
+        "usage": {
+          "required":false,
+          "extends" : "types.json#/usage"
+        },
+        "remote_ip": {
+          "required":true,
+          "extends": "types.json#/ipv4"
+        },
+        "amount": {
+          "required":true,
+          "extends" : "types.json#/amount"
+        },
+        "currency": {
+          "required":true,
+          "extends" : "types.json#/currency"
+        },
+        "card_holder": {
+          "required":true,
+          "extends" : "types.json#/card_holder"
+        },
+        "expiration_month" : {
+          "required":true,
+          "extends" : "types.json#/expiration_month"
+        },
+        "expiration_year": {
+          "required":true,
+          "extends" : "types.json#/expiration_year"
+        },
+        "customer_email": {
+          "required":true,
+          "extends" : "types.json#/customer_email"
+        },
+        "customer_phone" : {
+          "required":false,
+          "extends" : "types.json#/customer_phone"
+        },
+        "card_number" : {
+          "required":true,
+          "extends" : "types.json#/card_number"
+        },
+        "cvv" : {
+          "required":false,
+          "extends" : "types.json#/cvv"
+        },
+        "billing_address": {
+          "required": true,
+          "extends": "types.json#/address"
+        },
+        "risk_params" : {
+          "required": false,
+          "extends": "types.json#/risk_params"
+        }
+      }
+    }
+  }
+}

data/json/sale3d.json

@@ -0,0 +1,173 @@
+{
+   "description":"Hypercharge sale3d Transaction request",
+   "type":[
+      {
+         "type":"object",
+         "$schema":"http://json-schema.org/draft-03/schema",
+         "additionalProperties":false,
+         "properties":{
+            "payment_transaction":{
+               "type":"object",
+               "required":true,
+               "additionalProperties":false,
+               "properties":{
+                  "transaction_type":{
+                     "description":"Type of the Transaction => static 'sale3d'",
+                     "required":true,
+                     "type":"string",
+                     "pattern":"^sale3d$"
+                  },
+                  "transaction_id":{
+                     "required":true,
+                     "extends":"types.json#/transaction_id"
+                  },
+                  "usage":{
+                     "required":false,
+                     "extends":"types.json#/usage"
+                  },
+                  "remote_ip":{
+                     "required":true,
+                     "extends":"types.json#/ipv4"
+                  },
+                  "amount":{
+                     "required":true,
+                     "extends":"types.json#/amount"
+                  },
+                  "currency":{
+                     "required":true,
+                     "extends":"types.json#/currency"
+                  },
+                  "card_holder":{
+                     "required":true,
+                     "extends":"types.json#/card_holder"
+                  },
+                  "expiration_month":{
+                     "required":true,
+                     "extends":"types.json#/expiration_month"
+                  },
+                  "expiration_year":{
+                     "required":true,
+                     "extends":"types.json#/expiration_year"
+                  },
+                  "customer_email":{
+                     "required":true,
+                     "extends":"types.json#/customer_email"
+                  },
+                  "customer_phone":{
+                     "required":false,
+                     "extends":"types.json#/customer_phone"
+                  },
+                  "card_number":{
+                     "required":true,
+                     "extends":"types.json#/card_number"
+                  },
+                  "cvv":{
+                     "required":false,
+                     "extends":"types.json#/cvv"
+                  },
+                  "billing_address":{
+                     "required":true,
+                     "extends":"types.json#/address"
+                  },
+                  "risk_params":{
+                     "required":false,
+                     "extends":"types.json#/risk_params"
+                  },
+                  "notification_url":{
+                     "required":true,
+                     "extends":"types.json#/url"
+                  },
+                  "return_success_url":{
+                     "required":true,
+                     "extends":"types.json#/url"
+                  },
+                  "return_failure_url":{
+                     "required":true,
+                     "extends":"types.json#/url"
+                  }
+               }
+            }
+         }
+      },
+      {
+         "type":"object",
+         "$schema":"http://json-schema.org/draft-03/schema",
+         "additionalProperties":false,
+         "properties":{
+            "payment_transaction":{
+               "type":"object",
+               "required":true,
+               "additionalProperties":false,
+               "properties":{
+                  "transaction_type":{
+                     "description":"Type of the Transaction => static 'sale3d'",
+                     "required":true,
+                     "type":"string",
+                     "pattern":"^sale3d$"
+                  },
+                  "transaction_id":{
+                     "required":true,
+                     "extends":"types.json#/transaction_id"
+                  },
+                  "usage":{
+                     "required":false,
+                     "extends":"types.json#/usage"
+                  },
+                  "remote_ip":{
+                     "required":true,
+                     "extends":"types.json#/ipv4"
+                  },
+                  "amount":{
+                     "required":true,
+                     "extends":"types.json#/amount"
+                  },
+                  "currency":{
+                     "required":true,
+                     "extends":"types.json#/currency"
+                  },
+                  "card_holder":{
+                     "required":true,
+                     "extends":"types.json#/card_holder"
+                  },
+                  "expiration_month":{
+                     "required":true,
+                     "extends":"types.json#/expiration_month"
+                  },
+                  "expiration_year":{
+                     "required":true,
+                     "extends":"types.json#/expiration_year"
+                  },
+                  "customer_email":{
+                     "required":true,
+                     "extends":"types.json#/customer_email"
+                  },
+                  "customer_phone":{
+                     "required":false,
+                     "extends":"types.json#/customer_phone"
+                  },
+                  "card_number":{
+                     "required":true,
+                     "extends":"types.json#/card_number"
+                  },
+                  "cvv":{
+                     "required":false,
+                     "extends":"types.json#/cvv"
+                  },
+                  "billing_address":{
+                     "required":true,
+                     "extends":"types.json#/address"
+                  },
+                  "risk_params":{
+                     "required":false,
+                     "extends":"types.json#/risk_params"
+                  },
+                  "mpi_params":{
+                     "required":true,
+                     "extends":"types.json#/mpi_params"
+                  }
+               }
+            }
+         }
+      }
+   ]
+}

data/json/scheduler_create.json

@@ -0,0 +1,46 @@
+{
+  "description" : "Hypercharge RecurringSchedule create request",
+  "type":"object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "additionalProperties":false,
+  "properties": {
+    "payment_transaction_unique_id": {
+      "description": "The Transaction to create the RecurringSchedule for. The Transaction type must be init_recurring_authorize, init_recurring_sale, init_recurring_debit_sale or init_recurring_debit_authorize",
+      "required":true,
+      "extends" : "types.json#/unique_id"
+    },
+    "amount": {
+      "description" : "Amount of the payment in cents, must be > 0",
+      "required":true,
+      "extends" : "types.json#/amount"
+    },
+    "start_date": {
+      "description":"Start date to begin with scheduling transactions",
+      "required":true,
+      "extends" : "types.json#/date"
+    },
+    "end_date": {
+      "description":"End date to stop with scheduling transactions",
+      "extends" : "types.json#/date"
+    },
+    "interval" : {
+      "required":true,
+      "extends" : "types.json#/recurring_schedule/properties/interval"
+    },
+    "max_retries": {
+      "extends" : "types.json#/recurring_schedule/properties/max_retries"
+    },
+    "expiring_notification_time": {
+      "description": "hypercharge sends merchant a notification x Days before end_date",
+      "type" : "integer",
+      "minimum": 1,
+      "maximum": 100,
+      "exclusiveMinimum": false,
+      "exclusiveMaximum": false
+    },
+    "active":{
+      "description": "true: Scheduler is on. false: Scheduler is turned off but still visible.",
+      "extends" : "types.json#/boolean"
+    }
+  }
+}

data/json/scheduler_index.json

@@ -0,0 +1,34 @@
+{
+  "description" : "Hypercharge get params for GET /v2/scheduler",
+  "type":"object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "additionalProperties":false,
+  "properties": {
+    "page": {
+      "extends" : "types.json#/page"
+    },
+    "per_page": {
+      "extends" : "types.json#/per_page"
+    },
+    "start_date_from": {
+      "description": "schedulers where start_date >= start_date_from",
+      "extends" : "types.json#/date"
+    },
+    "start_date_to": {
+      "description": "schedulers where start_date <= start_date_to",
+      "extends" : "types.json#/date"
+    },
+    "end_date_from": {
+      "description": "schedulers where end_date >= end_date_from",
+      "extends" : "types.json#/date"
+    },
+    "end_date_to": {
+      "description": "schedulers where end_date <= end_date_to",
+      "extends" : "types.json#/date"
+    },
+    "active":{
+      "description": "schedulers where active = true|false; true: Scheduler is on. false: Scheduler is turned off but still visible.",
+      "extends" : "types.json#/boolean"
+    }
+  }
+}

data/json/scheduler_update.json

@@ -0,0 +1,35 @@
+{
+  "description" : "Hypercharge RecurringSchedule update request",
+  "type":"object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "additionalProperties":false,
+  "properties": {
+    "amount": {
+      "extends" : "types.json#/amount"
+    },
+    "start_date": {
+      "extends" : "types.json#/date"
+    },
+    "end_date": {
+      "extends" : "types.json#/date"
+    },
+    "interval" : {
+      "extends" : "types.json#/recurring_schedule/properties/interval"
+    },
+    "max_retries": {
+      "extends" : "types.json#/recurring_schedule/properties/max_retries"
+    },
+    "expiring_notification_time": {
+      "description": "hypercharge sends merchant a notification x Days before end_date",
+      "type" : "integer",
+      "minimum": 1,
+      "maximum": 100,
+      "exclusiveMinimum": false,
+      "exclusiveMaximum": false
+    },
+    "active":{
+      "description": "true: Scheduler is on. false: Scheduler is turned off but still visible.",
+      "extends" : "types.json#/boolean"
+    }
+  }
+}

data/json/types.json

@@ -0,0 +1,385 @@
+{
+  "description" : "Hypercharge API types",
+  "type":"object",
+  "unique_id": {
+    "description": "id generated by Hypercharge",
+    "type": "string",
+    "pattern" : "^[a-f0-9]{32}$"
+  },
+  "reference_id": {
+    "description": "references an other transaction. contains the foreign unique_id",
+    "type": "string",
+    "pattern" : "^[a-f0-9]{32}$"
+  },
+  "amount": {
+    "description" : "Amount of the payment in cents, must be > 0",
+    "type" : "integer",
+    "minimum": 1,
+    "exclusiveMinimum": false
+  },
+  "currency": {
+    "description" : "Currency code in ISO 4217 (http://www.xe.com/iso4217.php)",
+    "type" : "string",
+    "enum" : ["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZM",
+    "AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD",
+    "BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","RSD",
+    "CUP","CVE","CYP","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB",
+    "EUR","FJD","FKP","GBP","GEL","GGP","GHC","GHS","GIP","GMD","GNF","GTQ",
+    "GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR",
+    "ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD",
+    "KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL",
+    "MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR",
+    "MZM","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK",
+    "PHP","PKR","PLN","PYG","QAR","ROL","RON","RUB","RWF","SAR","SBD","SCR",
+    "SDD","SDG","SEK","SGD","SHP","SIT","SKK","SLL","SOS","SPL","SRD","STD",
+    "SVC","SYP","SZL","THB","TJS","TMM","TND","TOP","TRY","TTD","TVD","TWD",
+    "TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XAG",
+    "XAU","XCD","XDR","XOF","XPD","XPF","YER","ZAR","ZMK","ZWD"]
+  },
+  "transaction_id": {
+    "description" : "unique merchant generated transaction_id",
+    "type" : "string",
+    "pattern" : "^[\\w\\s_\\-\\.]{1,255}$"
+  },
+  "usage": {
+    "description" : "statement, as it appears in the customer’s bank statement",
+    "type" : "string",
+    "minLength": 1,
+    "maxLength": 255
+  },
+  "customer_email": {
+    "description" : "the customer’s e-mail address",
+    "type" : "string",
+    "pattern": "^([^@\\s]+)@((?:[-a-zA-Z0-9]+\\.)+[a-zA-Z]{2,})$"
+  },
+  "customer_phone" : {
+    "description" : "the customer’s phone number",
+    "type" : "string",
+    "minLength": 1,
+    "maxLength": 255
+  },
+  "url" : {
+    "description" : "a valid url",
+    "type" : "string",
+    "pattern": "^http(s)?.{4,}"
+  },
+  "ipv4" : {
+    "description" : "a valid IPv4 address",
+    "type" : "string",
+    "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$"
+  },
+  "card_holder": {
+    "description" : "Full name of customer as printed on credit card (first name and last name at least)",
+    "type" : "string",
+    "minLength": 1,
+    "maxLength": 255
+  },
+  "expiration_month": {
+    "description" : "Expiration month as printed on credit card. format MM",
+    "type" : "string",
+    "pattern": "^(0?[1-9]|1[0-2])$"
+  },
+  "expiration_year": {
+    "description" : "Expiration year as printed on credit card. format YYYY",
+    "type" : "string",
+    "pattern": "^20\\d\\d$"
+  },
+  "card_number" : {
+    "description" : "complete cc number of customer. 13 to 16 digits",
+    "type" : "string",
+    "pattern": "^\\d{13,16}$"
+  },
+  "cvv" : {
+    "description" : "cvv of cc. 3 to 4 digits",
+    "type" : "string",
+    "pattern": "^\\d{3,4}$"
+  },
+
+  "wire_reference_id" : {
+    "description" : "Wire reference id for the transaction to show up on the bank statement",
+    "type": "string",
+    "minLength": 1,
+    "maxLength": 10
+  },
+  "bank_account_holder" : {
+    "description" : "name of the bank account holder",
+    "type": "string",
+    "minLength": 1,
+    "maxLength": 255
+  },
+  "bank_account_number" : {
+    "description" : "customers bank account number",
+    "type": "string",
+    "minLength": 1,
+    "maxLength": 16
+  },
+  "bank_number" : {
+    "description" : "customers bank number",
+    "type": "string",
+    "minLength": 1,
+    "maxLength": 16
+  },
+  "bank_name" : {
+    "description": "Banknames for IdealSale",
+    "type" : "string",
+    "enum": ["ABN_AMRO", "POSTBANK", "RABOBANK", "FORTIS", "FORTIS_TEST", "SNS_BANK"]
+  },
+  "date": {
+    "description":"Date of format 'YYYY-MM-DD' e.g. '2014-05-24'",
+    "type":"string",
+    "pattern":"^20\\d{2}-(0|1)\\d-(0|1|2|3)\\d$"
+  },
+
+  "address": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties" : {
+      "first_name" : {
+        "description" : "the customers first name",
+        "type" : "string",
+        "required": true,
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "last_name" : {
+        "description" : "the customers first name",
+        "type" : "string",
+        "required": true,
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "address1" : {
+        "description" : "first line of address",
+        "type" : "string",
+        "required": true,
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "address2" : {
+        "description" : "second line of address",
+        "type" : "string",
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "city" : {
+        "description" : "the customers city",
+        "type" : "string",
+        "required": true,
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "zip_code" : {
+        "description" : "the customers city",
+        "type" : "string",
+        "required": true,
+        "minLength": 1,
+        "maxLength": 32
+      },
+      "state" : {
+        "required": false,
+        "description" : "state code in ISO 3166-2, only needed for USA and Canada",
+        "type" : "string",
+        "enum": ["AA", "AE", "AK", "AL", "AP", "AR", "AS", "AZ", "CA", "CO",
+        "CT", "DC", "DE", "FL", "FM", "GA", "GU", "HI", "IA", "ID", "IL",
+        "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MH", "MI", "MN", "MO",
+        "MP", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY",
+        "OH", "OK", "OR", "PA", "PR", "PW", "RI", "SC", "SD", "TN", "TX",
+        "UT", "VA", "VI", "VT", "WA", "WI", "WV", "WY", "AB", "BC", "MB",
+        "NB", "NF", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT"]
+      },
+      "country": {
+        "required": true,
+        "description" : "country code in ISO 3166-1 (alpha-2), http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2",
+        "type" : "string",
+        "enum": ["FR", "SA", "CI", "KZ", "LC", "IE", "AE", "TW", "ES", "EH",
+        "MY", "BJ", "PW", "JP", "GR", "PL", "MN", "PA", "MC", "SM", "IQ",
+        "SB", "CU", "OM", "UA", "ET", "KP", "AF", "HR", "NC", "KE", "TM",
+        "QA", "MZ", "PM", "MO", "SY", "MD", "SN", "GH", "DJ", "CV", "IR",
+        "VA", "SC", "RO", "FI", "NZ", "CK", "AR", "BW", "NO", "AG", "TN",
+        "PY", "MP", "BA", "SZ", "GT", "TC", "PN", "SO", "GI", "DK", "UY",
+        "IS", "SD", "FJ", "CL", "AS", "KR", "TZ", "HT", "RE", "NP", "CA",
+        "BM", "NE", "KG", "TO", "GU", "TD", "MQ", "BB", "VN", "IT", "VC",
+        "SE", "LR", "UZ", "CM", "AT", "FK", "ZW", "HU", "BY", "AI", "BN",
+        "NF", "KH", "MR", "ZA", "MG", "DM", "PE", "CY", "LS", "CN", "AU",
+        "BZ", "NR", "ZM", "KI", "HK", "BO", "NG", "MS", "BD", "GW", "SR",
+        "GL", "PF", "MH", "LT", "VE", "SG", "GA", "CZ", "FM", "CO", "LI",
+        "CD", "TR", "TG", "DZ", "PR", "EC", "MT", "BE", "DO", "PG", "GM",
+        "SH", "GB", "LU", "AW", "IL", "UG", "AL", "NI", "GY", "TH", "MU",
+        "BF", "WF", "ST", "GN", "PH", "YE", "SI", "DE", "LV", "VG", "LK",
+        "US", "RU", "FO", "NU", "CF", "KW", "AM", "TT", "HN", "BR", "EE",
+        "MV", "BG", "PT", "JM", "MK", "SJ", "GD", "CR", "IN", "CG", "AN",
+        "LA", "BS", "WS", "KM", "BH", "TJ", "MW", "ML", "SV", "GP", "MA",
+        "VI", "SK", "GE", "AZ", "RW", "ID", "CH", "KY", "AO", "LB", "BT",
+        "NL", "KN", "AD", "TV", "ER", "TK", "EG", "MX", "BI", "NA", "MM",
+        "VU", "JO", "GQ", "PK", "SL", "GF", "LY"]
+      }
+    }
+  },
+  "expires_in": {
+    "description" : "The acceptable ”time-to-live” in seconds between the merchant’s creation of a payment and the customer’s interaction. This can be set to anything between 5 minutes and 24 hours",
+    "type" : "integer",
+    "minimum": 300,
+    "maximum": 86400,
+    "exclusiveMinimum": false,
+    "exclusiveMaximum": false
+  },
+  "retries": {
+    "description" : "The acceptable payment retries for the customers if a transaction failed.",
+    "type" : "integer",
+    "minimum": 1,
+    "exclusiveMinimum": false
+  },
+  "risk_params" : {
+    "description" : "set of risk params as described in the Advanced risk management with RiskParams section",
+    "type" : "object",
+    "additionalProperties": false,
+    "properties":{
+      "ssn":{
+        "type": ["string", "number"],
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "mac_address":{
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "session_id":{
+        "type": ["string", "number"],
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "user_id":{
+        "type": ["string", "number"],
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "user_level":{
+        "type": ["string", "number"],
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "email":{
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "phone":{
+        "type": ["string", "number"],
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "remote_ip":{
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "serial_number":{
+        "type": ["string", "number"],
+        "minLength": 1,
+        "maxLength": 128
+      },
+      "infocapture_token":{
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 128
+      }
+    }
+  },
+  "recurring_schedule":{
+    "description":"Recurring Schedule",
+    "type":"object",
+    "$schema":"http://json-schema.org/draft-03/schema",
+    "additionalProperties":false,
+    "properties":{
+      "start_date":{
+        "description":"Start date to begin with recurring",
+        "required":true,
+        "extends": "#/date"
+      },
+      "end_date":{
+        "description":"End date to stop the recurring schedule",
+        "extends": "#/date"
+      },
+      "amount":{
+        "required":true,
+        "extends": "#/amount"
+      },
+      "interval":{
+        "description": "recurring interval. must be one of weekly, monthly, anually",
+        "required" : true,
+        "type" : "string",
+        "enum": ["weekly", "monthly", "anually"]
+      },
+      "max_retries":{
+        "description" : "number of times to retry the rebilling before giving up",
+        "type" : "integer",
+        "minimum": 0,
+        "maximum": 10,
+        "exclusiveMinimum": false,
+        "exclusiveMaximum": false
+      }
+    }
+  },
+  "mpi_params": {
+    "description": "required if an authorize3d or sale3d transaction should be handled synchronous",
+    "type":"object",
+    "required":true,
+    "additionalProperties": false,
+    "properties": {
+      "cavv":{
+        "description": "Verification Id of the authentication. Please note this can be the CAVV for Visa Card or UCAF to identify MasterCard",
+        "type": "string",
+        "required":true,
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "eci":{
+        "description": "Electric Commerce Indicator as retured from the MPI.",
+        "type": "string",
+        "required":true,
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "xid":{
+        "description": "Transaction ID generated by the 3D Secure service that uniquely identifies a 3D Secure check request",
+        "type": "string",
+        "required":true,
+        "minLength": 1,
+        "maxLength": 255
+      }
+    }
+  },
+  "transaction_types": {
+    "description" : "For WpfPayment and MobilePayment. The transaction types that the merchant is willing to accept payments for",
+    "type" : "array",
+    "minItems": 1,
+    "items": {
+      "enum" : ["authorize", "authorize3d", "sale", "sale3d", "init_recurring_sale",
+      "ideal_sale", "debit_sale", "sepa_debit", "direct_pay24_sale",
+      "giro_pay_sale", "pay_safe_card_sale", "init_recurring_authorize",
+      "purchase_on_account", "pay_in_advance", "deposit", "payment_on_delivery",
+      "pay_pal", "init_recurring_debit_sale", "init_recurring_debit_authorize",
+      "recurring_debit_sale", "barzahlen_sale"]
+    }
+  },
+  "page": {
+      "description": "pagination: the result set page to show",
+      "type": "integer",
+      "minimum":1,
+      "maximum": 100000,
+      "exclusiveMinimum": false,
+      "exclusiveMaximum": false
+  },
+  "per_page": {
+    "description" : "pagination: the count of entries per page",
+    "type": "integer",
+    "minimum":1,
+    "maximum": 1000,
+    "exclusiveMinimum": false,
+    "exclusiveMaximum": false
+  },
+  "boolean": {
+    "enum": [true, false, 0, 1]
+  }
+}