Skip to main content
GET
/
v1
/
business
/
beneficiaries
/
{associationId}
List beneficiaries
curl --request GET \
  --url https://api.zeam.money/gw/v1/business/beneficiaries/{associationId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Bearer token issued by the gateway. Source the token from one of:

  • POST /v1/public/auth/verify-otp (OTP user)
  • POST /v1/public/auth-connect/sign-in (Connect app)
  • OAuth (end-user mobile/web)

Include as Authorization: Bearer <token>.

Path Parameters

​
associationId
string
required

Query Parameters

​
search
string

Case-insensitive substring match on reference.

​
beneficiary_type
enum<string>
Available options:
Individual,
Business
​
payment_method
enum<string>
Available options:
BANK,
MOMO,
CRYPTO,
CARD,
CASH,
QR,
VOUCHER,
WALLET

Response

Beneficiary list.

Standard Business API response envelope. The data field carries the domain-specific payload (array or object depending on the endpoint).

​
success
boolean
​
message
string
​
data
any

Domain-specific payload.