Skip to main content
GET
List beneficiaries

Authorizations

Authorization
string
header
default:ISSecretKey_test_xxxxxxxxxxxxxxxx
required

Use your KulmiPay secret key as the Bearer token.

Query Parameters

provider
string

Filter by provider, such as MPESA-B2C or PESALINK.

Search by name, account number, or account reference.

is_active
string

Filter by active status.

Response

200 - application/json

Successful response

id
string
name
string
account
string
provider
enum<string>
Available options:
MPESA-B2C,
MPESA-B2B,
PESALINK,
P2P
account_reference
string | null
is_active
boolean