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

Example Response

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 by name or account number

Response

Beneficiaries retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Beneficiaries retrieved successfully"

data
object