Data Types

This section describes the common data structure types and field specifications used consistently across the API. These structures are reused across multiple endpoints and documented here to ensure consistency.

Primitive Types

Common

Amount

Represents a monetary amount. Values are stored in the smallest currency unit (e.g., cents) to avoid floating-point precision issues.

Address

Represents a physical or mailing address. All fields are optional and should be provided as needed.

UserName

Represents personal name information. Supports both individual name components (first, middle, last) and a combined full name.

Example Values

Below is a quick reference of typical example values for each data type.