Payment Method and Terms Improvements

We've enhanced our payment handling for Carrier API users to better distinguish between payment methods and terms. This update maintains backward compatibility with clearer payment fields.

What's New

1. Updated Payment Structure

• Added fields directly in the payment object:
  • payment_method: Specifies how payment is made (e.g., Cash, ACH, Credit Card)
  • payment_terms: Specifies when payment is due (e.g., 2 Days, On Delivery)

2. Backward Compatibility

• The legacy payment.terms field will remain supported until April 30, 2025
• All new integrations should use the updated payment object
• Legacy terms will be automatically mapped to new fields

Deprecation Notice

Old Field	Status	Replacement	Deadline
payment.terms	Deprecated	payment.payment_method and payment.payment_terms	May 30, 2025

Migration Steps

1. Update requests to use new structure:

"payment": {
  "payment_method": "ach",
  "payment_terms": "2_days"
}

2. Remove payment.terms from your implementation
3. Test with both field formats during transition period

Updated API Documentation

Create Order

POST <base_url>/orders/

Request Body

{
  "...": "...",
  "payment": {
    "terms": "ach", // will be DEPRECATED - Use payment_details instead
    "payment_method": "ach",
    "payment_terms": "2_days"
  }
}

Payment Method Options

• cash - Cash
• check - Check
• cashiers_check - Cashier's Check
• money_order - Money Order
• comchek - Comchek
• ach - ACH
• direct_deposit - Direct Deposit
• credit_card - Credit Card
• venmo - Venmo
• cashapp - CashApp
• uship - UShip
• zelle - Zelle
• superpay - SuperPay
• other - Other

Payment Term Options

• on_delivery - On Delivery
• on_pickup - On Pickup
• cash_on_delivery - Cash on Delivery
• cash_on_pickup - Cash on Pickup
• check_on_delivery - Check on Delivery
• check_on_pickup - Check on Pickup
• quickpay - Quick Pay
• 2_days - 2 Business Days
• 5_days - 5 Business Days
• 7_days - 7 Business Days
• 10_days - 10 Business Days
• 15_days - 15 Business Days
• 20_days - 20 Business Days
• 30_days - 30 Business Days
• 45_days - 45 Business Days
• 60_days - 60 Days
• other - Other

Legacy Term Mapping

Legacy Value	New Method	New Term
ach	ach	(use payment_terms)
comchek	comchek	(use payment_terms)
cash_on_pickup	cash	on_pickup
cash_on_delivery	cash	on_delivery
check_on_delivery	check	on_delivery
on_pickup	(use payment_method)	on_pickup
on_delivery	(use payment_method)	on_delivery
5_days	(use payment_method)	5_days

Full Example Request

{
  "driver_id": 1,
  "number": "ORDER-123",
  "payment": {
    "payment_method": "credit_card",
    "payment_terms": "7_days"
  },
  "customer": {
    "...": "..."
  },
  "...": "..."
}

Recommendations

1. Immediate Action

• Begin using the updated payment object in all new order creations
• Read from payment.payment_method and payment.payment_terms for order details
• Update existing integrations by May 30, 2025

2. Monitoring

• We'll send reminder emails 30 days before deprecation

3. Support

• Contact support@superdispatch.com for migration assistance