As Finix improves our products and features, we will make changes to our APIs. When breaking changes are made to Finix's API, a new dated version is released. A breaking change is a change in Finix's API that makes your current integration with Finix incompatible. More commonly, we make non-breaking changes that don't result in a new released version.
The API version your requests use controls how API responses and webhooks behave (for example, the values you see in responses, the parameters you're sending in requests, etc.).
When a breaking change is introduced to Finix's API, a new version is released to put the changes behind. To avoid compatibility issues and take advantage of all the improvements Finix introduces, we recommend always using the latest version of the Finix API.
To use the latest version of Finix's API, you need to include the following versioning header, including the date, with every request.
The header needs to include the exact versioning date. If there are any changes or mistakes in the date, requests will default to the base version of Finix's API.
curl 'https://finix.sandbox-payments-api.com/transfers?limit=3&after_cursor=TRt2F1j2ST3ijbsmPVXB6Ztf' \ -H "Content-Type: application/vnd.json+api" \ # Specify the version of Finix's API you want to use. -H 'Finix-Version:2022-02-01' \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
A non-breaking change is a backward-compatible change in Finix's API that allows your integration to continue using Finix's API without any changes on your end.
Non-breaking changes include:
- Adding new resources.
- Adding new enum values.
- Adding optional fields to requests.
- Adding new fields to responses.
Changing the length and format of ID fields.
- Finix's ID fields will never exceed 255 characters.
Here are the changes and updates in the different versions of Finix's API. Include the specified header in your requests, to use that version of Finix's API.
- We've improved the performance of querying endpoints by introducing cursor-based pagination to Finix's API. For details on how to migrate your requests to cursor-based navigation, see Migrating to Cursor Pagination .
- If you don't include a version header and date, your requests will default to this base version of Finix's API.