List Beneficiaries
curl --request GET \
--url https://api.rolla.xyz/api/v1/external/beneficiaries \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.rolla.xyz/api/v1/external/beneficiaries"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.rolla.xyz/api/v1/external/beneficiaries', 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.rolla.xyz/api/v1/external/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.rolla.xyz/api/v1/external/beneficiaries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.rolla.xyz/api/v1/external/beneficiaries")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Beneficiaries retrieved successfully",
"data": {
"beneficiaries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "NGN",
"label": "Office rent",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": "<string>",
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": "<string>",
"withdrawal_method": "domestic_wire",
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_owner_type": "business",
"account_category": "checking",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page": 123,
"pageSize": 123,
"total": 123
}
}
}{
"success": false,
"message": "<string>"
}Beneficiaries
List Beneficiaries
Retrieves a paginated list of saved beneficiaries for the business.
GET
/
beneficiaries
List Beneficiaries
curl --request GET \
--url https://api.rolla.xyz/api/v1/external/beneficiaries \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.rolla.xyz/api/v1/external/beneficiaries"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.rolla.xyz/api/v1/external/beneficiaries', 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.rolla.xyz/api/v1/external/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.rolla.xyz/api/v1/external/beneficiaries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.rolla.xyz/api/v1/external/beneficiaries")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Beneficiaries retrieved successfully",
"data": {
"beneficiaries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "NGN",
"label": "Office rent",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": "<string>",
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": "<string>",
"withdrawal_method": "domestic_wire",
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_owner_type": "business",
"account_category": "checking",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page": 123,
"pageSize": 123,
"total": 123
}
}
}{
"success": false,
"message": "<string>"
}Retrieve a paginated list of saved beneficiaries for your business. Filter by currency or search by name and account number.
Example Request
curl -X GET "https://api.rolla.xyz/api/v1/external/beneficiaries?page=1&pageSize=20¤cy=NGN" \
-H "X-API-Key: your_api_key_here"
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
pageSize | integer | Results per page (default: 20, max: 100) |
currency | string | Filter by currency code (e.g. NGN, USD) |
search | string | Search by name or account number |
Example Response
{
"status": 200,
"success": true,
"message": "Beneficiaries retrieved successfully",
"data": {
"beneficiaries": [
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"currency": "NGN",
"label": "Office rent",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"withdrawal_method": null,
"email": "john@example.com",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-01-10T08:00:00.000Z"
}
],
"totalCount": 5,
"page": 1,
"pageSize": 20,
"totalPages": 1
}
}
Use the
search parameter to quickly find beneficiaries by name or account number without needing to paginate through all results.Authorizations
Your Rolla API key
Query Parameters
Page number (default: 1)
Required range:
x >= 1Results per page (default: 20, max: 100)
Required range:
1 <= x <= 100Filter by currency code
Search by name or account number
⌘I