Skip to main content

CurrencyConvertedEvent

Cash was converted from one currency to another.

cursorstringrequired

Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.

Example: ev1.abc123.xyz789
entityCodestringrequired

Code identifying the organisation (client) this event belongs to.

Example: TEST001
eventTypestringrequired
Constant value: CURRENCY_CONVERTED
fromAmountdecimalrequired

Amount in the source currency before conversion.

Example: 12500.00
fromCurrencystringrequired

Source currency code.

Example: USD
fxRatedecimalrequired

Exchange rate applied in the conversion.

Example: 0.800000
toAmountdecimalrequired

Amount in the target currency after conversion.

Example: 10000.00
toCurrencystringrequired

Target currency code.

Example: GBP
uidstringrequired

Unique identifier for this event record.

Example: 00000000000000000000000000000001
CurrencyConvertedEvent
{
"cursor": "ev1.abc123.xyz789",
"entityCode": "TEST001",
"eventType": "CURRENCY_CONVERTED",
"fromAmount": "12500.00",
"fromCurrency": "USD",
"fxRate": "0.800000",
"toAmount": "10000.00",
"toCurrency": "GBP",
"uid": "00000000000000000000000000000001"
}