Neatcar API Documentation

This endpoint allows to set a carwash payment intent as paid within the Neatcar platform. This operation requires authentication through a valid API token. This action is not offered on production, it's only for testing purposes.

POST

/user/payment-session-status

Response example

On successful setting of the carwash payment intent as paid, the response contains the carwash payment intent object with the carwash linked to it.

{
    "data": {
        "carwashPaymentIntent": {
            "redirectUrl": "http://localhost:8899/dev",
            "paymentSessionId": null,
            "paymentUrl": "/pay?uuid=c7da3a31-326a-4ca9-80f7-fbec793424f5",
            "storeId": 2594,
            "error": null,
            "userId": 940,
            "uuid": "c7da3a31-326a-4ca9-80f7-fbec793424f5",
            "transactionId": 679,
            "expiresAt": "2026-04-15T09:36:13Z",
            "resellerId": 4,
            "createdAt": "2026-04-15T09:21:13Z",
            "isSuccessful": true,
            "networkCarwashTypeId": 3,
            "storeCarwashTypeId": null,
            "id": 331,
            "isCompleted": true
        },
        "carwash": {
            "createdAt": "2022-04-27 07:20:19.0",
            "carwashType": {
                "carwashTypeId": 3,
                "createdAt": "2021-03-24 18:32:37.0",
                "innerCarwashType": {
                    "createdAt": "2021-03-24 18:25:32.0",
                    "price": 1599,
                    "nameFr": "Deluxe",
                    "nameEn": "Deluxe",
                    "id": 3,
                    "pricePro": 1299
                },
                "barcodeFormat": "UPCA",
                "price": 1599,
                "barcodeOnly": true,
                "nameFr": "Hydralux",
                "networkId": 1,
                "nameEn": "Hydralux",
                "id": 3,
                "source": "network",
                "pricePro": 1099
            },
            "id": 1411,
            "payoutId": 0,
            "expireAt": "2037-07-08"
        }
    },
    "success": true,
    "error": null
}

Possible errors

The following list provides a selection of possible errors that can occur when deleting a user. However, it is non-exhaustive. Developers can expect to find additional errors and data within the model, offering comprehensive information about each error.

HTTP 400

Bad Request due to missing parameters

This error is returned when the request is missing the carwashPaymentIntentUUID query parameter.

Error body response example:

HTTP 400

Bad Request due to invalid id

The carwashPaymentIntentUUID passed as a query parameter is invalid or does not exist.

Error body response example:

HTTP 400

Bad Request due to wrong environment

This operation is not allowed in production.

Error body response example:

HTTP 401

Unauthorized

The API token is invalid, missing or the client IP is not part of the allowed IP list.

Error body response example:

HTTP 500

Internal Server Error

An unexpected error occurred while processing the request. Please try again later or contact support if the problem persists.

Error body response example:

Set Carwash Payment Intent Paid

Body

Response example

Possible errors