API Reference
Beneficiaries
Get Beneficiary [GET]

Get Beneficiary

https://sandboxapi.onbrails.com/api/v1/beneficiaries/{beneficiary_id} (opens in a new tab)

Retrieve details of a single beneficiary using the beneficiary id.

Path Parameters

ParametertypeRequired
beneficiary_idstring✅

Request

Beneficiaries/Get Beneficiary [GET]
curl --request GET \
     --url https://sandboxapi.onbrails.com/api/v1/beneficiaries/beneficiary_id \
     --header 'Authorization: Bearer YOUR_SECRET_KEY' \
     --header 'accept: application/json'

Responses

🟢 200 - Result example
{
"status": true,
"message": "successfully fetched beneficiary",
"data": {
  "id": "472aca4c-5174-4d5e-aa52-302df55ebac5",
  "createdAt": "2023-08-04T06:24:53.868Z",
  "updatedAt": "2023-08-04T06:24:53.868Z",
  "reference": "367a818bf123",
  "status": "success",
  "country": "KE",
  "currency": "KES",
  "destination": {
    "type": "MOBILEMONEY",
    "network": "MPESA",
    "accountName": "Joe John",
    "accountNumber": "254700033301"
  }
}
}
Add Beneficiary [POST]List Beneficiaries [GET]