Aggregator Investment

List of Aggregator Investment API endpoints

Introduction

See Aggregator Investment API endpoints below.

Create a new Customer (Corporate)

POST {{BaseUrl}}api/v1/account/aggregator_signup_customer

Endpoint to onboard a new corporate customer.

Request Body

Name	Type	Description
first_name*	string	customer first name
last_name*	string	customer last name
phone_number*	string	customer phone number
email*	string	email address
biz_name*	string	Business name
gender	string	gender
funder_type_id*	number	Funder type id for corporate (2)
country_code*	string	Country code
bank_id	string	Bank Id
bank_account_number	string	Bank Account Number
bank_account_name	string	Bank Account Name
bank_name	string	Bank Name
routing_number	string	Routing Number
swift_code	string	Swift Code
biz_email	string	Business Email
Address	string	Address
business_unique_identifier	string	A unique identification number for the business
postal_code	string	Area Postal Code
City*	string	City
next_of_kin_first_name	string	First name of Next of Kin
next_of_kin_last_name	string	Last name of Next of Kin
next_of_kin_email	string	Email of Next of Kin
next_of_kin_phone_number	string	Phone number of Next of Kin
next_of_kin_gender	string	Gender of Next of Kin
relationship_with_next_kin	string	Customer relationship with Next of Kin
next_of_kin_dial_code	string	Next of Kin dial code
next_of_kin_street	string	Next of Kin street
next_of_kin_city	string	Next of Kin City
next_of_kin_state	string	Next of kin state
next_of_kin_country	string	Next of kin Country
effective_date	string	Effective date of customer account
funder_documents	Array	Array of documents to be uploaded during signup eg [{ "document_type_code": "", "base64_file_string": "", "filename_with_extension": "png" }]

201: Created

{
    //response
}

Create a new Customer (Individual)

POST {{BaseUrl}}api/v1/account/aggregator_signup_customer

Endpoint to onboard a new individual customer.

Query Parameters

Name	Type	Description
country_code	string	Customer's country code eg: NG, KE
first_name*	string	Customer first name
last_name*	string	Customer last name
phone_number*	string	Customer phone number
email*	string	Customer email
gender*	string	Customer gender
funder_type_id*	number	Funder type id for individual customer (1)
bank_id	number	Bank Id
bank_account_number	string	Customer's Bank Account Number
bank_account_name	string	Customer's Bank Account Name
bank_name	string	Bank Name
routing_number	string	Routing number for foreign banks
swift_code	string	Swift Code
address	string	Address of Customer
customer_unique_identifier	string	Customer's unique identifier
postal_code	string	Postal Code
city	string	City of residence
next_of_kin_first_name	string	First name of customer's next of kin
next_of_kin_last_name	string	Last name of customer's next of kin
next_of_kin_email	string	Email of customer's next of kin
next_of_kin_phone_number	string	Phone number of customer's next of kin
next_of_kin_gender	string	Gender of customer's next of kin
relationhip_with_next_kin	string	Customer's relationship with next of kin
next_of_kin_dial_code	string	Dial code of customer's next of kin
next_of_kin_street	string	Street of customer's next of kin
next_of_kin_city	string	City of customer's next of kin
next_of_kin_state	string	State of customer's next of kin
next_of_kin_country	string	Country of customer's next of kin
effective_date	string	Effective date of customer's account
funder_documents	Array	Array of documents to be uploaded during signup eg [{ "document_type_code": "", "base64_file_string": "", "filename_with_extension": "alexa.png" }]

201: Created

{
    "data": {
            "id": number,
            "name": " string",
            "slug": "string",
            "code": "string",
            "longcode": "string",
            "vigipay_bank_id": "string",
            "country_code": "string"
        },
    "message": "Success",
    "status": true,
    "status_code": 201
}

Get Customers

GET {{BaseUrl}}/api/v1/account/query_funder

Endpoint to get all customers.

Query Parameters

Name	Type	Description
FunderType	number	Funder Type id
from_date	Date	Start date
to_date	Date	End Date
FunderName	string	Funder name
FunderId	number	Funder Id
AggregatorId	number	Aggregator Id
Page	number	Page to fetch
PageSize	number	Page size to fetch

200

{
  "data": [
    //customer
  ],
  "message": "Success",
  "status": true,
  "status_code": 200
}

Get Customer Wallet Balance

GET {{BaseUrl}}/api/v1/account/get_funder_wallet_balance

Get customer wallet balance

Query Parameters

Name	Type	Description
savingsWalletId	number	Wallet Id of a savings account
funderId	number	Funder Id

200

{
    "data": [
      {
        //wallet 
      },
      "message": "Success",
      "status": true,
      "status_code": 200
  ]
}

Get Customer Wallet Transactions

GET {{BaseUrl}}/api/v1/account/get_funder_wallet_transactions

Query Parameters

Name	Type	Description
savingsWalletId	number	Wallet Id of the customer's saving account
funderId	number	Customer's Id
page	number	Page to return
pageSize	number	Page size to return

200

{
    "data": [
      {
        //wallet Transaction
      },
      "message": "Success",
      "status": true,
      "status_code": 200
  ]
}

Retrieve investment products per aggregator

GET {{BaseUrl}}/api/v1/eco/aggregator/investment_products

Endpoint to fetch investment products by aggregator

Query Parameters

Name	Type	Description
aggregatorId	number	aggregator id

200

{
  "data": {
    //investment product
    },
  "message": "Success",
  "status": true,
  "status_code": 200
}

Get investor's document types

GET {{BaseUrl}}/api/v1/document/investor_document_types

Endpoint to get investor's document types

200: OK

{
  "data": [
   {
    //investment document types
    }
  ],
  "message": "Success",
  "status": true,
  "status_code": 200
}

Get genders by country

GET {{BaseUrl}}/api/v1/account/get_genders

This endpoints get genders supported in a country

Query Parameters

Name	Type	Description
countryCode	string	Country Code eg NG, KE etc

200: OK

{
  "data": [
   {
    //genders
    }
  ],
  "message": "Success",
  "status": true,
  "status_code": 200
}

Create a customer's investment

POST {{baseUrl}}/api/v1/account/aggregator/create_customer_investment

Request Body

Name	Type	Description
principal_amount*	number	Principal amount
tenure	number	Investment tenure eg 30, 90 etc
currency*	string	Currency of the investment eg NGN, USD
base64_file_string	string	A base 64 image string
filename_with_extension	string	File name with extension
interest_repayment_type	string	Investment interest repayment type eg Monthly
payment_gateway_reference	string	A reference to a payment gateway
funder_id*	number	Funder id
investment_product_id*	number	Id of the investment product

201: Created

{
    "data": [
        {
            //data
        },
    "message": "Success",
    "status": true,
    "status_code": 201
}

Get aggregator's investments

GET {{baseUrl}}/api/v1/account/get_aggregator_investments

Query Parameters

Name	Type	Description
aggregatorId*	number	Aggregator's Id

200: OK

{
  "data": [
   {
    //investments
    }
  ],
  "message": "Success",
  "status": true,
  "status_code": 200
}

Get a Customer's investments

GET {{baseUrl}}/api/v1/account/get_funder_investments

Query Parameters

Name	Type	Description
funderId*	number	Funder Id
walletAccountId*	number	Customer's wallet Id
investmentProductId*	number	Investment product id

200: OK

{
  "data": {
    //investments
    },
  "message": "Success",
  "status": true,
  "status_code": 200
}

Aggregator investment interest calculator.

GET {{baseUrl}}/api/v1/account/aggregator_investment_interest_calculator

Query Parameters

Name	Type	Description
PrincipalAmount*	number	Principal amount
Tenure*	number	Investment tenure
StartDate*	dateTime	Investment start date
InterestRepaymentType*	string	Investment repayment type
InvestmentProductId*	number	Investment product Id
InvestmentCurrencyType*	string	Investment currency type

200: OK

{
  "data": {
    //investment interest
    },
  "message": "Success",
  "status": true,
  "status_code": 200
}

Get funder's investment

GET {{baseUrl}} ​/api​/v1​/account​/get_funder_investment_by_id

Query Parameters

Name	Type	Description
funderInvestmentId	number	Customer's investment Id

200: OK

{
  "data": {
    //investment
    },
  "message": "Success",
  "status": true,
  "status_code": 200
}

Withdraw aggregator funds

POST {{baseUrl}}/api/v1/account/aggregator_withdraw_funds

This endpoint enables an aggregator to withdraw fund.

Request Body

Name	Type	Description
wallet_id*	number	Wallet Id
funder_id*	number	Funder Id
amount*	number	Amount to withdraw
narration	string	Narration on the withdrawals

201: Created

{
    "data": {
            //data
        },
    "message": "Success",
    "status": true,
    "status_code": 201
}