{"_id":"5b8ec6a1f8dd7c0003386005","category":{"_id":"5b8ec6a1f8dd7c0003385faa","version":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b19742cb3baf90003cab5ae","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b8ec6a1f8dd7c0003385fa2","5b8ec6a1f8dd7c0003385fa3","5b8ec6a1f8dd7c0003385fa4","5b8ec6a1f8dd7c0003385fa5","5b8ec6a1f8dd7c0003385fa6","5b8ec6a1f8dd7c0003385fa7","5b8ec6a1f8dd7c0003385fa8","5b8ec6a1f8dd7c0003385fa9","5b8ec6a1f8dd7c0003385faa","5b8ec6a1f8dd7c0003385fab","5b8ec6a1f8dd7c0003385fac"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-24T18:31:55.516Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":32,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`custom-param-title`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Title of the custom parameter.\",\n    \"1-0\": \"`active`\",\n    \"1-1\": \"*boolean*\",\n    \"1-3\": \"Determines whether this parameter is active or not.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"Optional\",\n    \"3-0\": \"`custom-param-settings`\",\n    \"3-1\": \"container\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"Container of [custom-param-settings](doc:custom-param-settings) properties.\",\n    \"2-0\": \"`mandatory`\",\n    \"2-1\": \"*boolean*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Determines whether this parameter is mandatory or not.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`custom-param-title`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"Title of the custom parameter.\",\n    \"3-0\": \"`custom-param-settings`\",\n    \"3-1\": \"container\",\n    \"3-2\": \"Container of [custom-param-settings](doc:custom-param-settings) properties.\",\n    \"1-0\": \"`active`\",\n    \"2-0\": \"`mandatory`\",\n    \"1-1\": \"*boolean*\",\n    \"2-1\": \"*boolean*\",\n    \"1-2\": \"Determines whether this parameter is active or not.\",\n    \"2-2\": \"Determines whether this parameter is mandatory or not.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"custom-parameter","type":"basic","title":"custom-parameter"}

Request

Property Name
Type
Required
Description

custom-param-title

string

Required

Title of the custom parameter.

active

boolean

Optional

Determines whether this parameter is active or not.

mandatory

boolean

Optional

Determines whether this parameter is mandatory or not.

custom-param-settings

container

Required

Container of custom-param-settings properties.

Response

Property Name
Type
Description

custom-param-title

string

Title of the custom parameter.

active

boolean

Determines whether this parameter is active or not.

mandatory

boolean

Determines whether this parameter is mandatory or not.

custom-param-settings

container

Container of custom-param-settings properties.