Skip to content
/
Report Get

Report Get

Request

Fetch a single generated report by id.

Only reports generated by the caller are visible. Use this to poll file_status after requesting a report: pending and processing mean the report is still being built, success means it is ready for download and fail means generation failed.

Security
bearerAuth
Path
idstring, (uuid)(Id)required
curl -i -X GET \
  'https://docs.swiftxpay.com/_mock/openapi/v2/reports/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required

Report id, for GET /v2/reports/{id} and the presigned download URL.

file_namestring(File Name)required

Report file name.

content_typestring(Content Type)required

MIME type of the file.

report_typestring(ReportType)required

Kind of report.

Enum:"payout""statement""wallet""funding_history""pnl""reversed_payouts""agent_payout"
file_statusstring(BatchJobItemStatus)required

Generation status. The file can be downloaded once this is success.

Enum:"pending""processing""success""fail"
auto_generatedboolean(Auto Generated)required

true if the scheduler created this report, false if you requested it.

created_atstring, (date-time)(Created At)required

When the report was created (UTC).

paramsClientPayoutReportParams (object) or null(Params)required
Any of:

Payout report parameters available to API clients.

Mirrors the client-facing parameters of stream_order_results so a generated report can be reproduced exactly from the persisted params.

Response
{
  "auto_generated": false,
  "content_type": "text/csv",
  "created_at": "2024-12-01T01:02:03.000000Z",
  "file_name": "payout_IND_2024-12-01.csv",
  "file_status": "success",
  "id": "00000000-0000-4000-A000-000000000000",
  "report_type": "payout"
}