Skip to main content

MyPayter - Data API Overview

The MyPayter Data API allows an integrator's system to directly interrogate and retrieve Transaction data via RESTful HTTP GET requests.

note

This section will eventually cover how to perform requests, and how to retrieve the data you need from the Data API. Payter are working on a more comprehensive online documentation to support this API, but in the meantime much of the functionality is detailed extensively in our API PDF guide, available here.

Data API Assumptions​

Payter recommends the following when developing to the data API:

  • General familiarity with MyPayter generally, and Transaction Reporting in MyPayter specifically
  • Live customers only
  • Development completed in the Live environment
    • The API is read only
    • Live ensures a richer data set for testing
    • The Data API is typically completed as a secondary or additional phase of development

Data API Requirements​

Authentication is performed as a POST to a specific endpoint, using an existing users MyPayter credentials. It is recommended to therefore generate a specific Data API user, ideally with the email username set as a dedicated email address within the partner organisation. The ability to interrogate the Data API is a specific user role that Payter can apply to any user however, so this is a core requirement.

Next Steps​

Whilst Payter works on a more comprehensive online guide, please download the Payter Data API Guide to examine this solution further. Please contact us with any questions you have.