Totalwash

The totalwash cash register integration endpoints allow you to manage your integration.

GET/totalwash

List integrations

This endpoint allows you to get a list of all enabled Totalwash integrations for an organization.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.get
Type
string
Description
The scope required to access this endpoint.

Query parameters

Name
organization_id
Type
string|Required
Description
The organization id to get the integrations for.

Request

GET

/totalwash

curl -X GET https://api.walletapp.co/totalwash 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{
    "organization_id": "<organization_id>"
}'

Response

{
    "success": true,
    "data": [
        {
            "name": "<name>",
            "uuid": "<uuid>",
            "public": "<public>",
            "secret": "<secret>",
            "url": "<endpoint>",
            "integration_key": "<current_active_auth_key>",
            "expires_at": "<timestamp>"
        },
        ...
    ]
}

POST/totalwash

Enable an integration

Enable a specific totalwash integration

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Body parameters

Name
organization_id
Type
string|Required
Description
The organization id to get the integrations for.
Name
public
Type
string|Required
Description
The public key of the integration.
Name
secret
Type
string|Required
Description
The secret key of the integration.
Name
endpoint
Type
string|Required
Description
The endpoint of the integration.
Name
title
Type
string|Required
Description
The title of the integration.

Request

POST

/totalwash

curl -X POST https://api.walletapp.co/totalwash 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{
    "organization_id": "<organization_id>",
    "public": "<public>",
    "secret": "<secret>",
    "endpoint": "<endpoint>",
    "title": "<title>"
}'

Response

{
    "success": true,
    "message": "Integration added as new totalwash integration"
}

GET/totalwash/:uuid

Inspect an integration

Fetch a specific integration.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.

Request

GET

/totalwash/:uuid

curl -X GET https://api.walletapp.co/totalwash/:uuid 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
   "success": true,
   "data": {
       "name": "<name>",
       "uuid": "<uuid>",
       "public": "<public>",
       "secret": "<secret>",
       "url": "<endpoint>",
       "integration_key": "<current_active_auth_key>",
       "expires_at": "<timestamp>"
   }
}

DELETE/totalwash/:uuid

Remove an integration

Fetch a specific integration.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.

Request

DELETE

/totalwash/:uuid

curl -X get https://api.walletapp.co/totalwash/:uuid 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
   "success": true,
   "message": "Integration deleted"
}

GET/totalwash/:uuid/vouchercodes

Voucher codes

Fetch the list of active voucher codes.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.

Request

GET

/totalwash/:uuid/vouchercodes

curl -X GET https://api.walletapp.co/totalwash/:uuid/vouchercodes 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
   "success": true,
   "data": [
       {
           "code": "<code>",
           "title": "<title>",
           "organization": {
               "identifier": "<organization_id>",
               "name": "<organization_name>"
           }
       }
   ]
}

POST/totalwash/:uuid/vouchercodes

Add voucher code

Add a voucher code to the integration

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.

Body parameters

Name
title
Type
string|Required
Description
The title of the voucher code
Name
code
Type
string|Required
Description
The totalwash voucher code

Request

POST

/totalwash/:uuid/vouchercodes

curl -X POST https://api.walletapp.co/totalwash/:uuid/vouchercodes 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{
    "title": "<title>",
    "code": "<code>"
}'

Response

{
   "success": true,
   "data": {
       "code": "<code>",
       "title": "<title>",
       "organization": {
           "identifier": "<organization_id>",
           "name": "<organization_name>"
       }
   }
}

GET/totalwash/:uuid/vouchercodes/:code

Inspect an voucher code

Get a specific voucher code.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.
Name
code
Type
string|Required
Description
The code that you want to inspect

Request

GET

/totalwash/:uuid/vouchercodes/:code

curl -X GET https://api.walletapp.co/totalwash/:uuid/vouchercodes/:code 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
   "success": true,
   "data": {
       "code": "<code>",
       "title": "<title>",
       "organization": {
           "identifier": "<organization_id>",
           "name": "<organization_name>"
       }
   }
}

DELETE/totalwash/:uuid/vouchercodes/:code

Remove a voucher code

Remove a specific voucher code.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.
Name
code
Type
string|Required
Description
The code that you want to inspect

Request

DELETE

/totalwash/:uuid/vouchercodes/:code

curl -X get https://api.walletapp.co/totalwash/:uuid/vouchercodes/:code 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
   "success": true,
   "message": "Voucher code deleted"
}

GET/totalwash/:uuid/members

Totalwash members

Fetch the relation data between totalwash and walletapp members.

Keep in mind that the data that will be returned can vary based on the version of the integration on the totalwash side of things.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
totalwash.store
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
uuid
Type
string|Required
Description
The uuid of the integration.

Request

GET

/totalwash/:uuid/members

curl -X GET https://api.walletapp.co/totalwash/:uuid/members 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
   "message": "Request successful",
   "data": [
       {
           "card_number": "<string>",
           "first_name": "<string>",
           "last_name": "<string>",
           "street": "<string>",
           "house_number": "<string>",
           "postal_code": "<string>",
           "city": "<string>",
           "birth_date": "<string>",
           "licenseplate": "<string>",
           "last_visited": "<timestamp>",
           "last_visited_location": "<location_title>",
           "marketing": "<boolean>",
           "subscription": "<boolean>",
           "totalwash_customer_id": "<integer>",
           "totalwash_personal_customer_id": "<integer>",
           "walletapp_id": "<walletapp_uuid>"
       },
   ]
}