WHwhispa
integrations
collexus

Read Collexus Return File

Generate one day's activity return file and report it, without uploading.

How the agreed format gets checked before anything lands in the creditor's folder: the response carries the complete CSV, its digest and its row count, and the scheduled delivery sweep is not involved. Generating is free of side effects, so this is safe to call repeatedly and on a day that has already been delivered — it says so, and the delivery itself stays refused.

Admin-only because the file is customer data by nature: references, phone numbers and call summaries, the same exposure as the accounts CSV export. It answers cleanly on a deployment that produces no return file at all, reporting the agreed column order either way.

get/integrations/collexus/return-file

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Query parameters

business_datestring date nullable

Creditor-local day to cover (see COLLEXUS_RETURN_FILE_TIMEZONE). Defaults to the most recent complete local day — the one a delivery pass right now would be filing.

Response

Successful Response

status'ok' | 'not_configured' required
detailstring required
business_datestring date nullable
timezonestring nullable
scenariosstring[]
filenamestring nullable
remote_pathstring nullable
row_countinteger nullable
byte_sizeinteger nullable
content_sha256string nullable
columnsstring[]
delivered_atstring date-time nullable
delivered_sha256string nullable
csv_textstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.