How do I use Paytia Webhooks?

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


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.

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.

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.


    • Related Articles

    • How do I configure my Agent Capture Assist?

      Getting started with Agent Capture Assist This article outlines Agent Capture Assist functions and how to configure them. It covers the following: Initial configuration Administration console orientation Managing payments Administering users and ...

    • How do I use Agent Capture Assist to take payments?

      How users of Agent Capture Assist sign in, receive calls, make calls and take payments First things first If you have been set up as a user then you will have received a 'welcome' email. If you don't, then ask your administrator to create you as a ...

    • Webhooks sent from Paytia to API users for the payment capture IVR flow

      Paytia IVR webhook flow The initial post into Paytia will return a URL for the Paytia iframe. If you do not want to use the iframe you can ignore that response post ‘url’ value. Note: Paytia will maintain the reference_id value throughout the payment ...

    • Feature settings

      Note: Feature settings are all licenced so you may not have all the settings we will explain on this article. The Feature settings are used for system wide services allowing control of different aspects of the Paytia service. To find Feature ...

    • How do I Set Up PayPal for Paytia Agent Capture Assist?

      Setting Up PayPal for Paytia Agent Capture Assist To use Paytia Agent Capture Assist with PayPal, you'll need to configure your PayPal account by generating API credentials. Follow these instructions to set up your PayPal Business account for ...