Module methods 

This module contains all the non-admin functions that can be mapped to an endpoint provided by the CCash API. All admin functions can be found within the admin module.

Modules

admin

This module contains all the admin functions that can be mapped to an endpoint provided by the CCash API. Non-admin functions can be found within methods.

Functions

add_user

Adds a user with a balance of 0.

change_password

Returns true about if a password change was successful for the given user. This function modifies user to use the new_password instead of the previous password in the case of a successful password change.

contains_user

Returns a bool about whether or not the the user with a given user exists. This function does not require a password.

delete_user

Removes the user. This function requires the user to be a valid username and password otherwise the endpoint will return an error.

get_balance

Returns the balance of the user.

get_logs

Returns the transaction logs for a given user. This function requires a correct password.

send_funds

Sends funds from the user to the user with the recipient_name. This function returns the user’s balance after a successful transaction has been made.

verify_password

Returns a bool about whether or not the password for a given user is correct.