Data Conventions
Empty values
The API doesn't support empty values such as null, undefined
etc and the validation step will fail the request
Date Format
The API supports two date formats:
-
ISO 8601 (UTC)
- Format: YYYY-MM-DDTHH:MM:SSZ
- Example:
2023-01-15T12:30:00Z
- All dates using this format follow the ISO 8601 standard in UTC
-
Unix Timestamp
- Format: Integer representing seconds since January 1, 1970, 00:00:00 UTC
- Example:
1673785800
(equivalent to 2023-01-15T12:30:00Z)
Both formats are accepted in all API endpoints that require date/time values.
Currency Format
For currency information, the ISO 4217 standard is used:
- Format: Three-letter currency code
- Example:
USD
(United States Dollar),EUR
(Euro)
- Example:
Boolean Values
Boolean values represent true or false:
- Format:
true
orfalse
Numeric Values
Numeric values, unless otherwise specified, are represented as decimals:
- Format: Decimal numbers
- Example:
150.99
- Example:
Text
Textual data, unless otherwise specified, is represented as strings:
- Format: UTF-8 encoded strings
Identifiers
Identifiers, such as unique IDs, are represented as strings:
- Format: Alphanumeric strings
- Example:
id: "cb001"
- Example:
Array Format
Array items should be sent as the following example:
{
"chargebackId": "example_chargeback_id",
"transactionOrderItems": [
{
"transactionOrderItemsProductPriceCurrency": "USD",
"transactionOrderItemsProductPriceValue": 15.20
},
{
"transactionOrderItemsProductPriceCurrency": "USD",
"transactionOrderItemsProductPriceValue": 16.20
}
]
}
Example Response with Data Conventions
{
"id": "cb001",
"amount": 150.99,
"status": "active",
"timestamp": "2023-01-15T12:30:00Z",
"currency": "USD",
"isCompleted": true,
"description": "Chargeback for disputed transaction"
}
Updated about 1 month ago
Did this page help you?