Active
IPO
List NGX offers, supported banks, brokers, check rights eligibility, create IPO subscriptions, and lookup transactions.
Authentication
- Send the tenant API key with `X-API-Key`.
- Send `X-Environment` as `sandbox` or `live` where applicable.
- Your API key must include the `investment_ipo` product scope.
- Your tenant must have access to the product in the selected environment.
- Wallet and rate-limit checks may apply depending on the endpoint.
Endpoint
txt
GET http://203.123.85.26/api/ngx-invest/offers
Endpoint
txt
GET http://203.123.85.26/api/ngx-invest/supported-banks
Endpoint
txt
GET http://203.123.85.26/api/ngx-invest/brokers
Endpoint
txt
GET http://203.123.85.26/api/ngx-invest/rights-eligibility?offer={offerId}&chn={chn}Endpoint
txt
POST http://203.123.85.26/api/ngx-invest/subscribe
Endpoint
txt
POST http://203.123.85.26/api/ngx-invest/transactions
Subscription Request
json
{
"vendorId": "11111111-1111-1111-1111-111111111111",
"offerId": "ngx_offer_001",
"offerType": "PrimaryOffer",
"numberOfShares": 100,
"brokerId": "broker_001",
"profileType": "INDIVIDUAL",
"firstName": "Ada",
"lastName": "Okafor",
"dateOfBirth": "1990-01-01",
"gender": "Female",
"email": "ada@example.com",
"phoneNumber": "08012345678",
"bvn": "22222222222",
"nin": "55555555555",
"address": "12 Marina Road, Lagos",
"nationality": "Nigerian",
"state": "Lagos",
"lga": "Lagos Island",
"maritalStatus": 1,
"nextOfKinFullName": "Chinedu Okafor",
"nextOfKinPhone": "08087654321",
"bankCode": "044",
"bankId": 1,
"bankAccountNumber": "0123456789",
"hasExistingChnCscs": false,
"isCardPayment": false
}Subscription Response
json
{
"success": true,
"message": "Subscription created successfully",
"data": {
"success": true,
"message": "Subscription created successfully",
"localSubscriptionId": "c6afc512-7c64-4d5f-a6c7-5370f93888b0",
"ngxReferenceNumber": "NGX-TXN-0001",
"ngxSubscriptionId": "ngx_sub_001",
"amount": 250000
},
"errors": null
}Transaction Lookup Request
json
{
"transactionReference": "NGX-TXN-0001",
"page": 1,
"size": 20
}Transaction Lookup Response
json
{
"success": true,
"message": "Success",
"data": {
"transactions": [
{
"id": "txn_001",
"transactionReference": "NGX-TXN-0001",
"isSettledPayment": true,
"numberOfShares": 100,
"amount": 250000,
"subscription": {
"id": "ngx_sub_001",
"investorName": "Ada Okafor",
"offerName": "Sample IPO Offer",
"offerId": "ngx_offer_001"
}
}
],
"page": 1,
"size": 20,
"totalPages": 1,
"totalCount": 1
}
}cURL
bash
curl -X GET "http://203.123.85.26/api/ngx-invest/offers" \ -H "X-API-Key: sk_test_your_key" \ -H "X-Environment: sandbox"
cURL
bash
curl -X POST "http://203.123.85.26/api/ngx-invest/transactions" \
-H "Content-Type: application/json" \
-H "X-API-Key: sk_test_your_key" \
-H "X-Environment: sandbox" \
-d '{"transactionReference":"NGX-TXN-0001","page":1,"size":20}'