SuperPay API

SuperPay is coming to the API. SuperPay is Super Dispatch's built-in carrier payment service: Super Dispatch collects the funds from your bank account and delivers them to the carrier. The new endpoints let you track every payment and act on it: pay now, schedule for a date, hold, cancel, or change the amount.

The API is enabled per account; contact [email protected] to request access.

Webhooks Reference SuperPay webhooks

API Reference SuperPay API

What Changes for Existing Integrations

• New value for order status field: delivery_verified, used for the SuperPay manual flow; new matching order activity codes: marked_as_delivery_verified and unmarked_as_delivery_verified.
• New order webhook actions for the SuperPay manual flow: order.marked_as_delivery_verified and order.unmarked_as_delivery_verified.
• Orders with SuperPay payment method reject some Orders API calls: mark_as_paid and unmark_as_paid return a 409 error; payment.method cannot change after delivery;
• After delivery price edits should be done via Update Payment

Nothing changes for orders that are not paid via SuperPay.