APG PayAPG Paydocs

Card issuer

List cards

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

Return a page of digital cards. Supply page for offset pagination or startingAfter for cursor pagination, and q to search. The filters combine with each other and with q by AND. GET /filter-catalogues/cards lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400.

Permissions

Required permission
creditCards:query

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

Query parameters

qstring

Search. Matches a card id, the card's last four digits, the card user's name or email address, the creator or the provider's identifier. No card number is ever matched. 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.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

sortarray of CardSort

Fields to sort by, comma-delimited, in priority order. Prefix a field with - for descending.

statusone of CardStatus, array of CardStatus

Only cards whose status is one of these. Repeat the parameter to give several.

cardIdone of array of string, string

Only cards whose identifier is one of these. Repeat the parameter to give several.

loanIdone of array of string, string

Only cards whose loan is one of these. Repeat the parameter to give several.

last4string

Filter by the last four digits of the card number.

excludeExpiredboolean

Leave out cards outside their validity window.

Headers

Encryption-Key-Namestring

Name of the caller's registered public encryption key, used to encrypt sensitive card data in the response.

Responses

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

Discriminated by type
type = "CardPageAttributes"
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": "CardPageAttributes",
  "data": [
    {
      "type": "CardViewAttributes",
      "cardId": "dcard_9f2Kd8QpLzXw",
      "cardType": "Virtual",
      "status": "Active",
      "card": {
        "type": "CardRedactedAttributes",
        "last4": "4242",
        "bin": "424242",
        "brand": "Visa",
        "expiryMonth": 6,
        "expiryYear": 2029
      },
      "cardUser": {
        "type": "CardUserAttributes",
        "name": "Ada Lovelace",
        "emailAddress": "ada@example.com",
        "phoneNumber": "+61400000000"
      },
      "amounts": {
        "type": "CardAmountsAttributes",
        "currency": "AUD",
        "cardLimit": 500000,
        "transactionLimit": 500000,
        "available": 1250
      },
      "validFrom": "2026-08-19T04:21:07Z",
      "validTo": "2026-08-19T04:21:07Z",
      "usage": "Single",
      "currencies": [
        "AUD"
      ],
      "synonyms": [
        "string"
      ],
      "creator": "string",
      "providerIdentifier": "string",
      "metadata": {
        "yourKey": {}
      },
      "createdAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses