APG PayAPG Paydocs

Payment sources

List blocked cards

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

Return the card-block audit, newest first. One card can appear several times, a row is an event, not a card.

Permissions

Required permission
blockedCard:query

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

Query parameters

qstring

Search. Matches a blocked card id, the id of the transaction that raised the block, the card's last four digits or the block's narrative. 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 BcardSort

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

columnsarray of BcardColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

marketplaceIdstring

Narrow to one marketplace. Overridden by your credential where it names one.

merchantIdone of array of string, string

Narrow to these merchants. Repeat the parameter.

customerIdone of array of string, string

Narrow to these customers. Repeat the parameter.

transactionIdone of array of string, string

Narrow to the blocks raised against these transactions.

last4string

Narrow to one card, by its last four digits.

cardBrandone of CardBrand, array of CardBrand

Narrow to these card brands. Repeat the parameter.

eventone of BcardEvent, array of BcardEvent

Narrow to these events. Repeat the parameter.

createdFromstring (date-time)

Events at or after this instant.

createdTostring (date-time)

Events strictly before this instant.

Responses

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

Discriminated by type
type = "BcardPageAttributes"
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": "BcardPageAttributes",
  "data": [
    {
      "type": "BcardViewAttributes",
      "blockedCardId": "blockedsrc_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "marketplaceId": "mktp_9f2Kd8QpLzXw",
      "customerId": "cust_9f2Kd8QpLzXw",
      "transactionId": "tran_9f2Kd8QpLzXw",
      "sourceId": "psrc_9f2Kd8QpLzXw",
      "card": {
        "type": "BcardDetailsAttributes",
        "last4": "4242",
        "bin": "424242",
        "brand": "Visa",
        "funding": "Credit",
        "expiryMonth": 6,
        "expiryYear": 2029,
        "issuerCountry": "AU",
        "issuer": "string"
      },
      "blocked": true,
      "event": "Added",
      "reason": "Requested by the customer.",
      "payerMessage": "string",
      "createdAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses