api.paytsoftware.com. It requires the API module to be enabled for the administration. Setting up authorization is explained here, and the full endpoint reference is in the API Reference.
Base URL
All API requests go to:https://demo-api.paytsoftware.com for testing against the demo environment. See Testing for how to set up a free demo account.
Requirements
- TLS 1.2 or higher (SSL required on all requests)
- OAuth2 Bearer token or static API token in the
Authorizationheader - All monetary values are strings with two decimals
- All timestamps are UTC, formatted as ISO 8601
Keep in mind
- Use index endpoints when you need data for multiple records: do not fire multiple requests at show endpoints. Use the cursor from the last response to request the next page (see Pagination & syncing).
- POST and PATCH endpoints return a response with a success count and errors. See the responses page.
- Some fields are only returned when explicitly requested through the
fieldsparameter. Check the response model in the API Reference to see which fields require an explicit request.
Authentication
Authorize your app and obtain access tokens.
Pagination & syncing
Page through results and sync only what changed.