generateReport(V7)

Description

The editReport request will be used to generate an F2F report

URL: https://3g.rogersm.dev.directpay.online/api/v7/index.php

Response

The method will respond with the result of your request

Request Variables

Parameter	Data Type	Description

Parameter	Data Type	Description
Request	Text	generateReport	Mandatory
Company Token	Token	Token you got from 4G to operate this API	Mandatory
startDate	DateTime	Start of date range	Mandatory
endDate	DateTime	End of date range	Mandatory
reportType	Text	Type of report	Mandatory
format	Text	Report file format	Optional
userID	Number	Authenticated user	Mandatory

Request Example

<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <Request>generateReport</Request>
    <CompanyToken>BD0B25BD-4F7E-49B0-80CD-37C2BF6F6368</CompanyToken>
    <startDate>2025-4-01</startDate>
    <endDate>2025-4-15</endDate>
    <reportType>Statement</reportType>
    <format>CSV</format>
    <userID>13946</userID>
</API3G>

Response:

The server will repsond for the generateReport request according to the following results

Parameter	Data Type	Description

Parameter	Data Type	Description
Explanation	Text	Response status
Message	Text	Descriptive response text

Response Codes:

Code	Explanation

Code	Explanation
802	Wrong company token
200	Success
801	Invalid company token
999	Wrong request
400	Client data error

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <Code>200</Code>
    <Explanation>Success</Explanation>
    <Message>Your report is generated, refresh the list for download link!</message>
</API3G>