This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk / WithdrawalRequestResult

WithdrawalRequestResult ​

WithdrawalRequestResult = { expiresAt: string; requestId: string; status: "otp_required"; } | { status: "created"; withdrawal: WithdrawalSubmission; }

Result of WithdrawalsApi.request. The operator decides whether the withdrawal requires a code (OTP) — the withdraw_money flow in config.otp.flows:

  • otp_required: the code was sent to the player; nothing has gone out yet. Call WithdrawalsApi.confirmOtp with the code before expiresAt.
  • created: the operator does not require an OTP and the withdrawal was already sent to the payment service.

Union Members ​

Type Literal ​

{ expiresAt: string; requestId: string; status: "otp_required"; }

expiresAt ​

expiresAt: string

Until when the code is valid, ISO 8601 (UTC). After that, request the withdrawal again.

requestId ​

requestId: string

Id of the pending request (informational: the confirmation uses the session, not this id).

status ​

status: "otp_required"

The withdrawal awaits the code sent to the player.


Type Literal ​

{ status: "created"; withdrawal: WithdrawalSubmission; }

status ​

status: "created"

The withdrawal was created without an OTP.

withdrawal ​

withdrawal: WithdrawalSubmission

The created withdrawal.