The version is in the URL: /v1. Within v1: Added without notice (build your code to accept them):
  • new endpoints
  • new optional request parameters
  • new fields on objects
  • new values in enums such as statuses, event types and error codes
  • new webhook event types
Never changed in v1:
  • removing or renaming an endpoint, field or parameter
  • making an optional parameter required
  • changing a field’s type or meaning
Anything breaking ships as a new version, announced in advance with a dated changelog, and v1 keeps working alongside it.

Writing code that lasts

  • Ignore fields you don’t recognise.
  • Handle unknown enum values with a sensible default (for example, treat an unknown event type as “ignore”).
  • Branch on error code, never on message.

Beta

The API is in beta with design partners. Changes during the beta follow the same rules, and the libraries are published under beta tags (@ketapay/node@next, ketapay/ketapay-php:@beta).