curl --request POST \
--url https://be-dev-1.dev.ndovu.co/api/v3/partners/{shortName}/customers/{externalUserId}/invest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"planId": 12,
"amount": 5000,
"currency": "KES",
"channel": "BANK_TRANSFER"
}
'{
"reference": "NDV7F3K9Q",
"channel": "MPESA",
"amount": 5000,
"finalAmount": 5000,
"currency": "KES",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z",
"fee": 50,
"mnoReference": "<string>",
"bankReference": "<string>",
"phoneNumber": "+2547...5678",
"plan": {
"id": 12,
"name": "Ndovu Money Market Fund"
},
"transactionId": 123,
"completedAt": "2023-11-07T05:31:56Z",
"bankDetails": {
"bankName": "<string>",
"bankBranch": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>"
}
}{
"reference": "NDV7F3K9Q",
"channel": "MPESA",
"amount": 5000,
"finalAmount": 5000,
"currency": "KES",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z",
"fee": 50,
"mnoReference": "<string>",
"bankReference": "<string>",
"phoneNumber": "+2547...5678",
"plan": {
"id": 12,
"name": "Ndovu Money Market Fund"
},
"transactionId": 123,
"completedAt": "2023-11-07T05:31:56Z",
"bankDetails": {
"bankName": "<string>",
"bankBranch": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>"
}
}Invest for a customer
Creates a Payment for one plan. Whether it is an initial investment or a top-up is decided from the customer’s holdings. For BANK_TRANSFER, the bank details to pay into are provided in the response, and the payment reference is required as the memo (narration) on the transfer; for MPESA, an STK push goes to phoneNumber. Resend a timed-out request with the same Idempotency-Key: you get the original Payment back, never a second one. After a FAILED Payment, use a new key.
curl --request POST \
--url https://be-dev-1.dev.ndovu.co/api/v3/partners/{shortName}/customers/{externalUserId}/invest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"planId": 12,
"amount": 5000,
"currency": "KES",
"channel": "BANK_TRANSFER"
}
'{
"reference": "NDV7F3K9Q",
"channel": "MPESA",
"amount": 5000,
"finalAmount": 5000,
"currency": "KES",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z",
"fee": 50,
"mnoReference": "<string>",
"bankReference": "<string>",
"phoneNumber": "+2547...5678",
"plan": {
"id": 12,
"name": "Ndovu Money Market Fund"
},
"transactionId": 123,
"completedAt": "2023-11-07T05:31:56Z",
"bankDetails": {
"bankName": "<string>",
"bankBranch": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>"
}
}{
"reference": "NDV7F3K9Q",
"channel": "MPESA",
"amount": 5000,
"finalAmount": 5000,
"currency": "KES",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z",
"fee": 50,
"mnoReference": "<string>",
"bankReference": "<string>",
"phoneNumber": "+2547...5678",
"plan": {
"id": 12,
"name": "Ndovu Money Market Fund"
},
"transactionId": 123,
"completedAt": "2023-11-07T05:31:56Z",
"bankDetails": {
"bankName": "<string>",
"bankBranch": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"swiftCode": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Generate one per intended investment (a UUID is recommended) and resend it on retries. The same key with the same body returns the original Payment; with a different body, 409.
Path Parameters
Your partner short name
Your own ID for the customer
Body
A plan id from GET plans
12
x >= 15000
KES, USD, RWF, TZS, EUR, GBP "KES"
MPESA, BANK_TRANSFER "BANK_TRANSFER"
Required for MPESA: the number that receives the STK push. Any valid number; it need not be the customer's own
"+254712345678"
Response
Payment already created with this Idempotency-Key
The PaymentReference. For a bank transfer, quote it as the transfer memo
"NDV7F3K9Q"
MPESA, BANK_TRANSFER 5000
The amount to pay
5000
"KES"
PENDING, COMPLETED, FAILED The deposit fee this investment will be charged
50
The M-Pesa receipt
The bank's own transaction id, once reconciled
The paying number, redacted (M-Pesa)
"+2547...5678"
Show child attributes
Show child attributes
The Transaction this Payment funds. Null until the Payment is COMPLETED, when the Transaction is created
Where to send a bank transfer. Only while a BANK_TRANSFER Payment is PENDING
Show child attributes
Show child attributes