Payout

Post  https://api.bos.center/api/BOS/FPPayout


Body Parameters
{
    "amount": 1,
    "beneficiary_id": 2,
    "payment_method": [1 = NEFT, 2 = UPI, 3 = IMPS, 4 = RTGS],
    "RegistrationID": "BOS-554",
    "flag": "API"
}
Responses

200

200

Response

200

RESPONSE BODY

object

status    string

subCode    string

message    string

403

403

Response

403

RESPONSE BODY

Object

status string

subCode string

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.bos.center/api/BOS/FPPayout' \
--header 'Content-Type: application/json' \
--data  '{
  "amount": 1,
  "beneficiary_id": 2,
  "payment_method": [1 = NEFT, 2 = UPI, 3 = IMPS, 4 = RTGS],
  "RegistrationID": "BOS-554",
  "flag": "API"
}'
                                
import requests
import json

url = 'https://api.bos.center/api/BOS/FPPayout'
payload = json.dumps({
  "amount": 1,
  "beneficiary_id": 2,
  "payment_method": [1 = NEFT, 2 = UPI, 3 = IMPS, 4 = RTGS],
  "RegistrationID": "BOS-554",
  "flag": "API"
}) 

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.bos.center/api/BOS/FPPayout',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
    "amount": 1,
    "beneficiary_id": 2,
    "payment_method": [1 = NEFT, 2 = UPI, 3 = IMPS, 4 = RTGS],
    "RegistrationID": "BOS-554",
    "flag": "API"
  }) 
}; 
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.bos.center/api/BOS/FPPayout')
var content = new StringContent(
  "{
    "amount": 1,
    "beneficiary_id": 2,
    "payment_method": [1 = NEFT, 2 = UPI, 3 = IMPS, 4 = RTGS],
    "RegistrationID": "BOS-554",
    "flag": "API"
  }",
  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.bos.center/api/BOS/FPPayout',
  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 =>  '{
    "amount": 1,
    "beneficiary_id": 2,
    "payment_method": [1 = NEFT, 2 = UPI, 3 = IMPS, 4 = RTGS],
    "RegistrationID": "BOS-554",
    "flag": "API"
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;
                                

RESPONSE

200

403

409

412

422

-Result

Example

{
  "data": {
    "id": 1499XXX4,
    "beneficiary": 49XXXX165,
    "payment_method": "1/3",
    "status": "Success",
    "acquirer_message": null,
    "amount": 10,
    "bank_reference_id": null,
    "metadata": {
      "ifsc_code": "UTXXXXX001719",
      "account_number": "91301XXXX39XXX42"
    },
    "created_at": "2024-01-16T06:52:26.359618Z",
    "updated_at": "2024-01-16T06:52:26.488900Z"
  },
  "success": true
}
                                
{
  "status": "ERROR",
  "subCode": "403",
  "message": "APIs not enabled. Please reach out to care@bos.com"
}
                                
  
{
  "status": "ERROR",
  "subCode": "409",
  "message": "Beneficiary Id already exists"
}
                                
{
  "status": "ERROR",
  "subCode": "412",
  "message": "Post data is empty or not a valid JSON"
}
                                
{
  "status": "ERROR",
  "subCode": "422",
  "message": "Please provide a valid Bank IFSC code."
}