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 ...
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.pay729>.{domain 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
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 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 ...
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 ...
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.