APG PayAPG Paydocs

Payment sources

Get source

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

Return one payment source.

Permissions

Required permission
customerPaymentSources:query

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

Path parameters

sourceIdstring
required

Responses

The response is a typed union.

Discriminated by type
type = "PsrcViewCard"
sourceIdPsrcIdrequired

Identifier of a payment source.

Example psrc_9f2Kd8QpLzXw

customerIdCustId

The customer the card is stored against. Absent on a temporary card, which the merchant owns.

Example cust_9f2Kd8QpLzXw

merchantIdMchtId

The merchant that owns the card. Present on a temporary card.

Example mcht_9f2Kd8QpLzXw

statusPsrcStatusrequired
ActiveRemovedUnknown
last4stringrequired

Last four digits of the card number.

Example 4242

binstringrequired

Issuer identification number, the leading digits of the card number.

Example 424242

brandCardBrandrequired
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper
+5 more

Hipercard, Jcb, Electron, Uatp, Unknown

fundingCardFundingrequired
CreditDebitChargeCardPrepaidDeferredDebitUnknown
expiryMonthinteger (int32)required

Example 6

expiryYearinteger (int32)required

Example 2029

issuerCountryIsoCountryrequired

Where the card was issued.

AFAXALDZASADAOAIAQAG
+239 more

AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, KP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, CD, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, VI, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

currencyIsoCurrencyrequired

The currency the card is denominated in.

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

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

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

Error responses