APG PayAPG Paydocs

Loans

Get loan facility

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

Return one loan facility.

Permissions

Required permission
loanFacilities:query

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

Path parameters

loanFacilityIdstring
required

Responses

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

Discriminated by type
type = "LfacViewAttributes"
loanFacilityIdLfacIdrequired

Identifier of a loan facility.

Example lfac_9f2Kd8QpLzXw

enterpriseIdEntIdrequired

The enterprise that owns the facility.

Example ent_9f2Kd8QpLzXw

descriptionstringrequired
statusLfacStatusrequired
ActivePausedRetiredUnknown

The balances on a loan facility. All are in the single currency given here.

timeZonestringrequired

IANA time zone loans from this facility measure their statement periods in.

The business the facility lends on behalf of.

Where this facility's statements ask to be paid, in precedence order. Absent on a page of facilities, which does not read each one's table; empty where the facility has none yet.

The mark this facility's statements are drawn with, where it has one.

referenceLoanFacilityIdstring

Example your-own-reference

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "LfacViewAttributes",
  "loanFacilityId": "lfac_9f2Kd8QpLzXw",
  "enterpriseId": "ent_9f2Kd8QpLzXw",
  "description": "string",
  "status": "Active",
  "balances": {
    "type": "LfacBalancesAttributes",
    "currency": "AUD",
    "available": 1250,
    "used": 1250,
    "reserved": 1250
  },
  "timeZone": "string",
  "businessProfile": {
    "type": "LfacBusinessProfileAttributes",
    "legalName": "Ada Lovelace",
    "businessNumber": "string",
    "taxRegistrationNumber": "string",
    "taxCountry": "AU",
    "tradingCountry": "AU",
    "contactEmail": "ada@example.com",
    "contactPhone": "+61400000000",
    "website": "string"
  },
  "statementReceivingAccounts": [
    {
      "type": "LfacReceivingAccountRuleAttributes",
      "productLines": [
        "CentralPay"
      ],
      "paymentMethods": [
        "DirectDebit"
      ],
      "account": {
        "type": "LfacBankAccountAttributes",
        "bsbNumber": "string",
        "accountNumber": "string",
        "bankName": "Ada Lovelace",
        "branch": "string",
        "swiftCode": "string"
      }
    }
  ],
  "branding": {
    "type": "LfacBrandingAttributes",
    "logoUri": "https://example.com/callback"
  },
  "referenceLoanFacilityId": "your-own-reference",
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses