Redeem Cancel

Post  https://api.bospay.co.in/api/v1/Aopay/Enach/RedeemCancel


If the business flow requires cancellation, the client sends the AOPay cancellation request using the merchant order/reference.

Body Parameters
{                    
  "registrationID": "AOP-XXX",
  "merchantOrderId": "AOPXXXSUBXXXXXX"                         
}                
Request Parameters
Name Type Description
RegistrationId String Registration ID provided during partner onboarding.
MerchantOrderId String Merchant’s unique reference for cancel
Request Headers
Key Value
Content-Type application/json
X-API-TOKEN AOP_XXXXXXXXXXXX286XXXXX
X-REGISTRATION-ID AOP-XXX
Responses

200

200

401

401


Did this page help you?     Yes    No

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

cURL

curl --location 'https://api.bospay.co.in/api/v1/Aopay/Enach/RedeemCancel' \
--header 'Content-Type: application/json' \
--header 'X-API-TOKEN: AOP_XXXXXXXXXXXX286XXXXX' \
--header 'X-REGISTRATION-ID: AOP-XXX' \
--data  '{
    "registrationID": "AOP-XXX",
    "merchantOrderId": "AOPXXXSUBXXXXXX"
}'
                                
import requests
import json

url = 'https://api.bospay.co.in/api/v1/Aopay/Enach/RedeemCancel'
payload = json.dumps({
    "registrationID": "AOP-XXX",
    "merchantOrderId": "AOPXXXSUBXXXXXX"
}) 
headers = {
  "Content-type" : "application/json"
  "X-API-TOKEN" : "AOP_XXXXXXXXXXXX286XXXXX",
  "X-REGISTRATION-ID" : "AOP-XXX"
}

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

print (response.text)
                                
var requests = require("request");
var options = { 
  "method" : "POST",
  "url" : 'https://api.bospay.co.in/api/v1/Aopay/Enach/RedeemCancel',
  "headers" : {
    "Content-Type" : 'application/json'
    "X-API-TOKEN" : "AOP_XXXXXXXXXXXX286XXXXX",
    "X-REGISTRATION-ID" : "AOP-XXX"
  },
  body: JSON.stringify({
    "registrationID": "AOP-XXX",
    "merchantOrderId": "AOPXXXSUBXXXXXX"
  }) 
}; 
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.bospay.co.in/api/v1/Aopay/Enach/RedeemCancel')

request.Headers.Add("Content-type", "application/json");
request.Headers.Add("X-API-TOKEN", "AOP_XXXXXXXXXXXX286XXXXX");
request.Headers.Add("X-REGISTRATION-ID", "AOP-XXX");

var content = new StringContent(
  "{
    "registrationID": "AOP-XXX",
    "merchantOrderId": "AOPXXXSUBXXXXXX"
  }",
  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.bospay.co.in/api/v1/Aopay/Enach/RedeemCancel',
  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 =>  '{
    "registrationID": "AOP-XXX",
    "merchantOrderId": "AOPXXXSUBXXXXXX"
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json',
    'X-API-TOKEN: AOP_XXXXXXXXXXXX286XXXXX',
    'X-REGISTRATION-ID: AOP-XXX'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;
                                

RESPONSE

200

401

-Result

Example

{   
    "orderId": "AOPXXXREDXXXXXXXXX",
    "state": "CANCEL_IN_PROGRESS",
    "success": true,
    "code": null,
    "message": null
}
                                
{
    "Status": false,
    "Message": "Invalid API token or RegistrationID.",
    "ErrorCode": "INVALID_API_TOKEN",
    "StatusCode": 401,
    "RequestId": "55160861-9ccd-482b-85f4-c9521fd4d1ed",
}