APG PayAPG Paydocs

Loans

Get loan statement setting

GET/loans/{loanId}/statement-settings
Request
GEThttps://api.tst.au.apgpay.dev/loans/{loanId}/statement-settings
curl -X GET https://api.tst.au.apgpay.dev/loans/{loanId}/statement-settings \
  -H "Authorization: Bearer $API_KEY"

Return how this loan's statement documents are produced and delivered. LoanStatementSettingsNotConfigured means none are set: the loan's statements get CSV and PDF and nothing is mailed. The transfer secret is never returned; secretSet says whether one is stored. Settings imported from APG read back as stored and may fail validation when sent back: ,-joined or malformed addresses are refused until corrected. Needs Loans_Update, as changing them does, with LoanUpdateStatementSettings or LoanUpdateClearStatementSettings on the loan's PATCH.

Permissions

Required permission
loans:update

Requires the `update` action on `loans` for the supplied runtime context

Path parameters

loanIdstring
required

Responses

The response is a typed union.

Discriminated by type
type = "LoanStatementSettingsConfigured"
statementEmailsarray of string

Where the statement mail and its documents go, one address per entry.

Example ada@example.com

readyNoticeEmailsarray of string

Who is told a statement is ready to download, one address per entry. Empty sends no notice.

Example ada@example.com

How mailed copies are encrypted. Absent: nothing is mailed, since a statement mail is never sent unencrypted.

Read-only. A replacement keeps them and clearing the settings deletes them.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "LoanStatementSettingsConfigured",
  "documents": [
    {
      "type": "LoanStatementDocumentSettingViewAttributes",
      "format": "Csv",
      "enabled": true,
      "schemaVersion": "string",
      "channels": [
        "Email"
      ]
    }
  ],
  "statementEmails": [
    "ada@example.com"
  ],
  "readyNoticeEmails": [
    "ada@example.com"
  ],
  "transferEncryption": {
    "type": "LoanStatementTransferEncryptionViewAttributes",
    "method": "Zip",
    "secretSet": true
  },
  "systemIntegrations": [
    {
      "type": "LoanStatementSystemIntegrationAttributes",
      "sysCode": "string",
      "formats": [
        "Csv"
      ],
      "enabled": true,
      "referenceCustomerId": "your-own-reference",
      "isTest": true
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses