APG PayAPG Paydocs

Loans

Get statement dbi batch

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

Return what is staged for the statement, an empty batch when nothing is.

Permissions

Required permission
loanStatements:query

Requires the `query` action on `loanStatements` for the supplied runtime context

Path parameters

statementDbiBatchIdstring
required

Responses

The response is a tagged shape: type is always "SdbiViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "SdbiViewAttributes"
statementDbiBatchIdSdbiIdrequired

Identifier of the corrections staged for a loan statement, which is the statement's own identifier.

Example lstmt_9f2Kd8QpLzXw

stagedAtstring (date-time)

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

updatedAtstring (date-time)

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

Example
{
  "type": "SdbiViewAttributes",
  "statementDbiBatchId": "lstmt_9f2Kd8QpLzXw",
  "items": [
    {
      "type": "SdbiItemAttributes",
      "issuerTransactionId": "itxn_9f2Kd8QpLzXw",
      "references": {
        "type": "SdbiReferencesAttributes",
        "pk": "string",
        "ds": "string",
        "ks": "string",
        "ae": "string",
        "ik": "string",
        "bd": "string",
        "pr": "string",
        "au": "string",
        "ak": "string",
        "rz": "string"
      },
      "travellerName": "Ada Lovelace",
      "travelAgencyInvoiceNumber": "string"
    }
  ],
  "stagedAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses