Important
The API will evolve over time
This is one of the most crucial things to keep in mind when using the Neteven Merchant API:
At any point in time, Neteven can decide to add new attributes to existing endpoints. This means that the body of a request or response may change. While this will always be done in a way to preserve backward compatibility, you should ensure that you are aware of this and design the interactions with the API accordingly.
Information
We strongly advise that you only update or read attributes that matter to you, ignoring the ones you don't need. That way, a newly added attribute would simply get ignored by your system without breaking the existing code.
Authentication best practices
In order to use the Merchant API, you must first have an authorized user account at Neteven. Every individual user has an authorized scope, which translates to specific callable endpoints.
Scope and Permissions
If you get an HTTP 403 Forbidden response when calling a specific API endpoint, please consider contacting Neteven to ensure you have the proper scopes and permissions.
The Authentication generates a time limited JWT token to be used in the HTTP header of the calls you are making to the API. Do NOT generate a token for each individual call. Instead, make good use of the time frame during which your token is valid, and only regenerate one when your previous token has expired.
API rate limiting
Every API Endpoint has a set limit of call that can be done per minute and per hour. When you exceed said limits, you will get a HTTP 429 error code. We strongly suggest that you implement an "exponential backoff" retry algorithm to prevent from calling the API more than necessary.
Note
Neteven reserves the right to temporarily ban you from the use of certain resources should we consider that you are misusing the API (pushing unnecessary data too often, repeated invalid requests, etc.) In such case, we will contact you to let you know that you have been blocked and we will expect you to fix the issue before re-authorizing you.
Error handling
The API returns standardized HTTP codes in reponse headers as well as status codes within the response body when applicable. Make sure you properly integrate these to optimize the way you interact with the API (and avoid constantly sending invalid content).
More information about this here: Request content and responses and Error handling