Message format

  • All messages are in JSON format.
  • A unique MessageId is sent with all messages. The message ID identifies every response returned from Customer side. For generate unique value from customer we use GUID type. MessageId can help with troubleshooting and repeated requests.
  • All Entities, Fields and request params have PascalCase (upper camel case) format.
  • All enumeration values are sent in string representation.

Data types and formats

  • DateTime values for both request and response models should be in UTC format RFC3339. Example: 2000-02-30T23:20:50.52
  • Enumerations should be represented as string literals.
  • Floating-point numbers should use ‘.’ as decimal mark and without any delimiter of thousands. Example: 34823.14159265

Optional parameters

  • Optional String values for both request and response models which contain no data may be represented by either a empty string ("") or null*.
  • Optional data objects for requests and response models that contain no data may be represented as null.