RukaPay
RukaPay

Partner - Institutions

Members

Register SACCO members and link them to core-banking accounts.

Overview

Members need a phone. Use accountNo / clientId to connect core banking. Legal first/last names are set at create and cannot be edited later — change displayName instead.

  • Validate phone against MNO before create when you need name matching
  • Delete is blocked if the member already has transactions
  • Bulk upload: download the Excel template, fill rows, POST multipart file
https://api.rukapay.net/partner-institutions/{institutionId}/users

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}/users

Path parameters

institutionIdRequired
string

SACCO id.

Request body

firstNameRequired
string

Legal first name.

lastNameRequired
string

Legal last name.

phoneRequired
string

E.g. +256701234567.

displayName
string

Public name (editable later).

email
string

Optional email.

nationalId
string

Uganda NIN, unless not applicable.

nationalIdNotApplicable
boolean

Skip NIN when true.

accountNo
string

Core-banking account number.

clientId
string

Core-banking client id.

acknowledgePhoneNameMismatch
boolean

Accept MNO name mismatch.

Request example

JSON
{
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "John D.",
  "phone": "+256701234567",
  "nationalId": "CF12345678901234",
  "accountNo": "AC001",
  "clientId": "1001",
  "status": "ACTIVE"
}

Response example

JSON
{
  "success": true,
  "data": {
    "id": "mem_xyz789",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+256701234567",
    "accountNo": "AC001",
    "status": "ACTIVE"
  }
}

Status codes

201

Created

Member created.

401

Unauthorized

Missing or invalid x-api-key.

403

Forbidden

Partner or role cannot perform this action.

https://api.rukapay.net/partner-institutions/{institutionId}/users/validate-phone

Path parameters

institutionIdRequired
string

SACCO id.

Request body

phoneRequired
string

Member phone to validate.

firstNameRequired
string

Expected first name.

lastNameRequired
string

Expected last name.

Request example

JSON
{
  "phone": "+256701234567",
  "firstName": "John",
  "lastName": "Doe"
}

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}/users/{memberId}

Path parameters

institutionIdRequired
string

SACCO id.

memberIdRequired
string

Member id.

Request body

displayName
string

Public display name.

email
string

Email.

accountNo
string

Account number.

clientId
string

Client id.

status
string

e.g. ACTIVE.

Request example

JSON
{
  "displayName": "John D.",
  "accountNo": "AC001",
  "status": "ACTIVE"
}

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}/users/{memberId}

Path parameters

institutionIdRequired
string

SACCO id.

memberIdRequired
string

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.

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

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/users/template

Status codes

200

OK

xlsx file returned.