How to Add an API Key on Paytia

How to Add an API Key on Paytia

Adding an API key to your Paytia account is essential for integrating external applications or services with your merchant account on the Paytia platform. Follow the steps below to generate and manage an API key.

Steps to Generate an API Key

1. Log in to Your Paytia Account

   • Use your administrator credentials to log in to the Paytia dashboard.

2. Navigate to the API Secret Key Menu

   • Go to Account Security in the left-hand menu.
   • Select API Secret Key.
     
     

3. Enter Required Details

   • IP Address: If you want to restrict API access to a specific IP address, enter the IP address from which your application will connect. Leave this blank if no restriction is needed.
   • Webhook Setting:
     • Single JSON Data: Outputs data as a single JSON string.
     • Multiple JSON Data: Outputs each field as a separate line in the JSON (specific to certain gateways like Worldpay Corporate Gateway).
       
       

4. Save the API Key

   • Click Save to generate the API key.
   • Once saved, the API key will appear in the list along with the settings you’ve configured.

Managing the API Key

• View API Keys: After generation, all active API keys are displayed in a table showing:
  • API Key: The generated key.
  • Merchant Username: The associated account.
  • IP Address: The restricted IP (if configured).
  • Webhook Setting: The chosen output format.
    
    
• Delete or Regenerate API Keys:
  • To remove an API key, click the Delete button next to the key.
  • You can generate a new API key at any time by following the steps above.

Security Tips for API Keys

• Restrict access to a trusted IP address to enhance security.
• Avoid sharing your API key publicly.
• Regenerate API keys periodically for better security practices.

For more details on advanced API key security configurations, refer to the related guide: "How to Add Enhanced API Key Security on Paytia".