Issue a Cashback

Request Details

Method Controller Resource Parameters
POST card cashback multiproduct / outlet_id-cashier_id / card_no / product:product:product / receipt

Parameters Guide

Parameter Accepts
multiproduct default value - must be multiproduct
outlet_id int outlet id as supplied from BeepXtra
cashier_id int id of current user acting as cashier (Can be dynamically changed or use outlet owner id as default
card_no bigint card number or string valid email of the member receiving the cashback
product string format as follows product_id or 0_double price_double discount percentage_int quantity  you can chain multiple products in 1 request using :
receipt string receipt number (optional) or 0 for default. NOTE: No spaces allowed in receipt (e.g. res1233)

Example Request Format

Direct Url https://api.beepxtra.com/card/cashback/multiproduct/123-54270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123
Curl CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X POST https://api.beepxtra.com/card/cashback/multiproduct/123-54270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123
PHP SDK $beepapi->request('post', 'card', 'cashback/multiproduct/123-54270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123');

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"POST",
      "controller":"card",
      "resource":"cashback",
      "parameters":{  
         "\/card\/cashback\/multiproduct\/123-50\/4\/0_0_0_0:1_10_00_2_5_1:123_100_5_1\/receipt123\/3":""
      },
      "url_elements":[  
         "card",
         "cashback",
         "multiproduct",
         "548-50",
         "4",
         "0_0_0_0:1_10.00_2.5_1:123_100_5_1",
         "receipt123",
         "3"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":{  
      "success":"true"
   }
}
Error
{  
   "error":{  
      "message":"Invalid Card Number.",
      "errorid":1000
   },
   "success":false,
   "request":{  
      "method":"POST",
      "controller":"card",
      "resource":"cashback",
      "parameters":{  
         "\/card\/cashback\/multiproduct\/548-50\/wrong@email_com\/0_0_0_0:1_10_00_2_5_1:123_100_5_1\/receipt123\/3":""
      },
      "url_elements":[  
         "card",
         "cashback",
         "multiproduct",
         "548-50",
         "[email protected]",
         "0_0_0_0:1_10.00_2.5_1:123_100_5_1",
         "receipt123",
         "3"
      ]
   },
   "data":{  
      "error":"Invalid Card Number.",
      "errorid":1000,
      "errormsg":"Invalid Card Number."
   }
}

Response Guide

Parameter Type Details
error String Contains the error message returned
success boolean Returns true if successful

Search

API Documentation