Payouts
Retrieve Payout Purpose Codes
Get the full list of purpose codes for payout requests. Use the bs_code value as transaction_purpose_code to classify the nature of your fund transfer.
Retrieve Payout Purpose Codes
curl --request GET \
--url https://api.bluswap.co/api/v1/get-bs-purpose-codes \
--header 'Content-Type: <content-type>' \
--header 'X-Real-IP: <x-real-ip>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bluswap.co/api/v1/get-bs-purpose-codes"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "<content-type>",
"X-Real-IP": "<x-real-ip>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'x-api-key': '<api-key>',
'Content-Type': '<content-type>',
'X-Real-IP': '<x-real-ip>'
}
};
fetch('https://api.bluswap.co/api/v1/get-bs-purpose-codes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bluswap.co/api/v1/get-bs-purpose-codes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-Real-IP: <x-real-ip>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bluswap.co/api/v1/get-bs-purpose-codes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("X-Real-IP", "<x-real-ip>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bluswap.co/api/v1/get-bs-purpose-codes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "<content-type>")
.header("X-Real-IP", "<x-real-ip>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bluswap.co/api/v1/get-bs-purpose-codes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = '<content-type>'
request["X-Real-IP"] = '<x-real-ip>'
response = http.request(request)
puts response.read_body{
"bs_code": "<string>",
"bs_description": "<string>"
}Use this endpoint to retrieve the full list of purpose codes accepted for payout requests. When you initiate a payout, pass the
bs_code value from this response as the transaction_purpose_code field to classify the nature of the fund transfer.
Headers
string
required
Your secret API key.
string
required
Must be
application/json.string
required
Your whitelisted server IP address.
Sample Request
curl --location --request GET 'https://api.bluswap.co/api/v1/get-bs-purpose-codes' \
--header 'x-api-key: YOUR_SECRET_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Real-IP: YOUR_WHITELISTED_IP'
const response = await fetch('https://api.bluswap.co/api/v1/get-bs-purpose-codes', {
headers: { 'x-api-key': '<YOUR_API_KEY>', 'Content-Type': 'application/json', 'X-Real-IP': '<YOUR_WHITELISTED_IP>' }
});
console.log(await response.json());
import requests
response = requests.get(
"https://api.bluswap.co/api/v1/get-bs-purpose-codes",
headers={"x-api-key": "<YOUR_API_KEY>", "X-Real-IP": "<YOUR_WHITELISTED_IP>"},
)
print(response.json())
var request = java.net.http.HttpRequest.newBuilder(java.net.URI.create("https://api.bluswap.co/api/v1/get-bs-purpose-codes")).headers("x-api-key", "<YOUR_API_KEY>", "Content-Type", "application/json", "X-Real-IP", "<YOUR_WHITELISTED_IP>").GET().build();
var response = java.net.http.HttpClient.newHttpClient().send(request, java.net.http.HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
package main
import "net/http"
func main() {
request, _ := http.NewRequest(http.MethodGet, "https://api.bluswap.co/api/v1/get-bs-purpose-codes", nil)
request.Header.Set("x-api-key", "<YOUR_API_KEY>")
request.Header.Set("Content-Type", "application/json")
request.Header.Set("X-Real-IP", "<YOUR_WHITELISTED_IP>")
response, _ := http.DefaultClient.Do(request)
defer response.Body.Close()
}
<?php
$curl = curl_init('https://api.bluswap.co/api/v1/get-bs-purpose-codes');
curl_setopt_array($curl, [CURLOPT_HTTPHEADER => ['x-api-key: <YOUR_API_KEY>', 'Content-Type: application/json', 'X-Real-IP: <YOUR_WHITELISTED_IP>'], CURLOPT_RETURNTRANSFER => true]);
echo curl_exec($curl);
curl_close($curl);
require "net/http"
uri = URI("https://api.bluswap.co/api/v1/get-bs-purpose-codes")
request = Net::HTTP::Get.new(uri, {"x-api-key" => "<YOUR_API_KEY>", "Content-Type" => "application/json", "X-Real-IP" => "<YOUR_WHITELISTED_IP>"})
puts Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request).body }
Sample Response
{
"status": "Success",
"status_code": 200,
"message": "BS Transaction Purpose Codes fetched successfully.",
"detail": null,
"data": [
{
"bs_code": "BS103",
"bs_description": "Remittances to the Prime Minister's National Relief Fund / Chief Minister's Distress Relief Fund - Kerala subject to the condition that the remittances are directly credited to the Fund by the banks and the banks maintain full details of the remitters"
},
{
"bs_code": "BS104",
"bs_description": "EMI payments in India to Banks and Non-Banking Financial Companies (NBFCs) for repayment of loans."
},
{
"bs_code": "BS105",
"bs_description": "Tax payments in India"
}
]
}
Response Fields
Each object in thedata array contains the following fields:
string
The purpose code to pass as
transaction_purpose_code when calling the Initiate Payout endpoint (e.g., "BS103").string
Human-readable description of the purpose code, explaining the permitted use case for the fund transfer.
⌘I
Retrieve Payout Purpose Codes
curl --request GET \
--url https://api.bluswap.co/api/v1/get-bs-purpose-codes \
--header 'Content-Type: <content-type>' \
--header 'X-Real-IP: <x-real-ip>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bluswap.co/api/v1/get-bs-purpose-codes"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "<content-type>",
"X-Real-IP": "<x-real-ip>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'x-api-key': '<api-key>',
'Content-Type': '<content-type>',
'X-Real-IP': '<x-real-ip>'
}
};
fetch('https://api.bluswap.co/api/v1/get-bs-purpose-codes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bluswap.co/api/v1/get-bs-purpose-codes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-Real-IP: <x-real-ip>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bluswap.co/api/v1/get-bs-purpose-codes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("X-Real-IP", "<x-real-ip>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bluswap.co/api/v1/get-bs-purpose-codes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "<content-type>")
.header("X-Real-IP", "<x-real-ip>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bluswap.co/api/v1/get-bs-purpose-codes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = '<content-type>'
request["X-Real-IP"] = '<x-real-ip>'
response = http.request(request)
puts response.read_body{
"bs_code": "<string>",
"bs_description": "<string>"
}