Get a Report

GET/reports/{reportId}

This endpoint returns the details of a single report, including any generated files.

Path Parameters

reportIdstringrequired

Response

OK

idstring<uuid>
typestring
status"pending" | "error" | "completed"
paramsobject

The request parameters the report was generated with.

delivery_channel"email" | "webhook"
sent_atstring<date-time>

When the report was delivered via the chosen delivery_channel. Null until delivery has succeeded (a completed report may still have a null sent_at).

filesobject[]
Show files properties
idstring<uuid>
typestring
access_urlstring<uri>

URL to fetch the file (see the download endpoint).

created_atstring<date-time>
updated_atstring<date-time>

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X GET "https://api.uat.triple-a.io/api/fiat-payout/v1/reports/<reportId>" \
  -H "Authorization: Bearer <token>"
Response
{
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "string",
  "status": "pending",
  "params": {},
  "delivery_channel": "email",
  "sent_at": "1970-01-01T00:00:00.000Z",
  "files": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "access_url": "string"
    }
  ],
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}