Documentation conventions

Data formats

Format name	Description	Example value
datetime	URL-encoded UTC ISO string	2021-04-17T19:23:26.909989+00:00
amount_dict	JSON dictionary with two child fields: - amount: an integer value. - currency: a string representation of the amount's denomination.	{{"amount": { "amount": 1, "currency": "USD" }}
dict	JSON dictionary	"settlements": [{...},{...}]
integer	JSON integer	4
string	JSON string	purchase
boolean	JSON boolean	true

Nesting

Details of nested parameters will be documented in a separate, linked table on the same page.

For example, the representation below shows that the parameters amount and currency are nested within the Price object, which is nested within the Items Array.

Example Parent Parameter

Parameter name	Necessity	Format	Description
one	required	string (ISO 4217)	Example description
two	required	object	Example description for object with nested values found in the secondary table below.
three	required	integer	Example description

Example Child Parameter

Parameter name	Necessity	Format	Description
child_alpha	required	integer	Example description
child_beta	optional	string (ISO 4217)	Example description