APG PayAPG Paydocs

FX rates

Get FX rate set

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

Return one rate set with its current rates.

Permissions

Required permission
fxRates:query

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

Path parameters

fxRateSetIdstring
required

Responses

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

Discriminated by type
type = "FxrsViewAttributes"
fxRateSetIdFxrsIdrequired

Identifier of an FX rate set.

Example fxrset_9f2Kd8QpLzXw

rateSetCodestringrequired

The code this set is known by. Chosen at creation, unchangeable, and unique only within the enterprise.

Example 0.9412

enterpriseIdEntIdrequired

Identifier of an enterprise.

Example ent_9f2Kd8QpLzXw

descriptionstringrequired

What the set is for, in words.

crossCurrencyIsoCurrencyrequired

The currency every rate is quoted through. A rate between two currencies neither of which is this one is computed as a cross rate.

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

timeZonestringrequired

The time zone the set's business day is reckoned in, Australia/Sydney.

The rates as they currently stand. Absent where none has been loaded.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "FxrsViewAttributes",
  "fxRateSetId": "fxrset_9f2Kd8QpLzXw",
  "rateSetCode": "0.9412",
  "enterpriseId": "ent_9f2Kd8QpLzXw",
  "description": "string",
  "crossCurrency": "AUD",
  "timeZone": "string",
  "rates": {
    "type": "FxrsSnapshotAttributes",
    "ratesUpdatedAt": "2026-08-19T04:21:07Z",
    "recordedAt": "2026-08-19T04:21:07Z",
    "rates": [
      {
        "type": "FxrsRateAttributes",
        "baseCurrency": "AUD",
        "termCurrency": "AUD",
        "bidRate": "0.9412",
        "askRate": "0.9412"
      }
    ]
  },
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses