Deposit Status
Overview
Every deposit carries a status that tells you where it is in its lifecycle. This status is represented two ways: as a Status Number and as a Status Enum.
Status Number vs. Status EnumUse Status Number when retrieving (
GET) deposit requests. Use Status Enum only when updating (PATCH) a deposit request.
| Status Description | Status Number | Status Enum | Definition |
|---|---|---|---|
| Started | 0 | "STARTED" | The deposit has been initiated. |
| Pending | 1 | "PENDING" | The default status for every new self-directed account deposit. From here, the deposit moves to Rejected, On Hold, or Approved. |
| Successful | 2 | "SUCCESSFUL" | The deposit was successfully processed and completed. |
| Failed | 3 | "FAILED" | The deposit was unable to be completed. |
| Returned | 5 | "RETURNED" | The deposit is marked Returned when DriveWealth receives notification from the bank that it failed. |
| Approved | 14 | "APPROVED" | The deposit will be processed once it is marked Approved. |
| Rejected | 15 | "REJECTED" | Updating a deposit to Rejected immediately sets its status to Failed. |
| On Hold | 16 | "ON_HOLD" | Reserved for deposits that are not yet ready for processing. |
| Unknown | -1 | — | Reserved for errors. This value has no corresponding enum. |
Updated 7 days ago
Did this page help you?