API

Paytia API services

API Services Playtia provides REST API services, allowing our customers and system integrators to programatically control the Paytia transaction processing service from their own web/database applications. Paytia have three versions of API services ...

API Services


Playtia provides REST API services, allowing our customers and system integrators to programatically control the Paytia transaction processing service from their own web/database applications.

Paytia have three versions of API services

1. The main Paytia API service is called the 'PAYMENT SERVICE API'. It allows our customers to use multiple Paytia services from one central API integration and post to request an iframe service form.
2. For applications that cannot work with popup HTML windows or iframe services, Paytia has an 'URL POST' API. This API accepts data inside an encoded POST URL and extracts the data values to pre-populate the Paytia Agent Capture Assist User Interface form which is automatically generated and shows as a redirect.
3. Bespoke - Paytia creates bespoke API services for custom applications or workflow/transaction processing journeys.

Testing assistance


Paytia can provide POSTMAN https://www.postman.com/ collections to speed up proof of concept testing. Please reach out to techsupport@paytia.com to make a request.

API documents


PAYMENT SERVICE API - Current active version 6.0
URL POST API - current version 2.6

Useful Articles


API Exception Handling https://support.paytia.com/portal/en/kb/articles/paytia-api-exception-handling
How to add an API key https://support.paytia.com/portal/en/kb/articles/how-do-i-add-an-api-key-on-paytia
How do I add enhanced API key security on Paytia? https://support.paytia.com/portal/en/kb/articles/how-to-add-enhanced-api-key-security-on-paytia

Note: fields on Paytia forms may be set to required, if so you need to consider these as required for the API posts as well.

Embedding the Paytia Agent Capture Assist form into your web application


Paytia provides a set of JavaScript files to assist development by embedding the Paytia ACA UI in your application.
See https://accounts.paytia.com/api/docs

Postman Test collection

We have included a Postman collection with the Paytia Payment Services API data set included. Each API set has been adjusted to demonstrate the fields that would be used for each function.


restapiiframe

More in API

Paytia Proxy Gateway

Technical Overview, Configuration, and Test Guide 1. Overview The Paytia Proxy Gateway is a flexible payment gateway that enables organisations to securely pass captured payment data from their environment to third-party systems using a fully ...

Webhook request button

Webhook Request Button Overview The Webhook Request button in the Paytia platform provides a detailed log of all webhook interactions associated with a specific call or transaction. This feature is designed to help administrators and developers track ...

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

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 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 extra API key security on Paytia?

How to Add Extra API Key Security on Paytia Adding extra 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 ...

Still need help?

Our support team is here to help. Submit a ticket and we'll get back to you within one business day.

Submit a TicketBack to Knowledge Base