APG PayAPG Paydocs

Reference data

Create reference entries

POST/reference-entries

Look a bank branch up, list the industries, or load a register. A lookup needs MerchantFinancials_Query, a load ReferenceData_Create, and the industries no permission beyond the credential.

5 actionsRefCmdListIndustriesRefCmdLoadAuRegisterRefCmdLoadNzRegisterRefCmdLookupBsbRefCmdLookupNzPrefix

Permissions

Required permission

Required action depends on the request variant. Select a variant in the request body below to see the permission it requires.

Request body

This body is a typed union. Pick a variant to see its fields, the permission it requires, and a matching example.

Discriminated by type
type = "RefCmdListIndustries"
Required permission
No explicit action

List the industries the platform recognises

This variant has no additional fields.

curl -X POST https://api.tst.au.apgpay.dev/reference-entries \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RefCmdListIndustries"
}'

Responses

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

Discriminated by type
type = "RefCreateRspAttributes"

The resource that was created.

Example
{
  "type": "RefCreateRspAttributes",
  "created": {
    "type": "RefViewAuBranch",
    "bsb": "string",
    "bankName": "Ada Lovelace"
  }
}

Error responses