APG PayAPG Paydocs

Loans

Create statement receipts

POST/statement-receipts

Record a payment received against a statement and apply it. A requestReference already recorded answers with what it holds.

Permissions

Required permission
loanStatements:update

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

Request body

This body is a tagged shape: type is always "SrcptCmdRecord". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "SrcptCmdRecord"
loanStatementIdLstmtIdrequired

Identifier of a loan statement.

Example lstmt_9f2Kd8QpLzXw

requestReferencestringrequired

The caller's reference for this receipt. Sending it again is safe.

Example your-own-reference

The amount, in the statement's own currency: another currency is refused.

receivedAtstring (date-time)

When the payment was received, where it differs from now.

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

remarkstring
uploadFilePathsarray of string
paymentMethodstring
curl -X POST https://api.tst.au.apgpay.dev/statement-receipts \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "SrcptCmdRecord",
  "loanStatementId": "lstmt_9f2Kd8QpLzXw",
  "requestReference": "your-own-reference",
  "amount": {
    "type": "IsoCurrencyAmount",
    "minorCurrencyUnits": 1250,
    "currency": "AUD"
  },
  "receivedAt": "2026-08-19T04:21:07Z",
  "remark": "string",
  "uploadFilePaths": [
    "string"
  ],
  "paymentMethod": "string"
}'

Responses

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

Discriminated by type
type = "SrcptCreateRspAttributes"

The resource that was created.

Example
{
  "type": "SrcptCreateRspAttributes",
  "created": {
    "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"
  }
}

Error responses