Applies to integrated customers using the RecoveryConnect API
Update Collateral
Description: This endpoint updates the details of an existing collateral associated with an order.
Only the fields provided in the request body will be updated. Fields not included in the request will remain unchanged.
URL: /api/v150/orders/{order_id}/collaterals/{collateral_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
year | Manufacturing year of the collateral (vehicle) | No | 2008 |
make | Manufacturer or brand of the vehicle | No | Ford |
model | Model name of the vehicle | No | Silverado 1500 |
color | Vehicle color | No | Yellow |
drive_train | Type of drivetrain used in the vehicle | No | Rear Wheel Drive |
fuel_type | Type of fuel used by the vehicle | No | Gasoline |
engine | Engine specification of the vehicle | No | 8 Cylinder Engine |
key_codes | Key code information for the vehicle | No | ABC123 |
additional_info | Additional information or remarks related to the collateral | No | color could be blue |
plate_number | Vehicle license plate number | No | DLNRCO |
plate_state | State where the license plate is registered | No | CA |
identification_number | Vehicle Identification Number (VIN) or unique identification number of the collateral | No | 2GCEC19T921286485 |
status | Numeric value representing the status (0 = Open, 1 = Close) | No | 1 |
status_note | Additional remarks explaining the status update | No | This case is no longer needed |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57062885/collaterals/58842868 |
Request Body: NA
Response:
{ "data": { "id": 58842868, "is_primary": 1, "vehicle_type_id": 2, "vehicle_type": "Truck", "year": "2008", "make": "Ford", "model": "Nissan 1500", "color": "Yellow", "drive_train": "Rear Wheel Drive", "fuel_type": "Gasoline", "engine": "8 Cylinder Engine", "selling_dealer": "", "original_loan_amount": "0", "payment_amount": "0", "past_due_amount": "0", "unpaid_balance": "0", "chargeoff_date": "No Data", "key_codes": "-undefined", "maximum_bailout": "0.00", "additional_info": "color could be blue", "contract_date": "No Data", "license_no": "DLNRCO", "license_state": "CA", "license_exp": null, "vin": "2GCEC19T921286485", "status": "Repossessed", "status_id": 3, "status_date": "2026-02-17 10:48:34", "status_reason": null, "status_note": null, "on_hook_by": null, "assignment_on_hook_by": { "id": 119399, "company_id": 10001, "name": "Priya Jayakumar", "firstname": "Priya", "lastname": "Jayakumar", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Field Agent", "Field Agent Supervisor ", "Investigator", "Alpha Tester", "API Connection", "Case Worker", "Compliance Officer", "API Connection", "API Connection", "Accountant", "Alpha Tester", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker", "Compliance Officer", "Field Agent", "Field Agent Supervisor ", "Investigator", "Lot Person", "Lot Supervisor", "Manager Recovery Pro", "Owner", "Remarketing", "Skip Tracer", "Spotter", "Transportation", "Administrator" ], "self": "http://stg-api.mbsisystems.com/api/employees/119399", "expand": "employee", "employee_id": 119399, "latitude": "0.00000000", "longitude": "0.00000000", "created_at": "2026-02-17 10:47:17", "updated_at": "2026-02-17 10:47:17" }, "vehicle_value": null, "created_at": "2026-02-17 10:45:02", "updated_at": "2026-03-07 12:06:19", "meta": [], "collateral_value": null, "collateral_value_added": null }, "status": "success" } |
Place Redemption Hold on Order
Description: This endpoint is used to place or update a redemption hold on a specific collateral associated with an order.
A redemption hold is applied when the collateral should not be released or redeemed until further instructions. The request allows adding a note/update message and sending notification emails to specified recipients.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/{order_id}/collaterals/{collateral_id}/redemptionhold
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
update | Description or note explaining the redemption hold update | Yes | Sample Hold |
notification_email | List of email addresses that should receive notification about the redemption hold update | No | Xya1234@gmail.com |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57074673/collaterals/58854304/redemptionhold |
Request Body:
{ "update": "Sample", "notification_email": [ "examplemail@gmail.com" ] } |
Response:
[ { "id": 43855, "other_hold_type_id": 2, "order_id": 57074673, "company_id": 10004, "created_by_id": 408564, "created_at": "2026-03-13 14:27:19", "updated_at": "2026-03-13 14:34:57", "deleted_at": null }, { "id": 43856, "other_hold_type_id": 2, "order_id": 57074672, "company_id": 10004, "created_by_id": 408564, "created_at": "2026-03-13 14:27:19", "updated_at": "2026-03-13 14:34:57", "deleted_at": null } ] |
Remove Redemption Hold on Order
Description: This endpoint is used to remove an existing redemption hold placed on a specific collateral associated with an order.
Once the redemption hold is removed, the collateral becomes eligible for further redemption or release processes based on the order workflow.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/{order_id}/collaterals/{collateral_id}/redemptionhold
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57074673/collaterals/58854304/redemptionhold |
Request Body: NA
Response:
{ "success": true } |