Delete

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


The Delete Api is used to delete a registered user from the system using their unique key. Once deleted, the user’s credentials and related access will no longer be valid.

Body Parameters
{
  "Userkey": "‘AOP554N3XXXXX",
  "Pipe": "bank6",
  "RegistrationID": "AOP-554"
} 
Request Parameters
Name Type Description
Userkey String Unique identification ID (maximum 12 characters) obtained from the AEPSUserOnBoarding API response
Pipe String Must Be bank6.
RegistrationID String Unique registration identifier, often tied to the user.
Responses

200

200

Response

200

RESPONSE BODY

Json

401

401

Response

401

RESPONSE BODY

Object

status     boolean

response_code     integer

message     string


Did this page help you?     Yes    No

Language
shell Shell
python Python
node Node
c# C#
php PHP

cURL

curl --location 'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Delete' \
--header 'Content-Type: application/json' \
--data  '{
"Userkey": "AOP554N3XXXXX",
"Pipe": "bank6",
"RegistrationID": "AOP-554"
}'
                                
import requests
import json

url = 'https://api.aopay.co.in/api/AOP/V1/AEPS/User/Delete'
payload = json.dumps({
"Userkey": "AOP554N3XXXXX",
"Pipe": "bank6",
"RegistrationID": "AOP-554"
}) 

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/Delete',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
"Userkey": "AOP554N3XXXXX",
"Pipe": "bank6",
"RegistrationID": "AOP-554"
 }) 
}; 
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/Delete')
var content = new StringContent(
  "{
"Userkey": "AOP554N3XXXXX",
"Pipe": "bank6",
"RegistrationID": "AOP-554"
}",
  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/Delete',
  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",
"Pipe": "bank6",
"RegistrationID": "AOP-554"
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;
                                

RESPONSE

200

401

-Result

Example

{
    "status": true,
    "msg": "User Deleted Successfully",
         "data": {
                "userkey": "AOP554N318796",
                "message": "User Deleted Successfully"
             },
        "statusCode": 200
}
                                
{
  "status": false,
  "response_code": 5,
  "message": "Invalid signature encoding"
}