1. Check if a CWX-ID Exists

Endpoint: https://server/api/partner/check-cwx-id

Parameter:
• id - CWX-ID of the user
 

This query checks whether a provided Crossworx ID (CWX-ID) exists. It returns a positive or negative validation message.

2. Save a Bonus Transaction

Endpoint: https://server/api/partner/write-transaction

Parameters:
 

• ppnumber - CWX-ID of the product partner

• tpnumber - CWX-ID of the crossworker

• price - Transaction price

• ordernumber - Order number/transaction number for identification

This function records a Euro bonus transaction in the respective crossworker’s dataset. The system identifies which other crossworkers in the structure are also eligible for the bonus and automatically records the bonus for them as well. These values are processed in real-time in the app and displayed to the user.

3. Retrieve User’s CoinX Balance

Endpoint: https://server/api/partner/get-coinx-balance

Parameter:

• id - CWX-ID of the user

This query returns the CoinX balance of a user. It can be integrated at various points to check if the crossworker has sufficient CoinX to use in the current transaction.

4. Retrieve Maximum CoinX Value for Cart Amount

Endpoint: https://server/api/partner/get-max-coinx-discount

Parameters:

• id - CWX-ID of the product partner

• value - Cart value from which the maximum CoinX deduction is calculated

This query returns the maximum possible CoinX value for a cart amount. The underlying global value (as a percentage of the cart value) is set by the product partner in the secure back office and can be adjusted at any time. Based on this, the query calculates the maximum CoinX value that can be applied to the upcoming current transaction.

5. Redeem Crossworker’s CoinX at a Product Partner

Endpoint: https://server/api/coinx/redeem

Parameters:

• ppid - CWX-ID of the product partner

• tpid - CWX-ID of the crossworker

• coinx - Number of CoinX to be redeemed

• transaction_id - Receipt/transaction number for identification

This query transmits the redeemed CoinX of the respective transaction to the database and deducts this amount from the crossworker’s existing CoinX balance.

6. Retrieve Crossworker’s Referral Link
 

Endpoint: https://server/api/partner/get-referrer-link

Parameter:

• id - CWX-ID of the user

This function returns the referral link of a crossworker. This referral link is automatically generated during the registration of a crossworker and remains unchanged for a lifetime. It is available for retrieval from the database.

7. Register a New Crossworker
 

Endpoint: https://server/api/partner/register-crossworker

Parameters:

• xname - xname of the inviting user

• first_name - First name of the new user

• last_name - Last name of the new user

• email - Email address of the new user

This query sends the data for registering a new crossworker to the system. This enables the registration of a crossworker directly from the checkout area of an eCommerce shop without leaving it. The newly registered crossworker can immediately use the ID received via email to earn bonuses on the planned order.

8. Retrieve User’s Total Bonus Balance
 

Endpoint: https://server/api/partner/get-total-bonus

Parameter:

• id - CWX-ID of the user

This query returns the total balance of the bonuses accumulated so far.

9. Retrieval of one's own xName

Endpoint: https://server/api/partner/get-xname

Parameter:

• none

Returns the xName of the currently authenticated user in the API.