Praxis Wiki logo

Earlier Integrations |GetBalance Deprecated


Returns the customer’s available balance in the customer’s base currency. This value is used to display the customer’s balance and to determine the balance available for withdrawal when making and processing a payout request. The available balance should not include bonuses or any other funds the customer is not allowed to withdraw.

REQUEST PARAMETERS

Variable Type Description
PIN varchar(50) Required. Unique customer id in your system
SiteID int Optional: only used if you need to identify a brand or company to which this customer belongs.
FrontEndName varchar(256) Required. Cashier front end name, normally common name of the website. Linked to a specific base currency.

RESPONSE PARAMETERS

Variable Type Description
Status int Required.
- 0 if the request was successful
- Negative integer if internal server/network error occurs
- Positive integer if application/logical error occurs
Description varchar(256) Required. Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
Amount money or int Required. Available money customer can withdraw. Let us know if you work in minimum currency units.
Currency ISO char(3) Required. Base currency of customer account: USD, EUR, GBP, CAD, AUD, etc. This should always match the base currency of that particular Cashier Front End.

EXAMPLE

Request

curl -X POST \ https://your.api.host/GetBalance \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR",
    "PIN":"7"}'    

Response (OK)

{"status":0, "description":"success", "amount":100.50, "Currency":"EUR"}

Response (ERR)

{"status":1, "description":"User not found"}

You are currently viewing version 3.1 Latest version here