Skip to main content
GET
/
beneficiaries
List Beneficiaries
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/beneficiaries \
  --header 'X-API-Key: <api-key>'
{
  "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>",
        "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",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123
    }
  }
}
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&currency=NGN" \
  -H "X-API-Key: your_api_key_here"

​
Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
pageSizeintegerResults per page (default: 20, max: 100)
currencystringFilter by currency code (e.g. NGN, USD)
searchstringSearch 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

​
X-API-Key
string
header
required

Your Rolla API key

Query Parameters

​
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
​
pageSize
integer
default:20

Results per page (default: 20, max: 100)

Required range: 1 <= x <= 100
​
currency
string

Filter by currency code

​
search
string

Search by name or account number

Response

Beneficiaries retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Beneficiaries retrieved successfully"

​
data
object