Skip to main content

API Flow

List of API

APIPurpose
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




StepSenderReceiverProcess
1ParticipantPayNetCall API to request for token
2PayNetParticipantAPI 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



StepSenderReceiverProcess
1ParticipantPayNetSend the report request, with report ID, date, etc.
PayNetParticipantAPI responds with status e.g. new/processing/error
2ParticipantPayNetPoll the report request status via the same request API
PayNetParticipantAPI responds with status ready and the 1-time URL for report download
3ParticipantPayNetRequest to download report via the given URL

Summary Report




StepSenderReceiverProcess
1ParticipantPayNetSend the report request, with report ID, date, cycle, etc.
2PayNetParticipantReturn requested data in JSON format