API Reference

Need to register agent for use bbps api

Header

NameTypeValue
api-keystring(get it from api credentials in api panel)
content-typestringapplication/json
acceptstringapplication/json
$header = [  
    'accept: application/json',  
    'api-key: XdWCmd0NF1ZVklnVPegOdL59WkFM7o4h91UYPAt1',  
    'content-type: application/json',  
];

Request Body Parameters

NameTypeValue
partner_idinteger(Get in from api panel you api parner id)
nameStringName of agent
mobileStringMobile of agent
cityStringCity of agent
addressStringAddress of agent
pincodeStringPincode of agent
stateStringState of agent
shopnameStringShopname
geocodeStringlatitude/longitude of agent location
$parameter = [
    'partner_id' => '1'
  	'name'   => "Test",
  	'mobile'  => "1234567890",
  	'city'     => 'lucknow',
  	'address'     => 'lucknow',
  	'pincode'     => '226010',
  	'state'     => 'Uttar Pradesh',
  	'shopname'     => 'Shop',
  	'geocode'     => '23.0021/76.6767'
];

$body_json_string = json_encode($parameter);

Request Body to be sent in Json

NametypeValue
bodyStringAes Encypted of Json Encoded Body Parameters String
$request_body = [
    "body" => "CE9BD8918E7971EFBA20CE7CF47582570B6B4932B6BF1D861071F02E92249698285B621186146CA93C8906DE3DB0D09216A579F7D89407E290BC5827ED770AE7305DAD79D50111144EC6EB6B793B5D4F83CB503CEA1279FF50F974F660E84851BCF53FA8FB132BEF412CC5084E6BC21B"
];

$final_body = json_encode($request_body);

Response Body Parameters

NametypeConditionPossible Value
statuscodeStringAll TimeTXN / ERR
messageStringAll TimeTransaction Response Message
bbpsidStringIn Case TXNAgent Unique Id
Language
Click Try It! to start a request and see the response here!