How to Add an API Key on Paytia
Generating an API key from Account Security then API Secret Key, plus the optional IP restriction that limits where the key can be used from.
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
Log in to Your Paytia Account
- Use your administrator credentials to log in to the Paytia dashboard.
Navigate to the API Secret Key Menu
- Go to Account Security in the left-hand menu.
- Select API Secret Key.
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).
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".
More in API
Integrating Paytia: A Comprehensive Guide to the Connection Points you must consider
There are three places Paytia connects to your world — your host system, your telephony, and your payment gateway. This walks through what each connection needs so you can plan an integration properly.
Paytia API - Braintree payment gateway - using the gateway_customer_control field to control the passed value in the gateway_customer_id field
The gateway_customer_control field lets you set your own Braintree customer IDs. Here are the valid values and the exact errors you'll get when one is wrong.
Paytia API exception handling
The webhooks we send when something goes wrong mid-payment — the customer rejects the amount, the call drops, the card fails. Here's each case and what lands on your endpoint.
Paytia API services
Three API versions, depending on how much of the flow you want to control yourself. This is the overview of what each does and which one to pick.
Paytia development - embedded iframe events
If you embed our checkout rather than redirecting, we send postMessage events to your page so you can resize the frame and react to the outcome. These are separate from webhooks.
Paytia Proxy Gateway
The Proxy Gateway posts captured payment data to your own endpoint as JSON you define. Nothing is hard-coded, so you shape the payload to whatever's waiting on the other end.
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.