Skip to main content

PurchaseEvent

kindPurchaseKindrequired

One value per contract event that moves money or entitlement of an account, plus carryOver, which the backend records off-chain when an upgrade carries unused units over. A carryOver row carries the eventSeq and txHash of the subscribed event it belongs to. carryApplied is a reserved on-chain event name that the current contract never emits. It stays in the enum so that a later contract version needs no API change. Open enum.

Possible values: [deposit, subscribed, renewed, autoRenewSkipped, autoRenewSet, paygSet, escrowMoved, paygSettled, senderAdded, senderRemoved, creditsGranted, ruGranted, carryOver, carryApplied]

eventSeqinteger<int64>required
txHashTxHashrequired

Possible values: Value must match regular expression ^[0-9a-f]{64}$

timestampMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

payerAddress

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
amountMicrointeger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

creditsAfterMicrointeger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

escrowAfterMicrointeger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

tierIdinteger
periodIdinteger
monthsinteger
startMsinteger<int64>

Unix time in milliseconds.

Possible values: >= 0

endMs(integer | null)<int64>nullable
tariffinteger<int64>

micro-USDC (6 decimals) as JSON integer - operational endpoints.

Possible values: >= 0

reasonstring

Skip reason, escrow cause, or grant reason.

refstring

Opaque ref of the purchase (quote id), as text when printable.

egldOutAttoAttoEgld

Deposits only - swap output (public chain fact).

Possible values: Value must match regular expression ^[0-9]+$

data object

Remaining decoded event fields.

property name*any

Remaining decoded event fields.

explorerUrlstring<uri>
PurchaseEvent
{
"kind": "deposit",
"eventSeq": 0,
"txHash": "string",
"timestampMs": 0,
"payer": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
"amountMicro": 0,
"creditsAfterMicro": 0,
"escrowAfterMicro": 0,
"tierId": 0,
"periodId": 0,
"months": 0,
"startMs": 0,
"endMs": 0,
"tariff": 0,
"reason": "string",
"ref": "string",
"egldOutAtto": "string",
"data": {},
"explorerUrl": "string"
}