APG PayAPG Paydocs

Filters

List filter catalogue filter values

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

Find the values one filter can take for this caller, a page at a time, scoped exactly as the list is. q is the search text, at least the filter's minimumSearch long. A Referenced filter's values are found by the referenced collection's search, run under the list's authority, and each is answered with its id and label only. Pass nextStartingAfter back as startingAfter for the next page; a cursor continues only the walk that issued it, the same filter and q, and is refused with 400 otherwise. The walk is forward only, so endingBefore and page are refused with 400. A Listed filter's values are in the catalogue and an Entered one's are typed, so both are refused with 400.

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

Query parameters

qstring

Search. Matches the label of each value, a merchant's name or a customer's name or email, by the referenced collection's search. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

startingAfterstring

Cursor pagination, forward only: the nextStartingAfter of the page before.

limitinteger (int32)

Maximum items per page.

filterstring
required

The filter whose values to read, by its name in the catalogue. Required.

valueone of array of string, string

Values already chosen, to read their labels rather than search: a deep link's merchantId=mcht_... resolved to the name it shows. Repeat it for several. With value, q and startingAfter are refused with 400.

Responses

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

Discriminated by type
type = "FcatValuePageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "FcatValuePageAttributes",
  "data": [
    {
      "type": "FcatValueAttributes",
      "value": "string",
      "label": "string"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses