APG PayAPG Paydocs

Payment sources

List sources

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

Return a page of payment sources. Name whose sources: customerId or customerDelegateId is required, a source belongs to a payer and the platform does not page them across payers. 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/sources 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. One issued before the list named its walks resumes as it did.

Permissions

Required permission
customerPaymentSources:query

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

Query parameters

qstring

Search. Matches a payment source id, a card's last four digits, a direct debit's account name or email address, or a PayTo account name. No card or account 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 PsrcSort

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

columnsarray of PsrcColumn

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

customerIdstring

Filter by the customer the source belongs to.

merchantIdstring

Filter by the merchant that owns the source. Temporary sources are merchant-owned.

usageScopePsrcScope

Filter by what the source may be used for.

OrganisationDelegateBilling

Responses

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

Discriminated by type
type = "PsrcPageAttributes"
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": "PsrcPageAttributes",
  "data": [
    {
      "type": "PsrcViewCard",
      "sourceId": "psrc_9f2Kd8QpLzXw",
      "customerId": "cust_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "status": "Active",
      "last4": "4242",
      "bin": "424242",
      "brand": "Visa",
      "funding": "Credit",
      "expiryMonth": 6,
      "expiryYear": 2029,
      "issuerCountry": "AU",
      "currency": "AUD",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses