List beneficiaries

GET

send-money

beneficiaries

List beneficiaries

curl --request GET \
  --url https://sandbox.kulmipay.com/api/v1/send-money/beneficiaries \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "<string>",
    "name": "<string>",
    "account": "<string>",
    "account_reference": "<string>",
    "is_active": true
  }
]

Authorization

string

header

default:ISSecretKey_test_xxxxxxxxxxxxxxxx

required

Use your KulmiPay secret key as the Bearer token.

provider

string

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

string

Search by name, account number, or account reference.

is_active

string

Filter by active status.

200 - application/json

Successful response

string

name

string

account

string

provider

enum<string>

Available options:

MPESA-B2C,

MPESA-B2B,

PESALINK,

P2P

account_reference

string | null

is_active

boolean

List beneficiaries

curl --request GET \
  --url https://sandbox.kulmipay.com/api/v1/send-money/beneficiaries \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "<string>",
    "name": "<string>",
    "account": "<string>",
    "account_reference": "<string>",
    "is_active": true
  }
]

Documentation Index