Withdrawals

Create Withdrawal

Withdrawal requests follow a similar verification flow as deposits. You send a notification request with the necessary details to debit the user's brokerage account, we verify that the user has the amount requested. Once verified, the specified amount is deducted from the user's brokerage account, and withdrawal status events are sent via Google Pub/Sub.

Offline settlement happens between our teams using established procedures. (see event details under withdrawal status events)

post/api/tenant_brokerage_withdraw

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

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

Request body

currencystring required

currency

amountinteger required

amount

referencestring required

reference

marketstring

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

Example request

{
  "currency": "NGN",
  "amount": 13400,
  "reference": "INVKPxiJVc40BNaQBH",
  "market": "US"
}

Response

Withdrawal requested

string required

No response body for this endpoint

Changes

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