Whenever you send a request to our platform, you need to provide specific information by using parameters. This accounts for any scenario, such as (just to name a few):

The same principle also applies to our platform sending information to you, i.e. for

To ensure our platform processes your requests correctly, you need to

  • Get all mandatory/recommended/optional parameters from the respective guide
  • Consult this Parameter Cookbook to assign correct values to them

Learn here how to read the individual columns:

  • Field name: Name of the parameter
  • Details: A detailed description about the parameter's purpose in a request
  • Input: Can you send the parameter in a request to our platform? If sent anyway, our platform ignores it 
  • Output: Is the parameter included in notifications sent from our platform?
  • Format: Data type 
  • Max Length: Maximum amount of characters
  • Example: A typical value to give you an idea of the expected value, allowed format and maximum length