Skip to main content

Additional data format

Most requests to the Tranzzo API, in addition to a set of mandatory and optional parameters specific to a particular type of request, may also contain additional data. That is, if you wish, you can add any information up to 4000 characters to requests for further use for your own needs.

Additional data in requests can be structured or unstructured. To store additional data in a structured format such as JSON or XML, simply convert the binary data using Base64 to prevent JSON-specific characters from being used in the request body.

To store additional data in the request, use the payload parameter.

An example of placing additional data in a parameter (converted using Base64):

{
"...": "...",
"payload": "eyJ0aGlzIGlzIjogInBhc2hhbG9jaGthIn0K"
}