API details
What Can I See in the API Details View? The API Details View provides an in-depth look at the internal API exchanges between Paytia's telephony and API services. This feature is designed for troubleshooting and offers transparency into the data ...
What Can I See in the API Details View?
The API Details View provides an in-depth look at the internal API exchanges between Paytia's telephony and API services. This feature is designed for troubleshooting and offers transparency into the data passed internally within the Paytia platform.
Purpose of the API Details View
- Troubleshooting: Helps diagnose and resolve issues related to telephony and API integration.
- Transparency: Displays the flow of data processed within Paytia services.
- Advanced Reporting: Offers detailed information about internal API processes associated with call records.
How to Access the API Details View
Ensure You Have the Advanced Log License
- The API Details View is part of the Paytia Advanced Log License, which includes access to Call Records.
- Verify your account has this license enabled.
Navigate to Call Records
- In the Log Information menu, click on Call Records to open the call log history page.
- You will see a list of call logs with action buttons.
Click the API Details Button
- Locate the API Details button under the action column.
- Clicking this button opens the API process flow information for the selected call.
What Information Does the API Details View Provide?
When accessing the API Details View, you can see a detailed table of internal API transactions. Each row in the table contains the following columns:
| Column Header | Description |
|---|---|
| URI | The API endpoint that was accessed. |
| Method | The HTTP method used (e.g., POST). |
| Request Params | The parameters sent in the API request. |
| Response | The data Paytia returned in response to the request. |
| Actual Response | The processed result or status of the API interaction. |
| Time | The exact time the API call occurred. |
Example Data View
In the API details table, you can review:
-
Specific data passed between Paytia services.
-
The API response for each request, including success or failure status.
Time-stamped logs for precise tracking and analysis.
Use Case for API Details View
- Debugging Call Issues: Understand why a specific call or transaction may not have completed successfully.
- Validating API Data: Ensure that API requests and responses align with expected formats and requirements.
- Compliance and Reporting: Keep detailed records of API transactions for audits or troubleshooting purposes.
Additional Resources
For further details, refer to the Call Records article for a complete guide to navigating and using call history logs. If you encounter issues, contact Paytia Support
for assistance.
More in API
CDR Details Webhooks: Push Data for Telephony Events
CDR Details Webhooks: Push Data for Telephony Events Paytia supports webhook push messages, enabling you to transmit real-time call information to a predefined URL. This functionality allows seamless programmatic decision-making within third-party ...
How do I add an enhanced API key security on Paytia?
How to Add Enhanced API Key Security on Paytia Adding enhanced security to your API integration ensures a more secure and streamlined experience when connecting to the Paytia platform. Follow these instructions to generate an API key, activate ...
How do I use Paytia Webhooks?
Configuring Webhooks in the Paytia Merchant Administrative Portal Webhooks enable the Paytia platform to send notifications and data to third-party service providers. These notifications are essential for integrating the Paytia Agent Capture Assist ...
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 ...
Integrating Paytia: A Comprehensive Guide to the Connection Points you must consider
Paytia provides secure payment solutions that integrate seamlessly with host systems, telephony, and payment gateways. This guide outlines the primary connection points and how businesses can utilise Paytia for a streamlined payment processing ...
Paytia API - Braintree payment gateway - using the gateway_customer_control field to control the passed value in the gateway_customer_id field
Error conditions When using the Paytia API and connecting to the Braintree payment gateway, Paytia has added the ability for a developer to set their own Customer ID values as the Braintree Customer ID. API error message for control use cases: Case ...
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.