Generate a Payroc App API key

To use the Payroc Cloud Simulator, you need a Payroc App API key, which you can generate and view in the Self-Care Portal.

Note: If you don’t have access to the Self-Care Portal, contact our Integrations Team at [email protected].

Generate a Payroc app API key

  1. Sign in to https://payments.payroc.com/merchant/selfcare.
  2. On the side menu, select Settings, and then select API Keys.
  3. Select NEW API KEY.
  4. In the Key Alias box, enter the name of the API key.
  5. In the Notification Email box, enter your email address. We send notifications to this email address when we create, revoke, or reactivate the API key.
  6. In the API Permissions section, select the following checkboxes:
    • Account API – Access the merchant gateway account.
    • Customer API – Access customer details, for example, secure tokens and subscriptions.
    • Transaction API – Run card transactions.
    • Bank Transfer API – Run bank transfer transactions.
    • Reporting API – Access to reporting data.
  7. For each API that you selected, select the dropdown menu, and then select Full Access.
  8. Select SAVE.
  9. Select the processing terminals that the key applies to.
  10. Select SAVE.

View the Payroc App API key

  1. On the side menu, select Settings, and then select API Keys.

  2. Locate the API key that you want to view.
    Note: You can use the search function to search by the Key Alias that you assigned to the key when you created it.

  3. From the Action column, select , and then select View Authentication Key.

  4. Enter the password for your Self-Care Portal account.

  5. View and copy the key.

Note: You can use the Self-Care Portal to update, deactivate, and reactivate the Payroc App API keys. For more information about how to manage API keys, go to API keys.