Extract Receipt (General) Data

Extracted Data Types

The following types will always be present in the API response. If a type parameter is not found in the input, its value will be null.

Parameter Name	Variable Type
`receipt_vendor_country`	string \| null
`receipt_vendor_state`	string \| null
`receipt_vendor_name`	string \| null
`receipt_vendor_address`	string \| null
`receipt_vendor_contact_number`	string \| null
`receipt_SST_number`	string \| null
`receipt_number`	string \| null
`receipt_date`	string \| null
`receipt_time`	string \| null
`receipt_items[]`	Array of objects
`receipt_items[].item_quantity`	string \| null
`receipt_items[].item_description`	string \| null
`receipt_items[].item_per_unit_price`	string \| null
`receipt_items[].item_amount_before_discount`	string \| null
`receipt_items[].item_amount_after_discount`	string \| null
`receipt_items[].item_category`	string \| null
`receipt_subtotal`	string \| null
`receipt_tax`	string \| null
`receipt_service_charge`	string \| null
`receipt_total_include_tax`	string \| null
`receipt_total_paid`	string \| null
`receipt_discount`	string \| null
`receipt_currency`	string \| null
`receipt_tax_in_percentage`	string \| null
`receipt_service_charge_in_percentage`	string \| null

Notes

Each type parameter in the data array will always have the specified type, with the possibility of being null.

If a specific type parameter is not present in the input, its value in the response will be null.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "type": "receipt_vendor_country",
            "value": "Malaysia"
        },
        {
            "type": "receipt_vendor_state",
            "value": "Selangor"
        },
        {
            "type": "receipt_vendor_name",
            "value": "EXAMPLE EATERY SDN BHD"
        },
        {
            "type": "receipt_vendor_address",
            "value": "No.99, Jalan Fantasi, 40000 Shah Alam, Selangor, Malaysia."
        },
        {
            "type": "receipt_vendor_contact_number",
            "value": "03-1234 5678"
        },
        {
            "type": "receipt_SST_number",
            "value": "M10-1907-98765432"
        },
        {
            "type": "receipt_number",
            "value": "00987654"
        },
        {
            "type": "receipt_date",
            "value": "10/05/2025"
        },
        {
            "type": "receipt_time",
            "value": "06:15"
        },
        {
            "type": "receipt_items",
            "value": [
                {
                    "item_quantity": "2",
                    "item_description": "SPECIAL GRILLED CHICKEN",
                    "item_per_unit_price": null,
                    "item_amount_before_discount": null,
                    "item_amount_after_discount": "2.50",
                    "item_category": null
                },
                {
                    "item_quantity": "1",
                    "item_description": "STEAMED RICE",
                    "item_per_unit_price": null,
                    "item_amount_before_discount": null,
                    "item_amount_after_discount": "2.50",
                    "item_category": null
                },
                {
                    "item_quantity": "1",
                    "item_description": "FRUIT PUNCH",
                    "item_per_unit_price": null,
                    "item_amount_before_discount": "2.8",
                    "item_amount_after_discount": "2.5",
                    "item_category": null
                }
            ]
        },
        {
            "type": "receipt_subtotal",
            "value": "24.50"
        },
        {
            "type": "receipt_tax",
            "value": "1.60"
        },
        {
            "type": "receipt_service_charge",
            "value": null
        },
        {
            "type": "receipt_total_include_tax",
            "value": "26.10"
        },
        {
            "type": "receipt_total_paid",
            "value": null
        },
        {
            "type": "receipt_discount",
            "value": null
        },
        {
            "type": "receipt_change",
            "value": null
        },
        {
            "type": "receipt_currency",
            "value": null
        },
        {
            "type": "receipt_tax_in_percentage",
            "value": null
        },
        {
            "type": "receipt_service_charge_in_percentage",
            "value": null
        }
    ],
    "verification": {
        "verified": true,
        "description": "Receipt validation successfully verified."
    },
    "miscellaneous": {
        "processedTime": 6.789456123
    }
}

Extract Receipt (General) Data

Extracted Data Types#

Notes#

Request

Request samples

Responses

Extracted Data Types

Notes