Use the menus on the terminal

To view or update the passcodes:

1. Log in to your Customer Area.

2. Go to the account level that you want to manage passcode for.

   • For a company or merchant account, select the account and go to Point-of-sale > Terminal settings.
   • For a store, go to Point-of-sale > Stores and select the store.
   • For a terminal, go to Point-of-sale > Terminals and select the terminal.

     You can find the serial number in the Device info on the terminal.
     Refer to the manual for your terminal model.

3. Select Passcodes.

4. To view the passcodes, select Decrypted.

   • Transactions: the passcode to access Transactions menu options.
   • Admin & Settings: the passcode to access the Admin menu and theSettings menu.
   • Refunds: the passcode to access the refund feature on standalone terminals.

   If the passcode isn't visible, your user account doesn't have the Merchant POS Terminal Management Admin role. Contact your company's admin user.

5. To update a passcode, enter the new value and select Save.
   The terminal downloads the new passcodes when it makes a maintenance call to our systems. This happens automatically every 180 minutes. The new passcodes then take effect when the terminal restarts. This happens automatically at the restart hour, which is usually set to 6:00 AM.

   To switch to the new passcode immediately: on your terminal, go to Settings > Configuration using your old passcode and select Update.

You can manage your passcodes by making GET or PATCH requests to the /terminalSettings endpoint at the company, merchant, store, or terminal level.

Because passcodes are considered sensitive settings, to make this call your API credential needs to have the following role:

• Management API—Terminal Advanced settings read and write

To manage passcodes:

1. Make a GET or PATCH request to one of the following endpoints:

   • /companies/{companyId}/terminalSettings
   • /merchants/{merchantId}/terminalSettings
   • /stores/{storeId}/terminalSettings
   • /terminals/{terminalId}/terminalSettings

   Specify a passcodes object with the following properties:

   Parameter	Required	Type	Description
   adminMenuPin		string	The passcode for the Admin menu and the Settings menu.
   refundPin		string	The passcode for refunds on standalone terminals.
   txMenuPin		string	The passcode for the Transactions menu.
   screenLockPin		string	On Android terminals, the passcode to unlock the terminal screen after a timeout.

   /terminalSettings/passcodes request

   curl https://management-test.adyen.com/v1/companies/{companyId}/terminalSettings \
   -H "x-API-key: YOUR_X-API-KEY" \
   -X PATCH \
   -d '{
         "passcodes": {
             "adminMenuPin": "1111",
             "txMenuPin": "1234",
             "refundPin": "123456",
             "screenLockPin": "1111"
         },
      }'

   https://docs.adyen.com/pt/pt/point-of-sale/managing-terminals/menu-access#-terminalsettings-passcodes-request

2. The response returns all settings that your API credential has access to, including the passcodes you included in the request:

   /terminalSettings/passcodes response

   {
       "cardholderReceipt": {
           "headerForAuthorizedReceipt": "header1,header2,filler"
       },
       "gratuities": [],
       "nexo": {
           "encryptionKey": {
               "identifier": "KEY_IDENTIFIER",
               "passphrase": "KEY_PASSPHRASE",
               "version": 2
           },
           "eventUrls": {
               "eventPublicUrls": [
                   {
                       "password": "notification",
                       "url": "...",
                       "username": "adyen"
                   }
               ]
           },
           "nexoEventUrls": [
               "..."
           ]
       },
       "opi": {
           "enablePayAtTable": false,
           "payAtTableStoreNumber": "1234",
           "payAtTableURL": "..."
       },
       "receiptPrinting": {},
       "signature": {
           "askSignatureOnScreen": true,
           "skipSignature": true
       },
       "timeouts": {
           "fromActiveToSleep": 30
       },
       "offlineProcessing": {
           "chipFloorLimit": 0
       },
       "passcodes": {
           "adminMenuPin": "1111",
           "txMenuPin": "1234",
           "refundPin": "123456",
           "screenLockPin": "1111"
       },
       "standalone": {
           "enableStandalone": true,
           "currencyCode": "EUR"
       }
   }

   https://docs.adyen.com/pt/pt/point-of-sale/managing-terminals/menu-access#-terminalsettings-passcodes-response