Get filter catalogue

GET/filter-catalogues/{filterCatalogueId}

Request

GEThttps://api.tst.au.apgpay.dev/filter-catalogues/{filterCatalogueId}

curl -X GET https://api.tst.au.apgpay.dev/filter-catalogues/{filterCatalogueId} \
  -H "Authorization: Bearer $API_KEY"

Return one list's filter catalogue for this caller, by the list's collection name, such as transactions or loans, read with that list's own authority. A list the caller cannot read answers 404.

Permissions

Required permission

Depends on filterCatalogueId: each value needs the permission its own list does.

Show the permission for each of the 26 values

transactionstransactions:query
loansloans:query
ordersorders:query
refundsrefunds:query
payoutsmerchantFinancials:query
disputesdisputes:query
sourcescustomerPaymentSources:query
issuer-transactionsissuerTransactions:query
issuer-transaction-exceptionsissuerTransactionDiscrepancies:query
cardscreditCards:query
loan-facilitiesloanFacilities:query
loan-productsloanProducts:query
loan-agreementsloanMasterAgreements:query
loan-transactionsloanTransactions:query
loan-statementsloanStatements:query
webhookswebhookSubscriptions:query
settlement-entriesmerchantFinancials:query
journal-entriessystemJournalEntries:query
merchant-invoicesmerchantFinancials:query
merchantsmerchants:query
customersmerchantCustomers:query
enterprisesenterprises:query
marketplacesmarketplaces:query
usersusers:query
rolesroles:query
filesmerchantKyb:query

Path parameters

filterCatalogueIdstring

required

Responses

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

Discriminated by type

type = "FcatAttributes"

filterCatalogueIdstringrequired

The collection whose list this catalogue describes, which is also its id, such as transactions.

labelstringrequired

Whether the list takes q, and what it matches.

Only the filters this caller can use: one it could give a single value, such as a merchant's own merchant, is left out, as is one over data it may not see. Filters combine with AND; the values of one filter with OR.

typeenumrequired

FcatFilterAttributes

namestringrequired

The filter's name, the parameter its equals is sent as.

Example Ada Lovelace

labelstringrequired

What a person reads on a chip and in an Add Filter menu.

summarystringrequired

One line for a menu, at most 50 characters.

descriptionstringrequired

kindFcatKindrequired

EnumTextIdAmountDecimalInstantDateBooleanCurrencyUnknown

groupstringrequired

The heading a client files it under beside the list's other filters, such as Tenancy or Time.

Each operator it takes, with the exact query parameter that operator is sent as.

How a person finds a value to give it.

identifiesstring

For an Id, the collection its values are the ids of, so a client links a chosen value to its record.

What the list applies when the filter is not sent, or null when it applies nothing.

Example

{
  "type": "FcatAttributes",
  "filterCatalogueId": "string",
  "label": "string",
  "search": {
    "type": "FcatSearchNotOffered"
  },
  "filters": [
    {
      "type": "FcatFilterAttributes",
      "name": "Ada Lovelace",
      "label": "string",
      "summary": "string",
      "description": "string",
      "kind": "Enum",
      "group": "string",
      "operators": [
        {
          "type": "FcatOperatorAttributes",
          "operator": "In",
          "parameter": "string",
          "inclusive": true
        }
      ],
      "values": {
        "type": "FcatValuesEntered",
        "reason": "Requested by the customer."
      },
      "identifies": "string",
      "default": {
        "type": "FcatDefaultLast",
        "days": 1250
      }
    }
  ]
}

Error responses

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}