Deposits

Create Deposit

To make a deposit, you send a notification request with the necessary details to credit the user's brokerage account. Upon receiving the request, a record is created in our system and verification checks are performed to confirm the deposit source.

Verification is carried out using an endpoint you provide to our integration team during account setup. Once the deposit is verified, the specified amount is credited to the user's brokerage account, and deposit status events are sent via Google Pub/Sub. (see details under events section)

Verification Endpoint Requirements:

  • Request Type: GET
  • URL Pattern: THE_URL/deposit/status/YOUR_UNIQUE_REFERENCE
  • Authentication: Static hash in headers (share this hash with Bamboo along with your verification URL)

Example JSON Webhook Response:

{
  "data": {
    "status": "settled", // or "failed"
    "currency": "NGN",
    "amount": 30000.00
  },
  "status": "settled" // or "failed"  
}

NB: You can also monitor all deposit activity through the <a href="http://pbb.investbamboo.com/"> PBB Dashboard</a>.

post/bamboo/webhook

Request

  • Base URL
    https://powered-by-bamboo-sandbox.investbamboo.com
  • Auth
    none declared. Required headers: content-type, accept-language, x-user-id, x-subject-type, x-client-token, x-request-source

Headers

content-typestring required

Acceptable content type

accept-languagestring required

Acceptable language; 'en' for English

x-user-idstring required

Required for user authentication

x-subject-typestring required

For user request -> 'tenant'.

x-client-tokenstring required

API Consumer Authorisation Token

x-request-sourcestring required

The tenant's username

Request body

amount_paidnumber required

Amount to be deposited

currencystring required

Currency

providerstring required

API Consumer Name

referencestring required

Deposit reference

phone_numberstring required

User phone number

transaction_datestring required

Date of creating the transaction

marketstring

Either "US" or "NGX". It's used to specify desired stock market. If no market is specified, it defaults to US.

Example request

{
  "amount_paid": 5000,
  "currency": "NGN",
  "provider": "invest-bamboo",
  "reference": "INVcal2VzeVGJkCXNx",
  "phone_number": "+2348036477166",
  "transaction_date": "2022-02-02",
  "market": "US"
}

Response

200 OK

string required

No response body for this endpoint

Changes

No recorded changes to this operation across all 1 revision of this API.