Update FX rate set

PATCH/fx-rate-sets/{fxRateSetId}

Load new rates. replaceOldRates decides whether they replace the set's rates or merge into them, there is no safe default.

Permissions

Required permission

fxRates:update

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

Path parameters

fxRateSetIdstring

required

Request body

This body is a tagged shape: type is always "FxrsUpdateRates". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type

type = "FxrsUpdateRates"

The rates to load. At least one, the platform takes a non-empty set, and this now says so rather than refusing after the fact.

typeenumrequired

FxrsRateAttributes

baseCurrencyIsoCurrencyrequired

The currency bought one unit of, AUD in AUD/USD.

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

termCurrencyIsoCurrencyrequired

The currency paid in, USD in AUD/USD. 1.20 means one base buys 1.20 term.

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB

+156 more

bidRatestringrequired

Use when the customer sells the base currency.

Example 0.9412

askRatestringrequired

Use when the customer buys it. The gap between the two is the spread.

Example 0.9412

ratesUpdatedAtstring (date-time)

When they were struck. Defaults to now.

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

replaceOldRatesbooleanrequired

true replaces the set's rates with these. false merges them, leaving pairs you did not send as they were. Required, neither default is safe.

Example true

curl -X PATCH https://api.tst.au.apgpay.dev/fx-rate-sets/{fxRateSetId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "FxrsUpdateRates",
  "rates": [
    {
      "type": "FxrsRateAttributes",
      "baseCurrency": "AUD",
      "termCurrency": "AUD",
      "bidRate": "0.9412",
      "askRate": "0.9412"
    }
  ],
  "ratesUpdatedAt": "2026-08-19T04:21:07Z",
  "replaceOldRates": true
}'

Responses

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

Discriminated by type

type = "FxrsUpdateRspAttributes"

The resource as it stands after the change.

typeenumrequired

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

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.

typeenumrequired

FxrsSnapshotAttributes

ratesUpdatedAtstring (date-time)required

When the rates were struck. This is the one that decides which rate applied.

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

recordedAtstring (date-time)required

When the platform recorded them.

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

typeenumrequired

FxrsRateAttributes

baseCurrencyIsoCurrencyrequired

The currency bought one unit of, AUD in AUD/USD.

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB

+156 more

termCurrencyIsoCurrencyrequired

The currency paid in, USD in AUD/USD. 1.20 means one base buys 1.20 term.

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB

+156 more

bidRatestringrequired

Use when the customer sells the base currency.

Example 0.9412

askRatestringrequired

Use when the customer buys it. The gap between the two is the spread.

Example 0.9412

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example

{
  "type": "FxrsUpdateRspAttributes",
  "updated": {
    "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

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}