Paylias provides a sandbox and a production environment for clients to connect into.
https://sandbox.api.paylias.xyzhttps://api.paylias.xyzYou have to use TLS 1.2 or greater to connect to any of our API endpoints.
The Paylias API allows you to submit and receive transactions, manage data relevant for those transactions (e.g. customers) and perform internal actions on the platform such as granting and removing access permissions.
The table below gives an overview of the functions supported by the Paylias API:
| Function | HTTP Verb | Has Body | Description |
|---|---|---|---|
| Create | POST | Yes | Create a resource (Webhook Subscription, Domain, Payment Submission, etc.) |
| Fetch | GET | No | Fetch a specific resource. |
| List | GET | No | List all resources of one type (e.g. Subscription, Payment Submission, etc.) with the ability to filter for certain characteristics like date ranges, status, etc. |
| Delete | DELETE | No | Remove a resource. Most resources don't support this functionality. |
| Edit | PATCH | Yes | Edits only certain attributes of a resource. Only some resources support this functionality. |
| Update | PUT | Yes | Edits all attributes of a resource. Only some resources support this functionality. |
Many endpoints require URL parameters such as IDs. In the API documentation, these IDs are written in curly brackets like this: {some_id}. For example, when creating a payment submission for a payment, the Create Submission endpoint requires the ID of the Payment resource a submission should be created for: POST /api/v1/csp/payments/{payment_id}/submissions
List endpoints further support query strings to allow for pagination and filtering when returning large numbers of resources. Query strings are indicated by a leading ? and have the format query_title=query_string. Multiple queries are connected using &.