RukaPay
RukaPay

Partner - Institutions

Staff

Invite SACCO staff with roles and permissions. They set their own password via email.

Overview

Staff are dashboard logins for the institution — separate from members. Creating staff sends an invitation email (do not set passwords in the API).

Roles

OWNERADMINOPERATORVIEWER

Fine-tune with canManageMembers, canManageInstitution, canViewTransactions, and canRequestLiquidation.

https://api.rukapay.net/partner-institutions/{institutionId}/staff

Path parameters

institutionIdRequired
string

SACCO id.

Status codes

200

OK

Request succeeded.

401

Unauthorized

Missing or invalid x-api-key.

403

Forbidden

Partner or role cannot perform this action.

https://api.rukapay.net/partner-institutions/{institutionId}/staff

Path parameters

institutionIdRequired
string

SACCO id.

Request body

firstNameRequired
string

First name.

lastNameRequired
string

Last name.

emailRequired
string

Login email.

phone
string

Contact only — not used as wallet identity.

role
string

OWNER | ADMIN | OPERATOR | VIEWER.

canViewTransactions
boolean

View transaction history.

canManageMembers
boolean

Manage members and staff.

canManageInstitution
boolean

Edit SACCO settings.

canRequestLiquidation
boolean

Request liquidation.

Request example

JSON
{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@sacco.com",
  "phone": "+256701234567",
  "role": "OPERATOR",
  "canViewTransactions": true,
  "canManageMembers": false,
  "canManageInstitution": false,
  "canRequestLiquidation": false
}

Status codes

201

Created

Staff invited.

401

Unauthorized

Missing or invalid x-api-key.

403

Forbidden

Partner or role cannot perform this action.

https://api.rukapay.net/partner-institutions/{institutionId}/staff/{memberId}

Path parameters

institutionIdRequired
string

SACCO id.

memberIdRequired
string

Staff member id.

Request body

roleRequired
string

OWNER | ADMIN | OPERATOR | VIEWER.

canViewTransactions
boolean

Permission flag.

canManageMembers
boolean

Permission flag.

canManageInstitution
boolean

Permission flag.

canRequestLiquidation
boolean

Permission flag.

Request example

JSON
{
  "role": "ADMIN",
  "canViewTransactions": true,
  "canManageMembers": true,
  "canManageInstitution": true
}

Status codes

200

OK

Request succeeded.

401

Unauthorized

Missing or invalid x-api-key.

403

Forbidden

Partner or role cannot perform this action.

https://api.rukapay.net/partner-institutions/{institutionId}/staff/{memberId}/resend-invitation

Path parameters

institutionIdRequired
string

SACCO id.

memberIdRequired
string

Staff member id.

Status codes

200

OK

Request succeeded.

401

Unauthorized

Missing or invalid x-api-key.

403

Forbidden

Partner or role cannot perform this action.