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

All dates in the API follow the ISO 8601 standard in UTC:

• Format: YYYY-MM-DDTHH:MM:SSZ
  • Example: 2023-01-15T12:30:00Z

Currency Format

For currency information, the ISO 4217 standard is used:

• Format: Three-letter currency code
  • Example: USD (United States Dollar), EUR (Euro)

Boolean Values

Boolean values represent true or false:

• Format: true or false

Numeric Values

Numeric values, unless otherwise specified, are represented as decimals:

• Format: Decimal numbers
  • Example: 150.99

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"

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"
}