Member API
Create Member
POST https://billpay.paynow.co.zw/api/member/create
| Field | Data Type | Required |
|---|---|---|
| MemberNumber | String | Required |
| FullName | String | Required |
| EmailAddress | String | Optional |
| MobileNo | String | Optional |
| PostalAddress | String | Optional |
| AccountDetails | JSON string | Optional |
AccountDetails format:
{"Ship Name": "Jolly Roger", "Age": "4723"}
Returns 200 OK on success. All created members are logged in BillPay and can be viewed from the normal login.
Update Member
POST https://billpay.paynow.co.zw/api/member/update
Same fields as Create Member.
All optional fields will be overwritten with empty values if not specified.
Returns 200 OK on success. All updated members are logged in BillPay.
Delete Member
POST https://billpay.paynow.co.zw/api/member/delete
| Field | Data Type | Required |
|---|---|---|
| MemberNumber | String | Required |
The member number of a deleted member cannot be re-used in future. Deleted members can be undeleted at a later time if required.
Returns 200 OK on success.
Undelete Member
POST https://billpay.paynow.co.zw/api/member/undelete
| Field | Data Type | Required |
|---|---|---|
| MemberNumber | String | Required |
Returns 200 OK on success.
List Members
GET https://billpay.paynow.co.zw/api/member/list
Optional parameters:
| Field | Data Type |
|---|---|
| Filters | String |
| Page | Integer (Default: 1) |
| PerPage | Integer (Default: 200) |
Returns a paginated member list.
View Individual Member
GET https://billpay.paynow.co.zw/api/member/single/<membernumber>
Returns the member details.
Bulk Member Upload
POST https://billpay.paynow.co.zw/api/member/uploadmembers
Content type: multipart/form-data
The file must be in CSV format with the following mandatory columns (in order):
| Member Number | Full Name | Mobile | Postal Address | |
|---|---|---|---|---|
| 12345ABC | John | john@example.com | 0777123456 |
Additional detail columns can be added after the mandatory columns (e.g. National Id, Place of Birth).
Response
| Field | Data Type | Description |
|---|---|---|
| ResponseCode | Integer | 0 = Unspecified, 1 = Success |
| Narrative | String | e.g. "Inserted: 0, Updated: 1" |
| Warnings | List<String> | e.g. "Member 'a2001' has been overwritten" |
| Errors | List<String> | List of errors if any |
If a member number already exists, that member's details will be updated. If it does not exist, a new member record will be created.
Bulk Member Delete
POST https://billpay.paynow.co.zw/api/member/uploadmembersdelete
Content type: multipart/form-data
The CSV file should contain only one column:
| Member Number |
|---|
| 12000 |
| 12001 |
Response
| Field | Data Type | Description |
|---|---|---|
| ResponseCode | Integer | 0 = Unspecified, 1 = Success |
| Narrative | String | e.g. "Deleted: 1" |
| Warnings | List<String> | List of warnings |
| Errors | List<String> | List of errors if any |