APG PayAPG Paydocs

Parties

Get supplier

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

Return one supplier in the caller's scope.

Permissions

Required permission
suppliers:query

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

Path parameters

supplierIdstring
required

Responses

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

Discriminated by type
type = "SuplViewAttributes"
supplierIdSuplIdrequired

Identifier of a supplier.

Example supl_9f2Kd8QpLzXw

merchantIdMchtIdrequired

The merchant that is this supplier.

Example mcht_9f2Kd8QpLzXw

licenceNumberstring

The licence the merchant supplies under, where it holds one.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "SuplViewAttributes",
  "supplierId": "supl_9f2Kd8QpLzXw",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "licenceNumber": "string",
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses