Transactions API

 

Hostname: <organization>.intellumlevel.com

Organization subdomain is the same subdomain as used on exceedlms.com.

 

Get (Get a user's balance)


Resource: /api/users/{user_code}


HTTPS Request Method: GET

Description: Get a user's balance


Required Parameters:

  • api_key_token (string) - Unique token that is generated for your organization.
  • user_code (string) - ID of the user on Exceed - not the code on Exceed.

 

Example Response:

[
{
"id": 376,
"code": "533533"
"full_name": "Helen Abrahams",
"gold_balance": 5000,
"points": 1000,
"rank": "1st"
}
]

 

Get (List all gold transactions for a given user)


Resource: /api/gold_transactions/{user_code}

 

HTTPS Request Method: GET

Description: List all gold transactions for a given user


Required Parameters:

  • api_key_token (string) - Unique token that is generated for your organization.
  • user_code (string) - ID of the user on Exceed - not the code on Exceed.

 

Example Response:

[
{"gold_transactions": [{"id":135,
"user_code":"2",
"balance":-1000.0,
"amount":-1000.0,
"description":"Purchase X3",
"reference":"X3-001",
"source":"BESTBUY-001",
"created_at":"2017-01-30T11:23:28.252Z",
"updated_at":"2017-01-30T11:23:28.252Z"},
{"id":136,
"user_code":"2",
"balance":1000.0,
"amount":2000.0,
"description":"Purchase X3",
"reference":"X3-002",
"source":"BESTBUY-001",
"created_at":"2017-01-30T11:23:41.518Z",
"updated_at":"2017-01-30T11:23:41.518Z"},
{"id":137,
"user_code":"2",
"balance":5000.0,
"amount":4000.0,
"description":"Purchase X3",
"reference":"X4-002",
"source":"BESTBUY-001",
"created_at":"2017-01-30T11:23:50.231Z",
"updated_at":"2017-01-30T11:23:50.231Z"}]}
]

 

Post (Create a points transaction (positive))


Resource: /api/gold_transactions?api_key_token={token}


HTTPS Request Method: POST

Description: Create a points transaction (positive)


Required Parameters:

  • api_key_token (string) - Unique token that is generated for your organization.
  • amount (float) - A positive amount of points to increase the user's balance.
  • user_code (string) - ID of the user on Exceed - not the code on Exceed.

 

Optional Parameters:

  • description (string) - Any additional info needed for record keeping.
  • reference (string) - A reference from an external transaction (needs to be unique).
  • source (string) - Where the transaction originates from.

 

Example Request (application/json):

[
    {"gold_transaction":
                                   "amount": 1000,
                                   "description": "Purchase X3",
                                   "reference": "X3-001",
                                   "source": "BESTBUY-001",
                                   "user_code": "2",
    }
]


Example Response 200 (application/json):

{
"id": 138
}

 

Post (Create a points transaction (negative))


Resource: /api/gold_transactions?api_key_token={token}


HTTPS Request Method: POST

Description: Create a points transaction (negative)


Required Parameters:

  • api_key_token (string) - Unique token that is generated for your organization.
  • amount (float) - A positive amount of points to decrease the user's balance.
  • user_code (string) - ID of the user on Exceed - not the code on Exceed.

 

Optional Parameters:

  • description (string) - Any additional info needed for record keeping.
  • reference (string) - A reference from an external transaction (needs to be unique).
  • source (string) - Where the transaction originates from.

 

Example Request (application/json):

[
    {"gold_transaction":
                                   "amount": -1000,
                                   "description": "Purchase X3",
                                   "reference": "X3-002",
                                   "source": "BESTBUY-001",
                                   "user_code": "2",
    }
]


Example Response 200 (application/json):

{
"id": 139
}

 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.