WHwhispa
integrations
collexus

Deliver Collexus Return File

Upload one day's activity return file to the creditor's folder, once.

The scheduled delivery on request, for a chosen day and without waiting for the delivery hour. It writes to the creditor's server, and a day is delivered once: asking again for a delivered day sends nothing and says so. It needs the scenario scope and a pinned host key, but not the daily delivery switched on.

post/integrations/collexus/return-file/deliver

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 deliver (see COLLEXUS_RETURN_FILE_TIMEZONE). Defaults to the most recent complete local day. A day that has not ended is refused.

Response

Successful Response

status'uploaded' | 'already_delivered' | 'confirmed' | 'adopted' | 'not_configured' | 'untrusted' | 'day_not_complete' | 'busy' | 'failed' required
detailstring required
business_datestring date nullable
filenamestring nullable
remote_pathstring nullable
row_countinteger nullable
byte_sizeinteger nullable
content_sha256string nullable
delivered_atstring date-time nullable

Changes

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