Class WithdrawalWorkflowService

Reusable activities used by various withdrawal workflows

Index

Constructors

Methods

commitRedemption debitRedemptionWallet getPendingWalletId getRedemption initiateRedemption refundToRedemptionWallet takeFeesFromPendingRedemptionWallet voidRedemption

Constructors

constructor

new WithdrawalWorkflowService(
    args: {
        feeWallet: { address: PublicKey; walletId: string };
        mintfxProgram: MintfxProgram;
        redemptionAdminQueryService: RedemptionAdminQueryService;
        redemptionWalletService: RedemptionWalletService;
        redemptionWorkflowService: RedemptionWorkflowService;
        solanaKeypairService: SolanaKeypairService;
        solanaTransactionService: SolanaTransactionService;
        usAchPendingWallet: { address: PublicKey; walletId: string };
        usInstantPendingWallet: { address: PublicKey; walletId: string };
        wirePendingWallet: { address: PublicKey; walletId: string };
        withdrawalAdminService: WithdrawalAdminService;
    },
): WithdrawalWorkflowService
Parameters
- args: {
      feeWallet: { address: PublicKey; walletId: string };
      mintfxProgram: MintfxProgram;
      redemptionAdminQueryService: RedemptionAdminQueryService;
      redemptionWalletService: RedemptionWalletService;
      redemptionWorkflowService: RedemptionWorkflowService;
      solanaKeypairService: SolanaKeypairService;
      solanaTransactionService: SolanaTransactionService;
      usAchPendingWallet: { address: PublicKey; walletId: string };
      usInstantPendingWallet: { address: PublicKey; walletId: string };
      wirePendingWallet: { address: PublicKey; walletId: string };
      withdrawalAdminService: WithdrawalAdminService;
  }
Returns WithdrawalWorkflowService
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:44

Methods

commitRedemption

commitRedemption(
__namedParameters: { commitId: string; withdrawalId: string },
): Promise<void>
Parameters
- __namedParameters: { commitId: string; withdrawalId: string }
Returns Promise<void>
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:338

debitRedemptionWallet

debitRedemptionWallet(
__namedParameters: { withdrawalId: string },
): Promise<string>
Debits withdrawal amount from the source redemption wallet into the pending redemption wallet
Parameters
- __namedParameters: { withdrawalId: string }
Returns Promise<string>
The signature of confirmed Solana transaction
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:113

getPendingWalletId

getPendingWalletId(
    methodId:
        | "US_WIRE"
        | "SWIFT_WIRE"
        | "US_ACH"
        | "US_INSTANT"
        | "MX_SPEI"
        | "US_WIRE_DRAWDOWN"
        | "AF_WITHDRAWAL"
        | "ACH_PULL"
        | "BLOCKCHAIN",
): string
Parameters
- methodId:
      | "US_WIRE"
      | "SWIFT_WIRE"
      | "US_ACH"
      | "US_INSTANT"
      | "MX_SPEI"
      | "US_WIRE_DRAWDOWN"
      | "AF_WITHDRAWAL"
      | "ACH_PULL"
      | "BLOCKCHAIN"
Returns string
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:70

getRedemption

getRedemption(
    __namedParameters: { withdrawalId: string },
): Promise<
    {
        achBatchId?: string;
        amount: string;
        commitId?: string;
        commitTxId?: string;
        createdAt: Date;
        id: string;
        idempotencyKey: string;
        initiateTxId?: string;
        redemptionWalletId: string;
        status: "PENDING"
        | "FAILED"
        | "COMMITTED"
        | "VOIDED";
        updatedAt: Date;
        voidTxId?: string;
        withdrawalId?: string;
    } & { customerId: string },
>
Parameters
- __namedParameters: { withdrawalId: string }
Returns Promise<
    {
        achBatchId?: string;
        amount: string;
        commitId?: string;
        commitTxId?: string;
        createdAt: Date;
        id: string;
        idempotencyKey: string;
        initiateTxId?: string;
        redemptionWalletId: string;
        status: "PENDING"
        | "FAILED"
        | "COMMITTED"
        | "VOIDED";
        updatedAt: Date;
        voidTxId?: string;
        withdrawalId?: string;
    } & { customerId: string },
>
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:505

initiateRedemption

initiateRedemption(__namedParameters: { withdrawalId: string }): Promise<string>
Parameters
- __namedParameters: { withdrawalId: string }
Returns Promise<string>
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:84

refundToRedemptionWallet

refundToRedemptionWallet(
__namedParameters: { amount: string; withdrawalId: string },
): Promise<string>
Refund the amount from pending wallet to user's redemption wallet
Parameters
- __namedParameters: { amount: string; withdrawalId: string }
Returns Promise<string>
Solana transaction signature
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:404

takeFeesFromPendingRedemptionWallet

takeFeesFromPendingRedemptionWallet(
__namedParameters: { withdrawalId: string },
): Promise<string>
Transfer fees from pending redemption wallet to our fees redemption wallet.

This should be called when withdrawal has successfully completed.
Parameters
- __namedParameters: { withdrawalId: string }
Returns Promise<string>
Solana transaction signature
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:232

voidRedemption

voidRedemption(
    __namedParameters: { withdrawalId: string },
): Promise<
    {
        achBatchId?: string;
        amount: string;
        commitId?: string;
        commitTxId?: string;
        createdAt: Date;
        id: string;
        idempotencyKey: string;
        initiateTxId?: string;
        redemptionWalletId: string;
        status: "PENDING"
        | "FAILED"
        | "COMMITTED"
        | "VOIDED";
        updatedAt: Date;
        voidTxId?: string;
        withdrawalId?: string;
    },
>
Void the redemption and refund to the withdrawal's source wallet
Parameters
- __namedParameters: { withdrawalId: string }
Returns Promise<
    {
        achBatchId?: string;
        amount: string;
        commitId?: string;
        commitTxId?: string;
        createdAt: Date;
        id: string;
        idempotencyKey: string;
        initiateTxId?: string;
        redemptionWalletId: string;
        status: "PENDING"
        | "FAILED"
        | "COMMITTED"
        | "VOIDED";
        updatedAt: Date;
        voidTxId?: string;
        withdrawalId?: string;
    },
>
the redemption (void in progress)
- Defined in packages/withdrawal-services/src/WithdrawalWorkflowService.ts:364

Class WithdrawalWorkflowService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WithdrawalWorkflowService

Methods

commitRedemption

Parameters

Returns Promise<void>

debitRedemptionWallet

Parameters

Returns Promise<string>

getPendingWalletId

Parameters

Returns string

getRedemption

Parameters

initiateRedemption

Parameters

Returns Promise<string>

refundToRedemptionWallet

Parameters

Returns Promise<string>

takeFeesFromPendingRedemptionWallet

Parameters

Returns Promise<string>

voidRedemption

Parameters

Settings

On This Page