get https://uatclientapi-v2.stockal.com/client/v2/redemption/
Get details on a specific redemption request
Redemption Status
Name | Number | Enum | Description |
---|---|---|---|
Started | 0 | "STARTED" | |
Pending | 1 | "PENDING" | Every new redemption for a self-directed account is set to "Pending". From here, the redemption can be marked as "Rejected", "On Hold" or "Approved". |
Successful | 2 | "SUCCESSFUL" | After a redemption is marked "Approved", the next step is "Successful". This is used statuses are used when |
Failed | 3 | "FAILED" | If a redemption is marked as "RIA Rejected" or "Rejected", the redemption will immediately be set to "Failed". |
Other | 4 | "OTHER" | |
Approved | 14 | "APPROVED" | Once marked as "Approved", the redemption will be processed for disbursements. |
Rejected | 15 | "REJECTED" | Updating a redemption to "Rejected" will immediately set it 's status to "Failed" |
On Hold | 16 | "On_Hold" | The "On Hold" status is reserved for redemptions that aren't ready to be processed. E.g. Funds are still settling. |
Unknown | -1 |
Redemption Workflow
Successful | "Pending" | ➡ | "Approved" | ➡ | "Successful" | ✅ | ||
Rejected | "Pending" | ➡ | "Rejected" | ➡ | "Failed" | ❌ | ||
On Hold | "Pending" | ➡ | "On Hold" | ➡ ➡ | "Approved" "Rejected" | ➡ ➡ | "Successful" "Failed" | ✅ ❌ |