Skip to content

API changelog

  • payment_method now works when confirming a booking. Previously only create accepted the flat payment_method string; confirm silently ignored it and fell back to your credit account, which surfaced as a confusing 403 NO_PAYMENT_METHOD. Both endpoints now take the same value, and it is the same id that GET /api/members/payment-methods returns.
  • New "credit" token — bill your credit account explicitly, instead of selecting it by leaving the field out. See how payments work.
  • Clearer payment errors. An unrecognised payment_method, a malformed id, or a misspelt field name (for example payment-method instead of payment_method) now returns a 400 naming the problem. Previously these were ignored and the request quietly fell through to the credit-account path.
  • payment_method and payment may be sent together as long as they select the same method. Naming two different methods returns a 400 rather than one silently winning.
  • GET /api/members/payment-methods now also returns card_id and agreement_id (v4 only), so you do not have to strip the nab_ prefix to build a confirm request. GET /api/v4/members/me/cards is accepted as an alias of the same endpoint.
  • New documentationhow payments work and a reference page for listing payment methods.
  • Terms and information-package acceptance is recorded when an API key is issued.
  • Developer Center rebuilt around v5, with an interactive API Explorer and the @transdirect/api-sdk TypeScript SDK. See SDKs and versioning.
  • @transdirect/api-sdk published, generated from the v5 OpenAPI spec.
  • Booking items accept an {id} path parameter, and demo confirmation behaves the same on v4 and v5.
  • API access is now open by default. The manual “validate your account to enable API access” step was removed. Any API key can quote immediately, and a booking goes live as soon as you can pay for it. See the access model.
  • Demo mode added — a flag on your normal API key that exposes a synthetic Demo courier, so you can run a full quote, book, label and track cycle with no charge and nothing shipped. See demo mode.
  • Multipickup upgraded to Frequent rates — discounted pricing for members shipping several parcels from the same address on the same day, on Couriers Please and Aramex.
  • Order boxing functionality updated — improvements to the order boxing API for better packing calculations.
  • Multipickup functionality added — initial release of the multipickup system for Couriers Please and Aramex, allowing discounted rates for multiple pickups from the same address on the same day.
  • Order boxing functionality added — new API support for consolidating multiple items into defined box sizes for more efficient quoting.