Webhooks sent from Paytia to API users for the payment capture IVR flow
What we post back at each stage of an IVR payment, and how your reference_id is carried through every webhook so you can match them up.
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.
{
"httpStatus": true,
"reference_id": "{the reference ID you sent}",
"url": "<https://accounts.paytia.com extension}/thirdparty/embededurl/{dynamic GUID Mjk4ODAw/cmVmZXJlbmNlX2lkX2lzX251bWJlcl8yMDM=}",
"status": {
"statusCode": 200,
"statusDescription": "Success"
}
}
Note: In the above example and value with { } delimiters will represent a specific syntax or value based on the response sent and Paytia platform being utilised.
The iframe will load the data you posted

The following are webhooks that will be returned as the transaction processing continues
When the agent has successfully entered their agent ID
payment_stage=agent_id&reference_id=reference_id_is_number_106&agent_id=100
The customer will be asked to confirm the amount being transacted.
Customer presses 1 to confirm the amount was correct
Customer presses 2 to say amount was wrong
success=0&reference_id=reference_id_is_number_113
Move to stage = Capture payment card
Now, we move to the:-
Customer enters their card number
The Paytia system will send representation X's for the number of digits collected (the total number vary based on card type from 13-19 digits)

The customer now presses the # key on their telephone keypad to confirm card
Card validation
Note: Exception - If the card number validation fails Paytia will return a webhook of
If all tests pass when the customer presses # key to confirm the card entry has concluded Paytia will follow
BIN validation passed
BIN success will now return card type match values and this webhook will be sent

Card expiry date capture stage
For each digit collected Paytia will send a webhook representing the Month (M), Month (M), Year (Y), Year (Y) of the card expiry date

If the date captured is correct Paytia will move to the CVV capture stage and will issue a webhook of
Note: there are variations in card brand for how long a CVV value is
(In the case of American Express)

Transaction processing stage

Responses
Failed
Success
Exceptions that can occur across the payment flow
Customer says the amount was incorrect in the IVR
The customer presses * on their telephone keypad in the IVR to cancel and return to the agent
The agent presses * in the IVR to cancel and return to the customer
The customer call leg hangs up/disconnects
The agent call leg hangs up/disconnects
More in API
API details
The API Details View exposes the internal exchanges between Paytia's telephony and API services. It's a troubleshooting tool — here's how to open it and how to read what's there.
CDR Details Webhooks: Push Data for Telephony Events
Paytia can push call information to a URL you nominate as it happens, so a third-party application can act on it straight away. Here's how the CDR webhook works and what it sends.
How do I add an enhanced API key security on Paytia?
Generating a key is step one. This covers the controls worth switching on afterwards — IP restriction and token-based access — and how to pre-authorise your requests.
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.
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.
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.