Skip to main content
GET
/
beneficiaries
/
{beneficiaryId}
Get Beneficiary
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Beneficiary retrieved successfully",
  "data": {
    "beneficiary": {
      "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>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}
Retrieve the details of a specific saved beneficiary by ID.

​
Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/beneficiaries/c3d4e5f6-a7b8-9012-cdef-123456789012" \
  -H "X-API-Key: your_api_key_here"

​
Example Response

{
  "success": true,
  "message": "Beneficiary retrieved successfully",
  "data": {
    "beneficiary": {
      "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": "domestic_wire",
      "email": "john@example.com",
      "created_at": "2024-01-10T08:00:00.000Z",
      "updated_at": "2024-01-10T08:00:00.000Z"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Path Parameters

​
beneficiaryId
string<uuid>
required

Beneficiary UUID

Response

Beneficiary retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Beneficiary retrieved successfully"

​
data
object