message field of the response.data field where applicable.This method is used for agent login authentication.
\nRequest Parameters:
\ndevice_name (string, required): The name of the device used for login.
identifier (string, required): The identifier of the agent.
phone_number (string, required): The phone number of the agent.
password (string, required): The password of the agent.
Response:
\nStatus: 200 OK
\nStatus: 400 Bad Request
\nStatus: 401 Unauthorized
\nStatus: 403 Forbidden
\nStatus: 404 Not Found
\nStatus: 422 Unprocessable Entity
\nThis method is used to verify the OTP (One-Time Password) sent to the agent for authentication.
\nphone_number (string, required): The phone number of the agent.otp (string, required): The OTP received by the agent.This method is used to initiate the password reset process for an agent.
\nemail (string, required): The email address of the agent.This method is used to reset a user's password.
\ntoken (string, required): The reset password token.This method is used to update the password of an agent after receiving a reset token.
\ntoken (string, required): The reset token.email (string, required): The email address of the agent.password (string, required): The new password.password_confirmation (string, required): The confirmation of the new password.The Auth is responsible for handling authentication-related operations for agents in the system.
This method is used to check the old PIN of an agent.
\nold_pin (string, required): The old PIN of the agent.This method is used to change the PIN of an agent.
\nold_pin (string, required): The old PIN of the agent.pin (string, required): The new PIN of the agent.confirm_pin (string, required): The confirmation of the new PIN.This method is used to change the password of an agent.
\nold_password (string, required): The old password of the agent.password (string, required): The new password of the agent.confirm_password (string, required): The confirmation of the new password.This method is used to update the profile photo of an agent.
\nphoto (string, required): The base64-encoded photo data.This method is used to list notifications for an agent.
\nThis method is used to list notifications for an agent.
\nThis method is used to update the notification status of a user.
\nnotification_status (boolean, required): The new notification status.This method is used to update the notification status of a user.
\nnotification_status (boolean, required): The new notification status.This method is used to update the two-factor authentication (2FA) status for a user.
\ntwo_factor_status (boolean, required): The new 2FA status.This method is used to list all savings accounts associated with customers.
\nsearch (string, optional): Search query.agent_id_type (string, optional): Type of agent ID (assigned_agent_id or agent_id).start_date (date, optional): Start date filter.end_date (date, optional): End date filter.page (integer, optional): Page number.per_page (integer, optional): Number of records per page.This method is used to list all savings accounts associated with customers.
\nsearch (string, optional): Search query.agent_id_type (string, optional): Type of agent ID (assigned_agent_id or agent_id).start_date (date, optional): Start date filter.end_date (date, optional): End date filter.page (integer, optional): Page number.per_page (integer, optional): Number of records per page.This method is used to list all savings accounts associated with customers.
\nsearch (string, optional): Search query.agent_id_type (string, optional): Type of agent ID (assigned_agent_id or agent_id).start_date (date, optional): Start date filter.end_date (date, optional): End date filter.page (integer, optional): Page number.per_page (integer, optional): Number of records per page.The Agents is responsible for handling protected operations for agents in the system.
This method is used to list all devices associated with the authenticated agent.
\nResponse:
\nStatus: 200 OK
\nStatus: 403 Forbidden
\nThis method is used to approve a device by the agent.
\nURL Parameters:
\ndeviceId (integer, required): The ID of the device to be approved.Request Parameters:
\nidentifier (string, required): The identifier of the device to be approved.Response:
\nStatus: 200 OK
\nStatus: 403 Forbidden
\nStatus: 404 Not Found
\nStatus: 422 Unprocessable Entity
\nThis method is used to disable a device by the agent.
\nURL Parameters:
\ndeviceId (integer, required): The ID of the device to be disabled.Request Parameters:
\nidentifier (string, required): The identifier of the device to be disabled.Response:
\nStatus: 200 OK
\nStatus: 403 Forbidden
\nStatus: 404 Not Found
\nStatus: 422 Unprocessable Entity
\nThis method is used to remove a device by the agent.
\nURL Parameters:
\ndeviceId (integer, required): The ID of the device to be removed.Request Parameters:
\nidentifier (string, required): The identifier of the device to be removed.Response:
\nStatus: 200 OK
\nStatus: 403 Forbidden
\nStatus: 404 Not Found
\nStatus: 422 Unprocessable Entity
\nThe Devices is responsible for managing devices associated with an agent in the system.
This method is used to list customers for the authenticated agent.
\nsearch (string, optional): Search query to filter customers.agent_id_type (string, optional): Type of agent ID to filter by (either \"assigned_agent_id\" or \"agent_id\").page (integer, optional): Page number for pagination (default: 1).per_page (integer, optional): Number of customers per page (default: 30, max: 100).This method is used to create a new customer.
\nfirst_name (string, required): The first name of the customer.middle_name (string, optional): The middle name of the customer.last_name (string, required): The last name of the customer.office_address (string, required): The office address of the customer.home_address (string, required): The home address of the customer.phone_number (string, required): The phone number of the customer.email (string, optional): The email address of the customer.state (string, required): The state of the customer.lga (string, required): The local government area of the customer.bvn (integer, optional): The BVN (Bank Verification Number) of the customer.nin (integer, optional): The NIN (National Identification Number) of the customer.This method is used to create a new customer.
\nfirst_name (string, required): The first name of the customer.middle_name (string, optional): The middle name of the customer.last_name (string, required): The last name of the customer.office_address (string, required): The office address of the customer.home_address (string, required): The home address of the customer.phone_number (string, required): The phone number of the customer.email (string, optional): The email address of the customer.state (string, required): The state of the customer.lga (string, required): The local government area of the customer.bvn (integer, optional): The BVN (Bank Verification Number) of the customer.nin (integer, optional): The NIN (National Identification Number) of the customer.This method is used to retrieve customer details by their ID.
\nid (integer, required): The ID of the customer.search (string, optional): Search query to filter customers.This method is used to retrieve customer details by their phone number.
\nphone_number (string, required): The phone number of the customer.This method is used to create a new customer.
\nfirst_name (string, required): The first name of the customer.middle_name (string, optional): The middle name of the customer.last_name (string, required): The last name of the customer.office_address (string, required): The office address of the customer.home_address (string, required): The home address of the customer.phone_number (string, required): The phone number of the customer.email (string, optional): The email address of the customer.state (string, required): The state of the customer.lga (string, required): The local government area of the customer.bvn (integer, optional): The BVN (Bank Verification Number) of the customer.nin (integer, optional): The NIN (National Identification Number) of the customer.This method is used to create a new customer.
\nfirst_name (string, required): The first name of the customer.middle_name (string, optional): The middle name of the customer.last_name (string, required): The last name of the customer.office_address (string, required): The office address of the customer.home_address (string, required): The home address of the customer.phone_number (string, required): The phone number of the customer.email (string, optional): The email address of the customer.state (string, required): The state of the customer.lga (string, required): The local government area of the customer.bvn (integer, optional): The BVN (Bank Verification Number) of the customer.nin (integer, optional): The NIN (National Identification Number) of the customer.This method is used to create a new customer.
\nfirst_name (string, required): The first name of the customer.middle_name (string, optional): The middle name of the customer.last_name (string, required): The last name of the customer.office_address (string, required): The office address of the customer.home_address (string, required): The home address of the customer.phone_number (string, required): The phone number of the customer.email (string, optional): The email address of the customer.state (string, required): The state of the customer.lga (string, required): The local government area of the customer.bvn (integer, optional): The BVN (Bank Verification Number) of the customer.nin (integer, optional): The NIN (National Identification Number) of the customer.The Agent Customer is responsible for handling customer-related operations for agents in the system.
This method is used to create a new savings account for a customer.
\nRequest Parameters:
\nuser_id (numeric, required): The ID of the customer.
savings_type_id (numeric, required): The ID of the savings type.
fixed_amount (numeric, optional): The fixed amount for savings.
period (string, e.g ('daily', 'weekly', 'monthly', 'anytime')): The period of saving.
duration (numeric, optional): The duration of saving.
market_day (string, optional): The market day for saving.
due_date (date, optional): The maturity date for saving.
pin (numeric, required): The PIN of the agent.
Response:
\nThis method is used to retrieve savings accounts associated with a specific customer.
\nid (numeric, required): The ID of the customer.search (string, optional): Search query.start_date (date, optional): Start date filter.end_date (date, optional): End date filter.This method is used to retrieve savings accounts associated with a specific customer.
\nURL Parameters:
\nid (numeric, required): The ID of the customer.Query Parameters:
\nsearch (string, optional): Search query.Response:
\nStatus: 200 OK
\nStatus: 422 Unprocessable Entity
\nThis method is used to add history for a customer's savings account.
\nResponse:
\nStatus: 201 Created
\nStatus: 403 Forbidden
\nStatus: 422 Unprocessable Entity
\nThis method is used to add history for a customer's savings account.
\nResponse:
\nStatus: 201 Created
\nStatus: 403 Forbidden
\nStatus: 422 Unprocessable Entity
\nThe Savings is responsible for managing savings and savings history associated with agents and customers in the system.
This method is used to list all loans associated with a customer.
\nid (numeric, required): The ID of the customer.search (string, optional): Search query.start_date (date, optional): Start date filter.end_date (date, optional): End date filter.page (integer, optional): Page number.per_page (integer, optional): Number of records per page.This method is used to create a new loan request for a customer.
\nRequest Parameters:
\nuser_id (numeric, required): The ID of the customer requesting the loan.
market_days (numeric, required): The number of days between market days.
\ndescription (string, optional): Description of the loan.
pin (numeric, required): The PIN of the agent.
Response:
\nStatus: 201 Created
\nStatus: 400 Bad Request
\nStatus: 403 Forbidden
\nStatus: 422 Unprocessable Entity
\nThis method is used to create a new loan request for a customer.
\nuser_id (numeric, required): The ID of the customer requesting the loan.amount (numeric, required): The amount of the loan.description (string, optional): Description of the loan.instalment_period (numeric, optional): The period of loan instalment.pin (numeric, required): The PIN of the agent.This method is used to create a new loan request for a customer.
\nRequest Parameters:
\nuser_id (numeric, required): The ID of the customer requesting the loan.
amount (numeric, required): The amount of the loan.
description (string, optional): Description of the loan.
pin (numeric, required): The PIN of the agent.
Response:
\nStatus: 201 Created
\nStatus: 400 Bad Request
\nStatus: 403 Forbidden
\nStatus: 422 Unprocessable Entity
\nThis method is used to record loan repayments by customers.
\n/api/agent/loans/paybackloan_id (numeric, required): The ID of the loan.user_id (numeric, required): The ID of the customer.amount (numeric, required): The repayment amount.This method is used to list all loans associated with a customer.
\nid (numeric, required): The ID of the customer.search (string, optional): Search query.start_date (date, optional): Start date filter.end_date (date, optional): End date filter.page (integer, optional): Page number.per_page (integer, optional): Number of records per page.The Loans is responsible for managing loans and installments associated with agents and customers in the system.
Description: Retrieves settings from the system.
\nResponse Status Codes:
\n200: Settings retrieved successfully.Response Data:
\nmessage: Indicates the status of the operation.status: HTTP status code.data: Contains the retrieved settings in key-value pairs.Response Status Codes:
\n200: Savings types retrieved successfully.
404: No savings types found.
Response Status Codes:
\n200: Savings types retrieved successfully.
404: No savings types found.
Request Parameters:
\nid: integer (required)Response Status Codes:
\n200: Savings type retrieved successfully.
404: Savings type not found.
Response Status Codes:
\n200: Loan types retrieved successfully.
404: No loan types found.
Request Parameters:
\nid: integer (required)Response Status Codes:
\n200: Loan type retrieved successfully.404: Loan type not found.