How do I use Paytia Webhooks?
Configure webhooks in the Paytia merchant administrative portal
Webhooks are used to notify and send information out from the Paytia platform to third party service providers.
At present the webhook service allows telephony partners that wish to add the Paytia Secure Virtual Terminal service to receive a webhook event when a payment is started by a user of Secure Virtual Terminal.
The webhook service is designed to provide control for the merchant to specify the settings their telephony provider requires for receiving information to allow them to locate, intercept and bridge with Paytia's secure payment service.
1. A webhook name - this is a free text name you recognise as the
relating to your service connection.
2. A webhook URL - this is the URL where webhooks will be send from Paytia to allowing your service provider to receive them. Your service provide will provide you this URL to enter.
3. Tenant name - is a unique value used by your service provider to identify your account - your service provide will provide you this.
Once saved you will see an entry in the Webhook settings page.
Secure Virtual Terminal
In the Paytia Secure Virtual Terminal an extra uniqueID field is generated. This is sent as part of the webhook and will be returned to Paytia inside a SIP XFER header once the call is bridged into Paytia.
SVT screen example with uniqueID shown greyed out.
Webhook sent
RAW content example
PAYTIA-XFER=60e56fa028f59&merchant_telephone=%2B441133206847&agent_id=100&tenant_name=CustomerName
This information is extracted by the service provider to allow call merging into the Paytia Secure Payment Service.
Note: extra fields can be added by Paytia to suit business requirements.
Call flow for this service
The call flow for this service will see the carrier telephony network having a voice and data connection to the Paytia service platform.
(full integration documentation is available from techsupport@paytia.com
Related Articles
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 ...Third-party webhook logs
What does the third-party webhook log show me? The Third-party webhook log shows all the data reviewed from a third-party system into the Paytia platform filtered by the X-PAYTIA-API key the data was sent with. The X-PAYTIA-API is unique to each ...Webhook request button
What does the Webhook request button show me? Webhook request button The Webhook Request button will show you all the webhooks associated with the call that has been made/received. The webhooks are shown in the order that the Paytia platform has sent ...Call presentation
How to navigate through call presentation This article outlines the call presentation category and how to configure. It covers the following: Contents of call presentation Payment system voice assistance Whisper announcement Contents of call ...What are the alternative phone-routing options for using Paytia with Aircall?
Customer call-routing options for inbound calls Option 1: Inline — all incoming calls routed through Paytia Calls are routed to and from Paytia over standard telephony using a unique ‘secure-payment’ phone number provided by Paytia Select your new ...