Create a report

POST/reports

Schedule a settlement report over a window of business dates for the caller's own accounts, or bank-wide with the reporting scope; the scheduler builds it and stores its documents

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

from_datestring · dateRequired

A business date, YYYY-MM-DD

railstringOptional

scopestringRequired

to_datestring · dateRequired

A business date, YYYY-MM-DD

typestringRequired

Returns

200 OK

The Report object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/reports' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "from_date": "2026-09-17",
    "scope": "string",
    "to_date": "2026-09-17",
    "type": "string"
  }'

Response200

{
  "completed_at": "2026-09-17T14:30:00Z",
  "created_at": "2026-09-17T14:30:00Z",
  "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "documents": [
    {
      "built_at": "2026-09-17T14:30:00Z",
      "format": "string",
      "report_id": "strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "sha256": "string"
    }
  ],
  "failure_reason": "string",
  "from_date": "2026-09-17",
  "id": "strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "rail": "string",
  "requested_by": "string",
  "scheduled_at": "2026-09-17T14:30:00Z",
  "scope": "string",
  "status": "string",
  "to_date": "2026-09-17",
  "type": "string"
}