List Reports

get/api/accounts/{accountId}/reports

List reports for an account.

This API uses cursor-based pagination. Start by making a request without a cursor to get the first page. Use the nextCursor from the pageInfo in the response as the cursor for subsequent requests to retrieve further pages. Continue until nextCursor is undefined, indicating no more data.

Request

Path Parameters

accountIdstringrequired
The ID of the account to list reports for.

Query Parameters

limitnumber
Number of records to return (max 100, defaults to 100).
cursorstring
Cursor to retrieve the next page.
typestring
Allowed values:daily-funding-sourcemonthly-funding-sourcedaily-funding-source-interactionmonthly-funding-source-interactiondaily-paymentmonthly-payment
Filter results to reports of this type.

Response

Successful operation.

Body application/json

itemsobject[]
Items
- idstringrequired
  The report ID.
- typestringrequired
  Allowed values:daily-funding-sourcemonthly-funding-sourcedaily-funding-source-interactionmonthly-funding-source-interactiondaily-paymentmonthly-payment
  The report type.
- accountIdstringrequired
  The account the report belongs to.
- scheduleDatestring<date-time>required
  The ISO 8601 date-time the report is scheduled to be generated. This is not the period the report covers; see params.date for that.
- paramsobjectrequired
  The parameters the report was scheduled with. Fields present depend on the report type.
  partnerAccountIdstring
  The partner account the report covers. Present on all report types.
  datestring
  The period the report covers. Format is yyyyMMdd for daily reports and yyyyMM for monthly reports.
  fundingPurposestring
  Allowed values:card-fundingbilling
  Optional funding purpose filter. Only applies to funding-source and funding-source-interaction reports.
- statusstringrequired
  Allowed values:pendingcompleted
  The processing status of the report.
  When completed, use Create Report Download URL to retrieve the artifact.
- livenessstringrequired
  Allowed values:livetest
  Whether the report covers live or test data.
pageInfoobject
Page info for paginated results, undefined if no page info
- nextCursorstring
  Cursor for next page, undefined if no more pages

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

No authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{accountId}/reports' \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "items": [
    {
      "id": "01JPMK5BGDY7G2PQXYZ1234567",
      "type": "daily-payment",
      "accountId": "225d85e65495722bf6517ea0ba0d6f56",
      "scheduleDate": "2026-03-21T00:00:00.000Z",
      "params": {
        "partnerAccountId": "225d85e65495722bf6517ea0ba0d6f56",
        "date": "20260320",
        "fundingPurpose": "card-funding"
      },
      "status": "pending",
      "liveness": "live"
    }
  ],
  "pageInfo": {
    "nextCursor": "dGhlIG5leHQgY3Vyc29yIGdvZXMgaGVyZQ=="
  }
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}