How do I use Paytia Webhooks?
Webhooks let our platform send notifications and data out to third-party providers — useful when you're integrating Agent Capture Assist with an external telephony partner. Setting one up takes a couple of minutes.
Configuring webhooks in the Paytia merchant portal
Webhooks let our platform send notifications and data out to third-party service providers. If you're integrating Agent Capture Assist with an external telephony partner, this is how the two systems talk to each other. Setting one up takes a couple of minutes.
Step 1: Open the webhook settings
- Log in to the Paytia merchant administrative portal.
- Go to Configure User Screen > Webhook Setting.
Step 2: Add a new webhook
- Click the New Webhook button.
- Fill in the three fields: a Webhook Name you'll recognise later (something like "Payment Integration Service"), the Webhook URL your service provider gave you — that's where we'll send the notifications — and the Tenant Name, which is the unique account identifier your provider specified.
- Click Submit to save it.
Step 3: Check it saved
Your new webhook now appears in the Webhook Settings list, showing its name, URL, tenant name, status and creation date.
Step 4: How it works with Agent Capture Assist
When you're using Agent Capture Assist (ACA), we generate a unique uniqueID for every transaction and include it in the webhook payload we send to your telephony provider. The provider extracts that data and merges the voice and data connections into our secure payment service, so the call and the payment stay linked throughout.
What the payload looks like
PAYTIA-XFER=60e56fa028f59&merchant_telephone=%2B441133206847&agent_id=100&tenant_name=CustomerName
PAYTIA-XFER is the unique transaction ID, merchant_telephone is your phone number, agent_id identifies the agent taking the payment, and tenant_name is your account's unique identifier. We can add extra fields to the payload on request — just ask.
Need a hand?
For the full integration documentation, custom payload fields or help with your webhook settings, email us at techsupport@paytia.com.
More in API
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.
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.
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.