API Reference

This page will help you get started with Aeps 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)
transactionTypeStringCW
merchantLoginIdAplhaNumericUnique merchant code
adhaarNumberNumber (12 Digits)customer aadhar number to check linked bank account balance
mobileNumberNumber (10 Digit)received in get otp api response
transactionAmountDoubleWithdrawal amount
biodataStringpass finger scan data as it is received via biometric scan device
bankidNumberGet from bank list api
apitxnidAlphaNumericUnique reference id from client side
latitudeStringGeo Location Latitude of your merchant
longitudeStringGeo Location Longitude of your merchant
consentStringYes (I hereby confirm that Direct Benefits Transfer (DBT)/subsidies granted by the Government is received by me into the bank account. I carry out transactions through Business Correspondents of banks for withdrawal of money from my account/s and also for enquiry of balance under my account. I am submitting my Aadhaar details voluntarily to you for authentication purpose using my Aadhaar number/biometrics with UIDAI for the aforesaid purposes through AEPS)
$parameter = [
    "partner_id"      => "2",
    "transactionType" => "MS",
    "merchantLoginId" => "GGGG1234",
    "adhaarNumber" => "123456789012",
    "mobileNumber" => "123456789012",
    "bankid"    => "1",
  	"transactionAmount" => 100,
    "apitxnid"  => "QWWE0046G",
    "biodata"   => "ewrwersas",
    "latitude"  => "28.3033",
    "longitude" => "75.9098",
  	"consent"   => "Yes"
]

$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" => "93A5D34BEED49E72621EAF6327DE9760F08B20ED38FAB9DE4060FF80F2393F45EC91BF63A8A71407DD2B3DE2F385D718090C7DF5D32455C80D6798719A7B562B6FCAEE44FF105982D8DDD2EAEA70E72FE26F7E792778B96F697407E5C6B0CB177A90CE38C35A1634383E6A764FB2F039301CD80088AF45218F905815A3FFCD958C13C87218C931C63D47ABCE4C2CC91BF0072B62F2C654EA89E8BF704A4243CA552EF40802953FD21BE7EFCDE560B889EAE33FD8EF00FBF88D8AB5490BFE4C0F3B54032A63487415742DA0EE77A1D12E773B356B3D08692079C136107E6810889F34B4C716937DFEA6726FB14FDC6361E99D752C67F6E4A1E12C71EA1E48D7A608306EEDEBCACCC726BB181E45955D78A7CF81CB07E7899D4C34979DFF2C2FA3424BF66C6DA7F795739EE1088D97141BD4AD6C642B3022F880AEDFA60FBDD1A5BC35C9D5A4122587BB1F3A7B886D9C47698C404BF861BAFBEF4BDF409DF0E8C37736BF8B7496E120A081470EF6AD158C4BC4D4FD73AF008FEAC122BD4AD4473D9A853F629D041A6D7313406E2EA9A1EE014E853BF7739353041F3FCDAA94D6930FDD184564FD40B9A6D21ECBF75D6CFA6E3FCF13B548969AC3DFA07910F36968"
];

$final_body = json_encode($request_body);

📘

Pidoption for initiate scan device

<?xml version="1.0"?><PidOptions ver="1.0"><Opts fCount="1" fType="2" iCount="0" pCount="0" format="0" pidVer="2.0" timeout="10000" posh="UNKNOWN" env="P" /><CustOpts></CustOpts></PidOptions>

Language
Credentials
Header
Click Try It! to start a request and see the response here!