All PPRO API endpoints support JSON payloads and follow standard HTTP methods (GET, POST, etc.) to enable smooth customer interactions. To ensure consistency and simplicity, all PPRO API endpoints use a unified structure for representing value objects.

Identifiers

All API resources are identified by a unique string identifier. Each identifier includes a prefix indicating the resource type, for example:

charge_ for payments
refund_ for refunds

Identifiers can contain up to 21 characters following the prefix.

Date and time

All date-time fields use ISO 8601 format:

YYYY-MM-DDTHH:mm:ss.sssZ

Example: "2025-06-21T08:34:20.766Z"

All timestamps are in UTC, ensuring consistent interpretation across time zones.

Currency code and amount

All currencies follow ISO 4217 standards (e.g., "GBP", "EUR", "USD").
The amount field is expressed in minor units, based on the currency’s ISO 4217 minor unit definition:

Currency	Example Value	Minor Units
USD	10.00	1000
JPY	100	100

Character encoding

All string values are encoded in UTF-8. The maximum permitted length for any string value is 512 characters.

Field ordering

JSON fields are organized in a logical order to enhance readability and make the structure easier to understand. Fields are grouped by related functionality or context rather than being sorted alphabetically, helping developers quickly locate and interpret the data they need.

Note: Although the fields are presented in a specific order for readability, JSON objects are inherently unspecified in order, so code should not rely on field order.