Skip to main content
GET
Get Beneficiary
Retrieve the details of a specific saved beneficiary by ID.

Example Request

Example Response

The beneficiary is returned directly under data. Only populated fields are included, except withdrawal_method, which is always present and is null when no rail was set.

Error Response

An unknown ID, or one that belongs to another business, returns 404:

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Path Parameters

beneficiaryId
string<uuid>
required

Beneficiary UUID

Response

Beneficiary retrieved successfully

status
integer
required
Example:

200

message
string
required
Example:

"Beneficiary retrieved successfully"

success
boolean
required
Example:

true

data
object
required

A saved beneficiary as returned to API-key callers. Only populated fields are included: a fiat beneficiary never carries wallet fields and a crypto beneficiary never carries bank fields, and empty values are dropped. withdrawal_method is always present and is null when no rail was set. Timestamps and internal ids (business_id, recipient_business_id) are not returned.