APG PayAPG Paydocs

FX rates

Get FX rate set rate

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

Price one currency pair from this set. A pair the set does not quote directly is crossed through its crossCurrency, and the legs come back with it.

Permissions

Required permission
fxRates:query

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

Path parameters

fxRateSetIdstring
required

Query parameters

baseCurrencyIsoCurrency
required

The currency being converted from. Required.

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

termCurrencyIsoCurrency
required

The currency being converted to. Required.

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

Responses

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

Discriminated by type
type = "FxrsCrossRatesAttributes"

The effective rate for the pair asked for, two-sided.

The legs used to get there. Empty where the set quotes the pair directly.

Example
{
  "type": "FxrsCrossRatesAttributes",
  "rate": {
    "type": "FxrsRateAttributes",
    "baseCurrency": "AUD",
    "termCurrency": "AUD",
    "bidRate": "0.9412",
    "askRate": "0.9412"
  },
  "crossRates": [
    {
      "type": "FxrsRateAttributes",
      "baseCurrency": "AUD",
      "termCurrency": "AUD",
      "bidRate": "0.9412",
      "askRate": "0.9412"
    }
  ]
}

Error responses