V2 Endpoints

With the introduction of our template API we started to standardize the API responses and use a common response format.

Old endpoints are still supported and maintained unless they are marked as deprecated.

All API endpoints that have a structure like https://wallet.boostcommerce.com.au/api/v2…will return a JSON object like this.

Successful – data will contain the actual data that has been requested:

{
    "success": true,
    "description": "Request succeeded",
    "errors": [],
    "data": [],
    "statusCode": 200
}

Failure:

{
    "success": false,
    "description": "Invalid data.",
    "errors": [
        {
            "property": "name",
            "message": "The property name is required"
        },
        {
            "property": "type",
            "message": "The property type is required"
        },
        {
            "property": "expiration.expirationDate",
            "message": "The specified format was wrong. Please use Y-m-d H:i e.g. 2025-01-01 15:30"
        }
    ],
    "data": [],
    "statusCode": 400
}