Skip to main content

Payment Method & Payment Terms Validation and Vehicle Type Enhancements

1. Payment Method & Payment Terms Validation​

  • Added validation rules to ensure only valid payment method & payment terms pairs can be used
  • Implemented stricter checks to prevent incorrect or unsupported payment combinations
  • Improved error handling with descriptive user feedback for invalid entries
Supported Payment Methods & Payment Terms Pairs​
Payment MethodSupported Payment Terms
cashcash_on_pickup, cash_on_delivery, 2_days, 5_days
checkcheck_on_pickup, check_on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
cashiers_checkcheck_on_pickup, check_on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
money_ordercheck_on_pickup, check_on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
comchekcheck_on_pickup, check_on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
achon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
direct_depositon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
credit_cardon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
venmoon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
cashappon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
ushipon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
zelleon_pickup, on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
superpay1_3_days, 5_days, 10_days, 15_days, 20_days, 30_days
otherother, ach, cash_on_pickup, cash_on_delivery, quickpay, check_on_pickup, check_on_delivery, 2_days, 5_days, 7_days, 10_days, 15_days, 20_days, 30_days, 45_days, 60_days
Example Invalid Request​

Request: POST <base_url>/v1/public/orders

{
"payment": {
"method": "cash",
"terms": "10_days"
}
}

Response:

{
"status_code": 400,
"error": "Invalid payment terms '10_days' for method 'cash'. Allowed terms are: [cash_on_pickup, cash_on_delivery, 5_days, 2_days]"
}

2. Vehicle Type Validation​

  • Added vehicle.type as a mandatory field for all vehicle-related entries
  • Implemented validation rules to prevent incorrect vehicle type submissions
Supported Vehicle Types​
  • sedan
  • 2_door_coupe
  • suv
  • pickup
  • 4_door_pickup
  • van
  • truck_daycab
  • truck_sleeper
  • motorcycle
  • boat
  • rv
  • heavy_machinery
  • freight
  • livestock
  • atv
  • trailer_bumper_pull
  • trailer_gooseneck
  • trailer_5th_wheel
  • other
Example Invalid Request​

Request: POST <base_url>/v1/public/orders

{
"vehicles": [
{
"type": "car"
}
]
}

Response:

{
"status_code": 400,
"error": "Invalid vehicle type 'car'. Allowed types are: [sedan, 2_door_coupe, suv, pickup, 4_door_pickup, van, truck_daycab, truck_sleeper, motorcycle, boat, rv, heavy_machinery, freight, livestock, atv, trailer_bumper_pull, trailer_gooseneck, trailer_5th_wheel, other]"
}

General Improvements​

  • Optimized API request validation for better data quality.
  • Updated API documentation to reflect the latest validation rules.
Migration Steps​
  1. Ensure all API requests include valid payment.method and payment.terms pairs.
  2. Validate vehicle.type before submitting requests.
  3. Review API documentation for the updated validation rules.
Support​

For assistance, contact support@superdispatch.com.