API Stability

We will make backwards-compatible changes to finperks Giftcard API without releasing a new version. This means we will not break existing code accessing the API as far as the specifically outlined API specification goes. Changes may affect observed behaviour and depending on which assumptions where made during integration, this may have an effect. If you are unsure if you can make a specific assumption, please contact us.

Your code should be able to handle the following scenarios:

• Adding new resources.
• Adding new optional request body or query parameters.
• Adding new parameters to response bodies.
• Adding new body parameters to webhook requests.
• Changing the length or format of id or token parameters. Always store parameters we return as string as such, even if they only contain numbers, unless explicitly specified as numeric. The parameters will never exceed the maximum length specified in the JSON schema.
• Adding new error codes.Your code must be able to handle an unknown error code.
• Changing error messages. Never write code parsing them or using them for anything else than showing them to people, see Errors.

If we need to make changes which likely break systems using the API in the future, we will release a new version of the API. Examples for such backwards-incompatible changes are:

• Removing resources.
• Removing properties from response bodies.
• No longer accepting properties in request bodies.
• Changing body property types or increasing their length beyond the length specified in the JSON schema.
• Removing slip types.