Skip to main content
API

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.

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 Postman 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.1 (updated 22/07/2026)
URL POST API - current version 2.6

Useful Articles


API Exception Handling Paytia API exception handling
How to add an API key How to Add an API Key on Paytia
How do I add enhanced API key security on Paytia? How do I add an 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.

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

Paytia Proxy Gateway

The Proxy Gateway posts captured payment data to your own endpoint as JSON you define. Nothing is hard-coded, so you shape the payload to whatever's waiting on the other end.

Webhook request button

The Webhook Request button shows every webhook tied to one call or transaction, in order. It's the quickest way to see what your system was actually sent.

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.

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.

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