getDepositStatus - Zyfai Documentation

Fetch the current lifecycle state for a deposit registered via logDeposit or sendDeposit. Use this for one-off checks. To await credit after handover_pending, use waitForDepositCredit. Requires connectAccount() on the same ZyfaiSDK instance.

Signature

getDepositStatus(depositId: string): Promise<DepositLifecycleResponse>

Parameters

Parameter	Type	Required	Description
`depositId`	`string`	✅	Lifecycle UUID from `logDeposit().deposit.id` or `sendDeposit().registration.id`

Returns

Current deposit lifecycle state.

Return Type

type DepositLifecycleStatus =
  | "handover_pending"
  | "credited"
  | "recovered_to_eoa";

interface DepositLifecycleResponse {
  id: string;
  status: DepositLifecycleStatus;
  balanceCredited: boolean;
  statusUrl: string;
}

Field	Description
`status`	Custody and credit lifecycle stage
`balanceCredited`	Whether this deposit has been added to the Safe balance
`statusUrl`	Authenticated API path for polling (used internally by the SDK)

Treat a deposit as active only when status === "credited" and balanceCredited === true. handover_pending means the transfer is recorded but not yet investable.

Example

const result = await sdk.logDeposit(8453, txHash, "100000000");

const status = await sdk.getDepositStatus(result.deposit.id);
console.log(status.status);          // "handover_pending" | "credited" | "recovered_to_eoa"
console.log(status.balanceCredited);   // false until credit completes

if (status.status === "credited" && status.balanceCredited) {
  console.log("Deposit is investable");
}

waitForDepositCredit — poll until credited