APG PayAPG Paydocs

Loans

Update statement dbi batch

PATCH/statement-dbi-batches/{statementDbiBatchId}

Add references to what is staged, or apply the batch and have the statement's documents made again.

2 actionsSdbiUpdateAddSdbiUpdateApply

Permissions

Required permission
loanStatements:update

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

Path parameters

statementDbiBatchIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "SdbiUpdateAdd"
curl -X PATCH https://api.tst.au.apgpay.dev/statement-dbi-batches/{statementDbiBatchId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "SdbiUpdateAdd",
  "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"
    }
  ]
}'

Responses

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

Discriminated by type
type = "SdbiUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "SdbiUpdateRspAttributes",
  "updated": {
    "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