APG PayAPG Paydocs

Loans

Get loan agreement

GET/loan-agreements/{loanAgreementId}
Request
GEThttps://api.tst.au.apgpay.dev/loan-agreements/{loanAgreementId}
curl -X GET https://api.tst.au.apgpay.dev/loan-agreements/{loanAgreementId} \
  -H "Authorization: Bearer $API_KEY"

Return one loan agreement.

Permissions

Required permission
loanMasterAgreements:query

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

Path parameters

loanAgreementIdstring
required

Responses

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

Discriminated by type
type = "LmaViewAttributes"
loanAgreementIdLmaIdrequired

Identifier of a loan master agreement.

Example lma_9f2Kd8QpLzXw

loanFacilityIdLfacIdrequired

Identifier of a loan facility.

Example lfac_9f2Kd8QpLzXw

enterpriseIdEntIdrequired

The enterprise that owns the agreement, the facility's own.

Example ent_9f2Kd8QpLzXw

referenceAgreementIdstringrequired

The applicant's own reference for this agreement. Unique within the facility.

Example your-own-reference

descriptionstringrequired

What the agreement has available and what is currently drawn.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "LmaViewAttributes",
  "loanAgreementId": "lma_9f2Kd8QpLzXw",
  "loanFacilityId": "lfac_9f2Kd8QpLzXw",
  "enterpriseId": "ent_9f2Kd8QpLzXw",
  "referenceAgreementId": "your-own-reference",
  "description": "string",
  "balances": {
    "type": "LmaBalancesAttributes",
    "currency": "AUD",
    "available": 1250,
    "used": 1250,
    "maxLimit": 500000
  },
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses