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 ...


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 service with external telephony partners.

Follow the steps below to configure and use webhooks in Paytia:


Step 1: Access Webhook Settings

  1. Log in to the Paytia merchant administrative portal.
  2. Navigate to Configure User Screen > Webhook Setting.

    Screenshot

Step 2: Add a New Webhook

  1. Click the New Webhook button.

  2. Fill out the required fields:

    • Webhook Name: Enter a recognizable name for the webhook (e.g., "Payment Integration Service").
    • Webhook URL: Enter the URL provided by your service provider where Paytia will send webhook notifications.
    • Tenant Name: Provide the unique identifier for your account as specified by your service provider.
  3. Click Submit to save the webhook.

    Screenshot


Step 3: Verify the Webhook Configuration

Once saved, you will see your webhook listed in the Webhook Settings page with the following details:

  • Webhook Name
  • URL
  • Tenant Name
  • Status
  • Creation Date

Step 4: Agent Capture Assist Integration

When using Agent Capture Assist (ACA):

  1. Paytia generates a unique uniqueID field for every transaction.
  2. This uniqueID is included in the webhook payload sent to your telephony service provider.
  3. The telephony provider extracts this data and merges the voice and data connections to Paytia's secure payment service.

    Screenshot

Example of Webhook Payload

Below is an example of the data sent via webhook:

PAYTIA-XFER=60e56fa028f59&merchant_telephone=%2B441133206847&agent_id=100&tenant_name=CustomerName

Fields explained:

  • PAYTIA-XFER: The unique transaction ID.
  • merchant_telephone: The merchant's phone number.
  • agent_id: The ID of the agent taking the payment.
  • tenant_name: The unique identifier for your account.

Additional Notes

  • Custom Fields: Paytia can add extra fields to the webhook payload upon request. Contact techsupport@paytia.com for details.
  • Call Flow: The webhook-enabled call flow ensures a seamless voice and data bridge between the telephony provider and Paytia's secure platform.

Need Assistance?

For full integration documentation or support with configuring your webhook settings, contact techsupport@paytia.com.


addsettingswebhookagent capture assistuniquecall flowconfigureid

More in API

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 ...

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 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.