List recipients
curl --request GET \
--url https://api.sandbox.busha.so/v1/recipients \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.busha.so/v1/recipients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.busha.so/v1/recipients', 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.sandbox.busha.so/v1/recipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.sandbox.busha.so/v1/recipients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.sandbox.busha.so/v1/recipients")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.busha.so/v1/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Recipients retrieved successfully",
"data": [
{
"object": "recipient",
"id": "8014c2ee-c70f-4c72-8d9f-c8b9d708a688",
"user_id": "b8277d1c-1bde-46ef-92ce-ebb4752eede5",
"profile_id": "b8277d1c-1bde-46ef-92ce-ebb4752eede5",
"currency_id": "NGN",
"country_id": "NG",
"type": "ngn_bank_transfer",
"legal_entity_type": "business",
"owned_by_customer": true,
"active": true,
"created_at": "2024-05-16T13:06:31.409336+01:00",
"updated_at": "2024-05-16T13:06:31.409336+01:00",
"fields": [
{
"value": "Access Bank Nigeria",
"display_name": "Bank Name",
"name": "bank_name",
"is_copyable": false,
"is_visible": true,
"required": true
},
{
"value": "0013246052",
"display_name": "Account Number",
"name": "account_number",
"is_copyable": false,
"is_visible": true,
"required": true
}
]
}
]
}Recipients
List recipients
Retrieve a list of all recipients
GET
/
v1
/
recipients
List recipients
curl --request GET \
--url https://api.sandbox.busha.so/v1/recipients \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.busha.so/v1/recipients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.busha.so/v1/recipients', 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.sandbox.busha.so/v1/recipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.sandbox.busha.so/v1/recipients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.sandbox.busha.so/v1/recipients")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.busha.so/v1/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Recipients retrieved successfully",
"data": [
{
"object": "recipient",
"id": "8014c2ee-c70f-4c72-8d9f-c8b9d708a688",
"user_id": "b8277d1c-1bde-46ef-92ce-ebb4752eede5",
"profile_id": "b8277d1c-1bde-46ef-92ce-ebb4752eede5",
"currency_id": "NGN",
"country_id": "NG",
"type": "ngn_bank_transfer",
"legal_entity_type": "business",
"owned_by_customer": true,
"active": true,
"created_at": "2024-05-16T13:06:31.409336+01:00",
"updated_at": "2024-05-16T13:06:31.409336+01:00",
"fields": [
{
"value": "Access Bank Nigeria",
"display_name": "Bank Name",
"name": "bank_name",
"is_copyable": false,
"is_visible": true,
"required": true
},
{
"value": "0013246052",
"display_name": "Account Number",
"name": "account_number",
"is_copyable": false,
"is_visible": true,
"required": true
}
]
}
]
}Authorizations
Bearer Authentication
Headers
The API version to use for this request.
Available options:
2025-06-01, 2025-07-11 Example:
"2025-07-11"
User profile header
Example:
"BUS_YOK8tp5Zga01qOKEsqp07"
Query Parameters
The order to sort the results
Available options:
asc, desc Example:
"asc"
Filter by currency
The cursor
The number of items to return
Example:
10
Filter by recipient network
Filter by recipient category
Filter recipient by the type
Filter recipients by phone number
Filter recipients by account number
Filter recipients by username
Response
Recipients retrieved successfully