AOP Services

Withdraw

Post https://api.aopay.co.in/api/AOP/V1/AEPS/User/Withdraw

The withdraw API allows Aadhaar-enabled cash withdrawal transactions from a customer’s linked bank account. After successful biometric authentication and transaction validation, the requested cash is dispensed, and transaction details are returned.

Body Parameters

{
  "Userkey": "AOP554N3XXXXX",
  "Mobile": "97XXXXXXXX",
  "Pipe": "bank6",
  "AccessModeType": "SITE",
  "AdhaarNumber": "123456789012",
  "Latitude": 37.7749,
  "Longitude": -122.4194,
  "ReferenceNo": "REF000000035",
  "DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
  "IpAddress": "27.XXX.XX.76",
  "NationalBankIdentification": "6470",
  "RequestRemarks": "desired message",
  "IsIris": "No",
  "RegistrationID": "AOP-554",
  "Amount": 100
}

Request Parameters

Name	Type	Description
Userkey	String	Unique identification ID (maximum 12 characters) obtained from the AEPSUserOnBoarding API response.
Mobile	Integer	Mobile number of the user, often used for verification or notifications.
Pipe	String	Must Be bank6.

Table

Name	Type	Description
Userkey	String	Unique identification ID (maximum 12 characters) obtained from the AEPSUserOnBoarding API response.
Mobile	Integer	Mobile number of the user, often used for verification or notifications.
Pipe	String	Must Be bank6.
AccessModeType	String	Access Mode Type (APP, SITE)
AdhaarNumber	String	User's Aadhar card number.
Latitude	Decimal	User’s geo location latitude
Longitude	Decimal	User’s geo location longitude.
ReferenceNo	String	User's Reference Number.
DeviceData	String	Fingerprint device data in XML.
IpAddress	String	Belongs to the same server from which the API calls are made and where you will be consuming the API.
NationalBankIdentification	String	Get this from bank List Api.
RequestRemarks	String	Your desired message.
IsIris	String	"Yes" or "No" – Specifies if the user’s eye scan (iris recognition) is used for authentication.
RegistrationID	String	Unique registration identifier, often tied to the user.
Amount	Integer	The amount to be withdrawn from the user’s account.

Responses

200

Response

200

RESPONSE BODY

Json

401

Response

401

RESPONSE BODY

Object

status boolean

response_code integer

message string

Did this page help you? Yes No

Language

Shell

Python

Node

PHP

cURL

curl --location  'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Withdraw' \
--header 'Content-Type: application/json' \
--data  '{
"Userkey": "AOP554N3XXXXX",
"Mobile": 97XXXXXXXX,
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"IpAddress": "27.XXX.XX.76",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554",
"Amount": 100
}'

import requests
import json

url = 'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Withdraw'
payload = json.dumps({
"Userkey": "‘AOP554N3XXXXX’, ",
"Mobile": 97XXXXXXXX,
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"IpAddress": "27.XXX.XX.76",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554",
"Amount": 100
}) 

headers = {
  "Content-type" : "application/json"
}

response = requests.request("POST" url, headers=headers, data=payload)

print (response.text)

var requests = require("request");
var options = { 
  "method" : "POST",
  "url" : 'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Withdraw',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
"Userkey": "AOP554N3XXXXX",
"Mobile": 97XXXXXXXX,
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"IpAddress": "27.XXX.XX.76",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554",
"Amount": 100
 }) 
}; 
request(options, function(error, response){
   if(error) throw new Error(error);
   console.log(response.body); 
});

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Withdraw')
var content = new StringContent(
  "{
"Userkey": "AOP554N3XXXXX",
"Mobile": 97XXXXXXXX,
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"IpAddress": "27.XXX.XX.76",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554",
"Amount": 100
}",
  null,"application/json"
); 

request.Content = content;
var response =  await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

<?php
$curl =  curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL =>  'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Withdraw',
  CURLOPT_RETURNTRANSFER =>  true,
  CURLOPT_ENCODING =>  '',
  CURLOPT_MAXREDIRS =>  10,
  CURLOPT_TIMEOUT =>  0,
  CURLOPT_FOLLOWLOCATION =>  true,
  CURLOPT_HTTP_VERSION =>  CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =>  'POST',
  CURLOPT_POSTFIELDS =>  '{
"Userkey": "AOP554N3XXXXX",
"Mobile": 97XXXXXXXX,
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"IpAddress": "27.XXX.XX.76",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554",
"Amount": 100
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;

RESPONSE

{
    "status": true,
    "msg": "Cash Withdrawal Successfully",
         "data": {
                "message": "Cash Withdrawal Successfully",
                "response_code": 1,
                "txnStatus": "SUCCESS",
                "error_code": 0,
                "ackno": 244,
                "balanceAmount": 100,
                "bankrrn": "500213454315",
                "clientRefno": "DIGIFINWITHDRAWP6a93386eb0d805739",
                "terminalId": "AA787126",
                "transactionId": "20250102134539",
                "timestamp": "2025-01-02 13:45:42",
             },
        "statusCode": 100
}

{
  "status": false,
  "response_code": 5,
  "message": "Invalid signature encoding"
}