APG PayAPG Paydocs

Loans

Get statement receipt batch

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

Return one batch with its receipts.

Permissions

Required permission
loanStatements:query

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

Path parameters

statementReceiptBatchIdstring
required

Responses

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

Discriminated by type
type = "SrbatViewAttributes"
statementReceiptBatchIdSrbatIdrequired

Identifier of a bank direct-entry batch of receipts.

Example srbat_9f2Kd8QpLzXw

requestReferencestringrequired

Example your-own-reference

bankChannelNamestring

Example Ada Lovelace

fileNamestring

Example Ada Lovelace

transactionCountinteger (int32)required

How many receipts the batch carries.

Example 42

What the batch's receipts add up to.

bankProcessDatestring (date-time)

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

fileGenerateStatusSrbatFileStatusrequired

Whether the file for the bank was written.

WaitingProcessingSuccessfulFailedUnknown
fileDealStatusSrbatFileStatusrequired

Whether the bank accepted the file. Settle the batch once it has.

WaitingProcessingSuccessfulFailedUnknown
bankReferencestring

Example your-own-reference

paymentMethodstring
remarkstring
errorMessagestring

The receipts the batch carries. Filled on a read of one batch, and empty in a list: read them at /statement-receipts.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "SrbatViewAttributes",
  "statementReceiptBatchId": "srbat_9f2Kd8QpLzXw",
  "requestReference": "your-own-reference",
  "bankChannelName": "Ada Lovelace",
  "fileName": "Ada Lovelace",
  "transactionCount": 42,
  "transactionAmount": {
    "type": "IsoCurrencyAmount",
    "minorCurrencyUnits": 1250,
    "currency": "AUD"
  },
  "bankProcessDate": "2026-08-19T04:21:07Z",
  "fileGenerateStatus": "Waiting",
  "fileDealStatus": "Waiting",
  "bankReference": "your-own-reference",
  "paymentMethod": "string",
  "remark": "string",
  "errorMessage": "string",
  "receipts": [
    {
      "type": "SrcptViewAttributes",
      "statementReceiptId": "srcpt_9f2Kd8QpLzXw",
      "requestReference": "your-own-reference",
      "loanStatementId": "lstmt_9f2Kd8QpLzXw",
      "statementReceiptBatchId": "srbat_9f2Kd8QpLzXw",
      "amount": {
        "type": "IsoCurrencyAmount",
        "minorCurrencyUnits": 1250,
        "currency": "AUD"
      },
      "status": "Waiting",
      "acknowledgement": "Waiting",
      "receivedAt": "2026-08-19T04:21:07Z",
      "remark": "string",
      "errorMessage": "string",
      "uploadFilePaths": [
        "string"
      ],
      "paymentMethod": "string",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses