Skip to content

Reference / @getenginex/sdk/realtime / PaymentNoticeFacts

PaymentNoticeFacts ​

Facts of a payment notice: a deposit or withdrawal that changed state.

Properties ​

amount? ​

optional amount?: NoticeMoney

Amount of the deposit or withdrawal, when known.


category ​

category: "payment"

Always payment.


event ​

event: PaymentNoticeEvent

What happened, e.g. deposit_completed.


outcome? ​

optional outcome?: WithdrawalNotCompletedOutcome

Why the withdrawal was not completed (withdrawal_not_completed).


paymentId? ​

optional paymentId?: string

Deposit payment id (deposit_completed).


withdrawalId? ​

optional withdrawalId?: string

Withdrawal id (withdrawal_completed, withdrawal_not_completed).