API Flow
List of API
| API | Purpose |
|---|---|
POST /token | Authentication |
POST /v2/reports/query | Request daily itemised report |
| Request cycle summary data | |
| Request daily summary data | |
| Request monthly summary data |
Refer to the API Reference page here.
Pre-Requisite: Authentication
| Step | Sender | Receiver | Process |
|---|---|---|---|
| 1 | Participant | PayNet | Call API to request for token |
| 2 | PayNet | Participant | API responds with token and token expiry |
info
The access token received from the authorization server will last for 1 hour. Once the token expires, you'll need to request a new token by repeating the same authentication process. (Subject to change)
Itemised Report
| Step | Sender | Receiver | Process |
|---|---|---|---|
| 1 | Participant | PayNet | Send the report request, with report ID, date, etc. |
| PayNet | Participant | API responds with status e.g. new/in-progress/error | |
| 2 | Participant | PayNet | Poll the report request status via the same request API |
| PayNet | Participant | API responds with status ready and the 1-time URL for report download | |
| 3 | Participant | PayNet | Request to download report via the given URL |
Summary Report
| Step | Sender | Receiver | Process |
|---|---|---|---|
| 1 | Participant | PayNet | Send the report request, with report ID, date, cycle, etc. |
| 2 | PayNet | Participant | Return requested data in JSON format |