{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"custom-param-settings","type":"basic","slug":"custom-param-settings","excerpt":"","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`short-text-type`\",\n    \"1-1\": \"container\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Container of [short-text-type](doc:short-text-type) properties.\",\n    \"2-0\": \"`visual-settings`\",\n    \"2-1\": \"container\",\n    \"2-3\": \"Container of [visual-settings](doc:visual-settings) properties.\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"Optional\",\n    \"2-2\": \"Optional\",\n    \"3-1\": \"container\",\n    \"4-1\": \"container\",\n    \"3-0\": \"`fixed-selection-type`\",\n    \"4-0\": \"`merchant-value-type`\",\n    \"3-2\": \"Optional\",\n    \"4-2\": \"Optional\",\n    \"3-3\": \"Container of [fixed-selection-type](doc:fixed-selection-type)  properties.\",\n    \"4-3\": \"Container of [merchant-value-type](doc:merchant-value-type) properties.\",\n    \"0-0\": \"`custom-param-type`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Custom parameter type:\\n  * **SHORT-TEXT**\\n  * **LONG-TEXT**\\n  * **FIXED SELECTION**\\n  * **BOOLEAN**\\n  * **MERCHANT PASSED VALUE**\\n  * **READ-ONLY**\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\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    \"1-0\": \"`short-text-type`\",\n    \"1-1\": \"container\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"2-0\": \"`visual-settings`\",\n    \"2-1\": \"container\",\n    \"2-3\": \"BlueSnap identifier for the transaction.\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"Container of [short-text-type](doc:short-text-type) properties.\",\n    \"2-2\": \"Container of [visual-settings](doc:visual-settings) properties.\",\n    \"3-0\": \"`fixed-selection-type`\",\n    \"4-0\": \"`merchant-value-type`\",\n    \"3-1\": \"container\",\n    \"4-1\": \"container\",\n    \"3-2\": \"Container of [fixed-selection-type](doc:fixed-selection-type) properties.\",\n    \"4-2\": \"Container of [merchant-value-type](doc:merchant-value-type) properties.\",\n    \"0-0\": \"`custom-param-type`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Custom parameter type:\\n  * **SHORT-TEXT**\\n  * **LONG-TEXT**\\n  * **FIXED SELECTION**\\n  * **BOOLEAN**\\n  * **MERCHANT PASSED VALUE**\\n  * **READ-ONLY**\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":31,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6040037678d626005641a0e1","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"6040037678d626005641a08c","version":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6040037678d626005641a084","6040037678d626005641a085","6040037678d626005641a086","6040037678d626005641a087","6040037678d626005641a088","6040037678d626005641a089","6040037678d626005641a08a","6040037678d626005641a08b","6040037678d626005641a08c","6040037678d626005641a08d","6040037678d626005641a08e"],"_id":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5c742637ad58c70033b9c762","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-24T18:11:39.508Z","githubsync":"","__v":0}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

custom-param-settings

Request

Property Name
Type
Required
Description

custom-param-type

string

Required

Custom parameter type:

  • SHORT-TEXT
  • LONG-TEXT
  • FIXED SELECTION
  • BOOLEAN
  • MERCHANT PASSED VALUE
  • READ-ONLY

short-text-type

container

Optional

Container of short-text-type properties.

visual-settings

container

Optional

Container of visual-settings properties.

fixed-selection-type

container

Optional

Container of fixed-selection-type properties.

merchant-value-type

container

Optional

Container of merchant-value-type properties.

Response

Property Name
Type
Description

custom-param-type

string

Custom parameter type:

  • SHORT-TEXT
  • LONG-TEXT
  • FIXED SELECTION
  • BOOLEAN
  • MERCHANT PASSED VALUE
  • READ-ONLY

short-text-type

container

Container of short-text-type properties.

visual-settings

container

Container of visual-settings properties.

fixed-selection-type

container

Container of fixed-selection-type properties.

merchant-value-type

container

Container of merchant-value-type properties.