{"title":"Query the PED object for device information","category":"default","creationDate":1776961627,"content":"<h2 id=\"peddevice-object\">PEDDevice object<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 13%\"><col style=\"width: 86%\"><\/colgroup><thead><tr class=\"header\"><th><p>Name<\/p><\/th><th><p>Description<\/p><\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>PedDevice<\/code><\/p>\n<\/td><td>\n<p>PED object that represents the terminal.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2 id=\"getter\">Getter<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 13%\"><col style=\"width: 86%\"><\/colgroup><thead><tr class=\"header\"><th><p>Name<\/p><\/th><th><p>Description<\/p><\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>GetTerminalInfo<\/code><\/p>\n<\/td><td>\n<p>Retrieves information from the PED. \u00a0<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2 id=\"returned-parameters\">Returned Parameters<\/h2>\n<table>\n<thead>\n<tr>\n<th>Name<\/th>\n<th>Type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>id<\/code><\/td>\n<td>Variant<\/td>\n<td>Unique ID of the terminal.<\/td>\n<\/tr>\n<tr>\n<td><code>brand<\/code><\/td>\n<td>Variant<\/td>\n<td>Brand of the terminal, i.e. Verifone.<\/td>\n<\/tr>\n<tr>\n<td><code>type<\/code><\/td>\n<td>Variant<\/td>\n<td>Type of the terminal.<\/td>\n<\/tr>\n<tr>\n<td><code>snr<\/code><\/td>\n<td>Variant<\/td>\n<td>Serial number of the terminal.<\/td>\n<\/tr>\n<tr>\n<td><code>hw<\/code><\/td>\n<td>Variant<\/td>\n<td>Terminal hardware version.<\/td>\n<\/tr>\n<tr>\n<td><code>os<\/code><\/td>\n<td>Variant<\/td>\n<td>Terminal Operating System.<\/td>\n<\/tr>\n<tr>\n<td><code>api<\/code><\/td>\n<td>Variant<\/td>\n<td>Terminal firmware version<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"method\">Method<\/h2>\n<table>\n<thead>\n<tr>\n<th>Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>RefreshPed<\/code><\/td>\n<td>Updates the terminal information. Triggers a PED state callback from which you can query the state using <code>GetDeviceState<\/code>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"parameters\">Parameters<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 8%\"><col style=\"width: 5%\"><col style=\"width: 8%\"><col style=\"width: 76%\"><\/colgroup><thead><tr class=\"header\"><th><p>Name<\/p><\/th><th><p>Type<\/p><\/th><th>Required<\/th><th><p>Description<\/p><\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>retries<\/code><\/p>\n<\/td><td>\n<p>Int<\/p>\n<\/td><td>\n<p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p>\n<\/td><td>\n<p>Number of times to retry refreshing the PED state. If you have multiple POS systems connected to a single PED, there may be an active transaction on the device which would block the request. Set this to a high number to avoid blocking.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2 id=\"callback\">Callback<\/h2>\n<table>\n<thead>\n<tr>\n<th>Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>PedStateChange<\/code><\/td>\n<td>Callback that returns the current PED state.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"getter-1\">Getter<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 13%\"><col style=\"width: 86%\"><\/colgroup><thead><tr class=\"header\"><th><p>Name<\/p><\/th><th><p>Description<\/p><\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>GetDeviceState<\/code><\/p>\n<\/td><td>\n<p>Used on PedStateChange to return the current PED state.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2 id=\"ped-states\">PED States<\/h2>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 25%\"><col style=\"width: 74%\"><\/colgroup><thead><tr class=\"header\"><th>State<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><code>ped_state_undetected<\/code><\/td><td>Incorrect IP, cannot detect the PED. This is a final state.<\/td><\/tr><tr><td><code>ped_state_detected<\/code><\/td><td>PED detected, correct serial\/IP address.<\/td><\/tr><tr><td><code>ped_state_identified<\/code><\/td><td>Valid PED.<\/td><\/tr><tr><td><code>ped_state_registered<\/code><\/td><td>PED is registered, final result on RegisterPED.<\/td><\/tr><tr><td><code>ped_state_config_synced<\/code><\/td><td>PED is has synchronized its configuration.<\/td><\/tr><tr><td><code>ped_state_wait_reboot_ready<\/code><\/td><td>PED is rebooting.<\/td><\/tr><tr><td><code>ped_state_wait_ready_for_transaction<\/code><\/td><td>PED must complete another process before it is ready to create a transaction.<\/td><\/tr><tr><td><code>ped_state_not_ready<\/code><\/td><td>PED is busy. This is a final state.\u00a0<\/td><\/tr><tr><td><code>ped_state_ready_for_transaction<\/code><\/td><td>PED is ready for transaction.<\/td><\/tr><tr><td><code>ped_state_tender<\/code><\/td><td>PED is busy with a tender.<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/query-the-ped-object-for-device-information-com-extension","articleFields":{"id":"25143515","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/query-the-ped-object-for-device-information-com-extension","title":"Query the PED object for device information","content":"PEDDevice object\nNameDescription\nPedDevice\n\nPED object that represents the terminal.\n\nGetter\nNameDescription\nGetTerminalInfo\n\nRetrieves information from the PED. \u00a0\n\nReturned Parameters\n\n\n\nName\nType\nDescription\n\n\n\n\nid\nVariant\nUnique ID of the terminal.\n\n\nbrand\nVariant\nBrand of the terminal, i.e. Verifone.\n\n\ntype\nVariant\nType of the terminal.\n\n\nsnr\nVariant\nSerial number of the terminal.\n\n\nhw\nVariant\nTerminal hardware version.\n\n\nos\nVariant\nTerminal Operating System.\n\n\napi\nVariant\nTerminal firmware version\n\n\n\nMethod\n\n\n\nName\nDescription\n\n\n\n\nRefreshPed\nUpdates the terminal information. Triggers a PED state callback from which you can query the state using GetDeviceState.\n\n\n\nParameters\nNameTypeRequiredDescription\nretries\n\nInt\n\n\n\nNumber of times to retry refreshing the PED state. If you have multiple POS systems connected to a single PED, there may be an active transaction on the device which would block the request. Set this to a high number to avoid blocking.\n\nCallback\n\n\n\nName\nDescription\n\n\n\n\nPedStateChange\nCallback that returns the current PED state.\n\n\n\nGetter\nNameDescription\nGetDeviceState\n\nUsed on PedStateChange to return the current PED state.\n\nPED States\nStateDescriptionped_state_undetectedIncorrect IP, cannot detect the PED. This is a final state.ped_state_detectedPED detected, correct serial\/IP address.ped_state_identifiedValid PED.ped_state_registeredPED is registered, final result on RegisterPED.ped_state_config_syncedPED is has synchronized its configuration.ped_state_wait_reboot_readyPED is rebooting.ped_state_wait_ready_for_transactionPED must complete another process before it is ready to create a transaction.ped_state_not_readyPED is busy. This is a final state.\u00a0ped_state_ready_for_transactionPED is ready for transaction.ped_state_tenderPED is busy with a tender.","type":"page","locale":"pt","boost":14,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"COM extension for Windows integration","lvl5":"Extras","lvl6":"Query the PED object for device information"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations","lvl4":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration","lvl5":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension","lvl6":"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/extras-com-extension\/query-the-ped-object-for-device-information-com-extension"},"levels":7,"category":"In-person payments","category_color":"green","tags":["Query","object","device","information"]}}
