Get Reports Details

This API operation allows merchants to retrieve detailed information about a specific report using the reportId. It provides key report metadata, including the report name, type, generation status, and a downloadable link. Additionally, it returns a chronological log of processing steps, enabling merchants to track the report’s creation process and troubleshoot any issues. This functionality ensures transparency and facilitates efficient report management within the merchant portal.

Request Parameters

Path Parameter:

Field Name	Type	Required	Description
reportId	integer	true	The unique identifier of the report record.

Response Body

The response is a JSON object of report details. Each object includes the following fields:

Field Name	Type	Description
`id`	integer	Unique identifier for the generated report.
`reportName`	string	Name of the report generated.
`reportType`	string	Category of the report, indicating the type of transactions it covers.
`status`	string	Current status of the report generation process (e.g., `SUCCESS`).
`reportUrl`	string	URL to download the generated report file.
`reportLogs`	array	List of log entries detailing the steps involved in report generation.

`reportLogs` Object Fields

Field Name	Type	Description
`id`	integer	Unique identifier for the report log entry.
`messageLog`	string	Description of the processing step executed.
`status`	string	Status of the processing step (e.g., `COMPLETE`).
`createdAt`	string (ISO 8601)	Timestamp indicating when the log entry was created.
`completedAt`	string (ISO 8601) or null	Timestamp indicating when the log entry was completed, or `null` if not yet completed.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Response

application/json

Bodyapplication/json

Example

{
  "id": 1,
  "reportName": "Test Report",
  "reportType": "MERCHANT TRANSACTIONS REPORT",
  "status": "FAILED",
  "reportLogs": [
    {
      "id": 8,
      "messageLog": "An unexpected error occurred",
      "createdAt": "2024-07-09T12:16:25.000+00:00"
    },
    {
      "id": 7,
      "messageLog": "An unexpected error occurred",
      "createdAt": "2024-07-09T12:16:25.000+00:00"
    }
  ]
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Request Parameters#

Response Body#

reportLogs Object Fields#

Request

Request Code Samples

Responses

Request Parameters

Response Body

`reportLogs` Object Fields