Skip to content
IN PROGRESS

This site is under active development. The sandbox is coming soon.

This is an independent, unofficial personal learning project. It does not represent any bank, financial institution, or regulator.

Versioning & changes

The API version is part of the path, for example /v1. Version numbers in the documentation match the API paths.

  • Major: incompatible changes, released as a new path version.
  • Minor: new fields or endpoints, backward compatible.
  • Patch: documentation fixes and additional error codes, with no change to API behavior.

Within the same major version, we commit to:

  • Not removing or renaming existing fields
  • Not changing the type or meaning of existing fields
  • Clients ignoring unknown fields when new fields are added
  • Added the X-Sandbox-Scenario sandbox header
  • Payments API supports the CANCELLED status
  • Added the remittance_information field to the Transactions API
  • Added request_id to all error responses