Class WithdrawalWorkflowService

Index

Constructors

constructor

Methods

retry return

Constructors

constructor

new WithdrawalWorkflowService(
    args: {
        temporalClient: Client;
        temporalTaskQueue: string;
        withdrawalAdminQueryService: WithdrawalAdminQueryService;
    },
): WithdrawalWorkflowService
Parameters
- args: {
      temporalClient: Client;
      temporalTaskQueue: string;
      withdrawalAdminQueryService: WithdrawalAdminQueryService;
  }
Returns WithdrawalWorkflowService
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:33

Methods

retry

retry(
    __namedParameters: Pick<Withdrawal, "id">,
): Promise<
    | { ok: true; value: void }
    | {
        error:
            | ServiceError<"WITHDRAWAL_NOT_FOUND", { id: string }>
            | ServiceError<
                "WITHDRAWAL_RETRY_UNSUPPORTED",
                {
                    methodId: | "US_WIRE"
                    | "SWIFT_WIRE"
                    | "US_ACH"
                    | "US_INSTANT"
                    | "MX_SPEI"
                    | "US_WIRE_DRAWDOWN"
                    | "AF_WITHDRAWAL"
                    | "ACH_PULL"
                    | "BLOCKCHAIN";
                },
            >;
        ok: false;
    },
>
Re-kicks the rail-appropriate initiate*WithdrawalWorkflow for a withdrawal that's stuck in CREATED/PENDING. Idempotent: skips the start if the existing workflow handle (workflowId = withdrawalId) is still RUNNING, mirroring LedgerAccountTransferWorkflowService.create.
Parameters
- __namedParameters: Pick<Withdrawal, "id">
Returns Promise<
    | { ok: true; value: void }
    | {
        error:
            | ServiceError<"WITHDRAWAL_NOT_FOUND", { id: string }>
            | ServiceError<
                "WITHDRAWAL_RETRY_UNSUPPORTED",
                {
                    methodId: | "US_WIRE"
                    | "SWIFT_WIRE"
                    | "US_ACH"
                    | "US_INSTANT"
                    | "MX_SPEI"
                    | "US_WIRE_DRAWDOWN"
                    | "AF_WITHDRAWAL"
                    | "ACH_PULL"
                    | "BLOCKCHAIN";
                },
            >;
        ok: false;
    },
>
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:49

return

return(
__namedParameters: Pick<Withdrawal, "id">,
): Promise<{ ok: true; value: void }>
Starts the top-level returnWithdrawalWorkflow which refunds the user's ledger account and flips the withdrawal to RETURNED. Uses a distinct workflow id (return-<id>) so it doesn't collide with the still-pending initiate workflow handle that owns <id>.
Parameters
- __namedParameters: Pick<Withdrawal, "id">
Returns Promise<{ ok: true; value: void }>
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:105

Class WithdrawalWorkflowService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WithdrawalWorkflowService

Methods

retry

Parameters

return

Parameters

Returns Promise<{ ok: true; value: void }>

Settings

On This Page