{"_id":"5632a5ef49e16d0d001224e8","category":{"_id":"5632a5e749e16d0d0012244b","__v":1,"version":"5632a5e549e16d0d00122443","pages":["5632a5ef49e16d0d001224e8","5632a5ef49e16d0d001224e9","5632a5ef49e16d0d001224ea","5632a5ef49e16d0d001224eb","5632a5ef49e16d0d001224ec","5632a5ef49e16d0d001224ed","5632a5ef49e16d0d001224ee","5632a5ef49e16d0d001224ef","5632a5ef49e16d0d001224f0","5632a5ef49e16d0d001224f1","5632a5ef49e16d0d001224f2","5632a5ef49e16d0d001224f3","5632a5ef49e16d0d001224f4"],"project":"55b933b3146ef121002158d3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:33:35.913Z","from_sync":false,"order":10,"slug":"point-of-sale-server","title":"Point of Sale Server"},"version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"githubsync":"","project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:43:07.375Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Retrieve a device registration pin\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nFor integrated software (point of sale solution) to use the gateway driven point of sale devices, the device must be paired with the source key. This can be done using the merchant's web console by going to Settings - POS Devices or the point of sale system can facilitate the pairing.\nThe steps for device pairing are:\n1. Power up pin pad device and verify proper network connectivity\n2. If successful, the pos device will display prompt for pin\n3. Point of sale software makes call to getRegistrationPin which will return pin\n4. Point of sale displays pin to user\n5. User enters pin into pos device\n6. Pos device will display idle screen and pos software can start using device methods\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nstring **getRegistrationPin** ( [ueSecurityToken](/docs/uesecuritytoken) Token)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and retrieve the custom fields.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"string\",\n    \"0-1\": \"Pin\",\n    \"0-2\": \"Device registration pin\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exceptions\"\n}\n[/block]\nThe following exceptions (errors) are applicable to this method.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Code\",\n    \"0-1\": \"Message\",\n    \"0-2\": \"Advice\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP\n## Visual Basic (.Net) \n## C Sharp (.Net)\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\" xmlns:ns1=\\\"https://secure.eBizCharge.com/soap/2.0/uedocs\\\">\\n<SOAP-ENV:Body>\\n<ns1:getRegistrationPin>\\n<Token>\\n<ClientIP>192.168.0.1</ClientIP>\\n<PinHash>\\n<HashValue>c49a67564d2f62e97507c05fa9f68135c139d362</HashValue>\\n<Seed>13651026722014578962</Seed>\\n<Type>sha1</Type>\\n</PinHash>\\n<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>\\n</Token>\\n</ns1:getRegistrationPin>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getregistrationpin","type":"basic","title":"getRegistrationPin"}

getRegistrationPin


Retrieve a device registration pin [block:api-header] { "type": "basic", "title": "Description" } [/block] For integrated software (point of sale solution) to use the gateway driven point of sale devices, the device must be paired with the source key. This can be done using the merchant's web console by going to Settings - POS Devices or the point of sale system can facilitate the pairing. The steps for device pairing are: 1. Power up pin pad device and verify proper network connectivity 2. If successful, the pos device will display prompt for pin 3. Point of sale software makes call to getRegistrationPin which will return pin 4. Point of sale displays pin to user 5. User enters pin into pos device 6. Pos device will display idle screen and pos software can start using device methods [block:api-header] { "type": "basic", "title": "Syntax" } [/block] string **getRegistrationPin** ( [ueSecurityToken](/docs/uesecuritytoken) Token) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and retrieve the custom fields." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "string", "0-1": "Pin", "0-2": "Device registration pin" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Exceptions" } [/block] The following exceptions (errors) are applicable to this method. [block:parameters] { "data": { "0-0": "Code", "0-1": "Message", "0-2": "Advice" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP ## Visual Basic (.Net) ## C Sharp (.Net) ## XML [block:code] { "codes": [ { "code": "Request:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns1=\"https://secure.eBizCharge.com/soap/2.0/uedocs\">\n<SOAP-ENV:Body>\n<ns1:getRegistrationPin>\n<Token>\n<ClientIP>192.168.0.1</ClientIP>\n<PinHash>\n<HashValue>c49a67564d2f62e97507c05fa9f68135c139d362</HashValue>\n<Seed>13651026722014578962</Seed>\n<Type>sha1</Type>\n</PinHash>\n<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>\n</Token>\n</ns1:getRegistrationPin>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:", "language": "xml" } ] } [/block]