API Reference

This page will help you get started with Collection 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)
$parameter = [
    'partner_id' => '1',
  	'txnid'      => 'UPI12345'
];

$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" => "4CE81403397C441C3DEB0EEFE28E79910EF0B4FA3BF6574DC94196DF436C10CF"
];

$final_body = json_encode($request_body);

Response Body Parameters

NametypeConditionPossible Value
statuscodeStringAll TimeTXN / TUP / TXF / ERR
messageStringAll TimeTransaction Response Message
refundDetailInfoListStringIn Case TXNUpi collection refund details
Language
Click Try It! to start a request and see the response here!