Request Details
Method |
Controller |
Resource |
Parameters |
GET |
card |
balance |
id |
Parameters Guide
Parameter |
Accepts |
id |
Accepts Card_no (int) or Valid Email
|
Example Request Format
Direct Url |
https://api.beepxtra.com/card/balance/1 |
Curl |
CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|card" -X GET https://api.beepxtra.com/card/balance/1 |
PHP SDK |
$beepapi->request('get', 'card', 'balance/1'); |
Sample Response
Success
{
"success":true,
"request":{
"method":"GET",
"controller":"card",
"resource":"balance",
"parameters":{
"\/card\/balance\/1":""
},
"url_elements":[
"card",
"balance",
"1"
]
},
"error":{
"errorid":0,
"message":0
},
"data":{
"user_id":"36046",
"cashback":"3210704.383243",
"commissions":"0",
"lock_cash_back":"528.124236",
"last_update":null
}
}
Error
{
"error":{
"message":"No Record of Card Balance",
"errorid":203
},
"success":false,
"request":{
"method":"GET",
"controller":"card",
"resource":"balance",
"parameters":{
"\/card\/balance\/10000":""
},
"url_elements":[
"card",
"balance",
"10000"
]
},
"data":{
"error":"No Record of Card Balance",
"errorid":203,
"errormsg":"No Record of Card Balance"
}
}
Response Guide
Parameter |
Type |
Details |
error |
String |
Contains the error message returned |
user_id |
bigint |
Global user id from database |
cashback |
decimal(15,6) |
available cashback |
commissions |
decimal(15,6) |
commissions earned |
lock_cash_back |
decimal(15,6) |
Deprecated - Internal use only |
last_update |
String |
Country name of card holder |