Custom IDs

To add this ID, add the custom_id field to your requests. This ID is returned by the API in subsequent responses.

The custom_id field can be added at the Transaction or Transaction Line levels.

The Transaction level reference is not mandatory.

The Transaction Line level reference is mandatory. The custom_id field is required for schema validation but you do not have to enter a value.

The following example shows the field in a transaction object in a request:

{
    "transaction": {
        "tax_timestamp": "2025-03-01T12:00:00Z",
        "description": "Transaction description",
        "currency_code": "EUR",
        "buyer_name": "Test buyer",
        "ship_to_address": {
            "country_code": "GB",
            "city": "Big city",
            "street_name": "Street name",
            "building_number": "100a",
            "address_detail": "2nd fl",
            "postal_code": "00000"
        },
        "billing_address": {
            "country_code": "GB",
            "city": "The big city",
            "street_name": "The street name",
            "building_number": "100a",
            "postal_code": "00000"
        },
        "transaction_lines": [
            {
                "amount": 100,
                "custom_id": "",
                "ship_from_address": {
                    "country_code": "GB"
                },
                "description": "Product 1",
                "product_class": "P",
                "product_tax_code": {
                    "class": "TPP/Goods"
                }
            },
            {
                "amount": 100,
                "custom_id": "",
                "ship_from_address": {
                    "country_code": "GB"
                },
                "description": "Shipping",
                "product_class": "S"
            }  
        ]
    }
}