Skip to main content
GET
List Beneficiaries
Retrieve a paginated list of saved beneficiaries for your business. Filter by currency or search by name and account number.

Example Request

Query Parameters

An invalid query value (for example pageSize=500) returns 400 with "message": "Validation failed" and an errors array.

Example Response

Results are ordered newest first. Each beneficiary carries only its populated fields, except withdrawal_method, which is always present and is null when no rail was set.
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. Comma-separate to match several (NGN,USD). rolla_transfer beneficiaries are always included regardless of currency.

Case-insensitive match on label, account name, email, contact person, account number, address or wallet address

type
enum<string>

rolla returns only rolla_transfer beneficiaries; external returns everything else

Available options:
rolla,
external
wallet_chain
string

Filter crypto beneficiaries by network slug (e.g. base)

Response

Beneficiaries retrieved successfully

status
integer
required
Example:

200

message
string
required
Example:

"Beneficiaries retrieved successfully"

success
boolean
required
Example:

true

data
object
required