APG PayAPG Paydocs

Card issuer

Get card

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

Return one digital card.

Permissions

Required permission
creditCards:query

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

Path parameters

cardIdstring
required

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 "CardViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "CardViewAttributes"
cardIdCardIdrequired

Identifier of a digital card.

Example dcard_9f2Kd8QpLzXw

cardTypeCardTyperequired

Whether the card exists only as a number or was also manufactured.

VirtualPhysicalUnknown
statusCardStatusrequired
ActiveCancelledOutOfLifetimeUnknown

The non-sensitive projection of a card's details.

Who the card is issued to.

A card's limits and what is left. All are in the single currency given here.

validFromstring (date-time)required

The card cannot be used before this.

Example 2026-08-19T04:21:07Z

validTostring (date-time)required

The card cannot be used after this. The platform allows three days' leniency either side.

Example 2026-08-19T04:21:07Z

usageCardUsage

Whether the card may be presented once or repeatedly.

SingleMultipleUnknown
currenciesarray of IsoCurrency

The currencies this card may be presented in. Empty means the loan's own only.

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB
+156 more

PAB, BBD, BYR, BZD, BMD, VEF, BOB, BRL, BND, BGN, BIF, CAD, CVE, KYD, XOF, XAF, XPF, CLP, COP, KMF, CDF, BAM, NIO, CRC, HRK, CUP, CZK, GMD, DKK, MKD, DJF, STD, DOP, VND, XCD, EGP, SVC, ETB, EUR, FKP, FJD, HUF, GHS, GIP, HTG, PYG, GNF, GYD, HKD, UAH, ISK, INR, IRR, IQD, JMD, JOD, KES, PGK, LAK, KWD, MWK, AOA, MMK, GEL, LBP, ALL, HNL, SLL, LRD, LYD, SZL, LSL, MGA, MYR, MUR, MXN, MXV, MDL, MAD, MZN, BOV, NGN, ERN, NAD, NPR, ANG, ILS, TWD, NZD, BTN, KPW, NOK, PEN, MRU, PKR, MOP, TOP, CUC, UYU, PHP, GBP, BWP, QAR, GTQ, ZAR, OMR, KHR, RON, MVR, IDR, RUB, RWF, SHP, SAR, RSD, SCR, SGD, SBD, KGS, SOS, TJS, SSP, LKR, SDG, SRD, SEK, CHF, SYP, BDT, WST, TZS, KZT, TTD, MNT, TND, TRY, TMT, AED, UGX, COU, CLF, UYI, USD, USN, USS, UZS, VUV, CHE, CHW, KRW, YER, JPY, CNY, ZMW, ZWL, PLN

synonymsarray of string

Alternative numbers the scheme knows this card by. Mastercard issues them on request; a UATP card has none.

creatorstringrequired

Who created the card, as the platform recorded it.

providerIdentifierstringrequired

The card provider's own identifier for this card.

metadatamap of any JSON value

Free-form data the platform stores and returns untouched.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses