APG PayAPG Paydocs

Customers

Get delegate

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

Return one delegate.

Permissions

Required permission
customerDelegates:query

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

Path parameters

delegateIdstring
required

Responses

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

Discriminated by type
type = "CustdViewAttributes"
delegateIdCustdIdrequired

Identifier of a customer delegate.

Example custd_9f2Kd8QpLzXw

displayNamestringrequired

The delegate's name as the platform holds it, one field, not a given/family pair.

Example Ada Lovelace

emailAddressstringrequired

Example ada@example.com

phoneNumberstring

Example +61400000000

statusCustdStatusrequired
EnabledDisabledUnknown

The customers this delegate acts for, and what they may do for each.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "CustdViewAttributes",
  "delegateId": "custd_9f2Kd8QpLzXw",
  "displayName": "Ada Lovelace",
  "emailAddress": "ada@example.com",
  "phoneNumber": "+61400000000",
  "status": "Enabled",
  "customers": [
    {
      "type": "CustdCustomerRefAttributes",
      "customerId": "cust_9f2Kd8QpLzXw",
      "position": "string",
      "loanRole": {
        "type": "CustdLoanRoleCardUser",
        "viewAllTransactions": true,
        "canCreateCards": true,
        "loanIds": [
          "loan_9f2Kd8QpLzXw"
        ]
      }
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses