Endpoint

Create carwash payment intent

The Create Carwash Payment Intent endpoints allow the creation of a carwash payment intent within the Neatcar platform. This payment intent is used to complete the payment on our Web App and redirect the user to your platform with the necessary information to show the carwash that was bought from this user.

POST

/user

Body

The carwash type ID depends on the source of the carwash type. If the source is 'network', the ID needs to be provided inside 'networkCarwashTypeId'. Similarly, if the source is 'store', the ID needs to be provided inside 'storeCarwashTypeId'.

If 'networkCarwashTypeId' has a value, 'storeCarwashTypeId' must be null or 0, and vice versa. This ensures that only one type ID is specified depending on the source of the carwash type. If 'networkCarwashTypeId' is provided, it indicates that the carwash type originates from a network, and 'storeCarwashTypeId' should be null or 0. Similarly, if 'storeCarwashTypeId' is provided, it signifies that the carwash type originates from a store, and 'networkCarwashTypeId' should be null or 0. This rule maintains consistency and accuracy in specifying the carwash type based on its source.

Carwash Payment Intent Model data

The following list provides a selection of key values included in the model; however, it is non-exhaustive. Developers can expect to find additional fields and data within the model, offering comprehensive information about each payment intent. This abbreviated list serves as a starting point for understanding the structure of the model and the types of information available for each payment intent.

uuid
Unique identifier for the payment intent

The uuid returned from this endpoint will be used to redirect the user to our Web App. When the user complete or cancel the payment, they will be redirected to the redirectUrl specified in the payment intent creation request.

The carwash payment intent is short lived and will be invalid after 15 minutes.

Response example

Below is an example of the API endpoint response, showcasing the structure and format of the data returned by the specified endpoint. This example serves as a practical illustration, demonstrating how developers can expect the information to be organized and presented when interacting with the API. It provides insight into the content and layout of the response, facilitating effective integration and utilization of the endpoint within your applications.