Document Generation

The Document Generation API produces a branded PDF for a customer and wallet — an Account Confirmation Letter, a Statement, or a Proof of Payment. The document type controls which data is fetched and which template renders it; both are tenant configuration, so the underlying query and the look of the document can be changed without any code deployment.

Generating a Document

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/documents/generate
Authorization: Bearer {jwt}
Content-Type: application/json

{
  "documentType": "ACCOUNT_CONFIRMATION_LETTER",
  "customerId": 9581252,
  "walletId": 2549223,
  "requestedBy": "channel-user-1"
}

Response (200 OK):

{
  "documentType": "ACCOUNT_CONFIRMATION_LETTER",
  "fileName": "account-confirmation-letter.pdf",
  "mimeType": "application/pdf",
  "encoding": "base64",
  "document": "JVBERi0xLjQ...",
  "referenceNumber": "SBTPA-26-0728-A1B2C3D4",
  "generatedDate": "2026-07-28T10:15:00.000Z"
}

document is the flattened, non-editable PDF, base64-encoded. referenceNumber is stamped on the document itself and is safe to show to the customer as a reference for the request.

Request Fields

Available Document Types

documentType is not a fixed enum — it is validated against whatever your tenant has enabled (see Configuring Document Types). Three are available out of the box:

Example — Statement with a date range:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/documents/generate
Authorization: Bearer {jwt}
Content-Type: application/json

{
  "documentType": "STATEMENT",
  "customerId": 9581252,
  "walletId": 2549223,
  "additionalData": [
    { "att": "dateFrom", "val": "2026-01-01" },
    { "att": "dateTo", "val": "2026-06-30" }
  ]
}

Example — Proof of Payment for a specific transaction:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/documents/generate
Authorization: Bearer {jwt}
Content-Type: application/json

{
  "documentType": "PROOF_OF_PAYMENT",
  "customerId": 9581252,
  "walletId": 2549223,
  "additionalData": [
    { "att": "transactionId", "val": "TXN-45231" }
  ]
}

📘

Note

transactionId accepts the internal transaction ID, the external transaction ID, or the unique ID — whichever you have on hand.

Configuring Document Types

Every document type — including the three above — is driven entirely by configuration, scoped to your tenant. A new document type can be enabled without any code change: enable the type name, add its query, and add its template.

Enabling document types

Report query

The query is a sub-property of a reporting.config property, keyed by report ID — not part of the property name itself.

Report IDs for the built-in types: account-confirmation-letter, statement-transactions, proof-of-payment. A new document type's report ID is the type name, lower-cased with _ replaced by - (e.g. WELCOME_LETTER → welcome-letter). additionalData values bind to the query automatically: a value that parses as an ISO date (YYYY-MM-DD) binds to the next date parameter, anything else binds to the next string parameter.

Template

Branding

📘

Note

The global default branding belongs to another tenant. Set your own generate.document.branding.<key> values before generating documents — otherwise your documents are branded with someone else's details.

Optional per-type settings

📘

Note

The reporting.config/reporting.config.<tenantId> sub-properties and the handlebar.template.generate.document.* properties are platform properties, not tenant config items — setting them requires access to the Eclipse platform property store (via Admin Portal or API). Everything else on this page is a standard tenant config item.

Permissions Required

Set as tenant config items — access is denied by default until explicitly granted.

Each permission's value is a comma-delimited list of role or position names. Include CUSTOMER in the list to let a customer generate a document for their own customerId directly.