Skip to main content
GET
/
beneficiary
Get beneficiary
curl --request GET \
  --url https://processor-prod.up.railway.app/beneficiary \
  --header 'x-service-key: <api-key>'
{
  "success": true,
  "status": 200,
  "message": "Beneficiary fetched successfully",
  "timestamp": "2025-09-08T20:51:58.112Z",
  "data": {
    "id": "68bf2eba196a18d7bd166184",
    "is_active": true,
    "currency": "ngn",
    "details": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Query Parameters

​
beneficiary_id
string
required

The beneficiary ID to fetch details for

Example:

"68bf2eba196a18d7bd166184"

Response

200 - application/json

Beneficiary fetched successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Beneficiary fetched successfully"

​
timestamp
string<date-time>
Example:

"2025-09-08T20:51:58.112Z"

​
data
object