Revision 2022-01-12: API v1 General Availability

Routable's first truly customer-centric API is now in general availability!

Back in May 2021, we announced that a brand-new, customer-centric API was in development here at Routable, and we're proud to say it's here! Starting with this release, we are transitioning to the new "v1" architecture for our API. This is a new major version and introduces significant breaking changes.

The v0 API will remain available to customers for some time, so it is not necessary to migrate immediately if you are currently using v0. We will reach out to existing customers using the v0 API to assist with migration to v1 in the future.

New Features in v1

In addition to general usability improvements conferred by our move to OpenAPI 3 and by simplifying the data model to focus exclusively on customer-facing actions, the v1 API introduces the following new functionality:

You can now send international payments to vendors in 52 countries. This feature is currently in closed beta - ask your Routable Customer Success Manager if you'd like to take part.

You can now filter payables by a variety of criteria, which will be of significant use to anyone looking to construct a payment dashboard of their own.

Not Yet Supported in v1

We're releasing our v1 API for use, but it doesn't yet have 100% of the features that our v0 API supports. We are working to add these as quickly as possible. Customers needing the functionality listed below should continue to use v0 for these tasks for the time being.

  • While our Payables functionality has received a much-needed facelift in v1, we do not yet support Receivables through the v1 API.

  • File attachments to Payables are not yet supported.

  • Callers cannot yet specify which approvers to route a payable to for approval; they are all sent to the default approver(s).

  • Callers cannot yet specify custom check data.

Migrating from v0 API

If you are currently using the most recent version of the v0 API (2021-02-11), your existing API token will transition to v1 without issue. If you are using an earlier version, you will need to re-issue your token on your Account Dashboard. Your token will work on both v0 and v1, so you can use both versions in parallel, transitioning calls from v1 to v0 as need and your development timeline allows.

Several of the resources in our API have been renamed and refactored to be more user-friendly. Please view our Migrating from v0 (JSON:API) guide for details on these changes, and don't hesitate to reach out to our Developer Experience team at [email protected] for any assistance you may require.

Note that unlike the v0 API, v1 does not follow the JSON:API structure for responses. In our announcement blog post, we discussed the rationale behind this change, but in a nutshell, we found that it was simpler to adopt and to describe in OpenAPI 3 without the additional structure requirements imposed by JSON:API. This results in better documentation and an easier-to-understand system across the board.