Bamboo Card
Open in PostmanGo to Client Portal
HomeAPI ReferenceAccountsGet Accounts
GET

Get Accounts

Retrieve the funded Bamboo accounts linked to your client profile, including balance, currency, activity state, and environment.

GET/api/integration/v1.0/accounts

Follow this flow to place your first order

View all steps
1

Get catalog

Discover available products

2

Get accounts

Retrieve your accounts

3

Place order

Create an order for your customer

4

Get order

Check order status

5

Notification

Receive webhook updates

This endpoint returns all Bamboo accounts available for the authenticated client. Each account represents a settlement balance in a specific currency and environment.

Use the returned AccountId when placing orders. Bamboo validates the account against your credentials, the selected environment, and the account activity state before an order is accepted.

This endpoint requires Basic Auth using your API credentials.

Response specifications

Bamboo returns an accounts array. Store the active account IDs that match the currencies and environments you plan to order from.

FieldTypeDescription
accountsarrayList of Bamboo accounts linked to the authenticated client.
idnumberUnique account identifier used as AccountId in Place Order.
currencystringAccount currency in ISO format.
balancenumberCurrent available balance for the account.
isActivebooleanWhether the account can be used for ordering.
sandboxModebooleanTrue for sandbox accounts and false for production accounts.

Examples

Full request and response examples for this endpoint.

Example request

Use this full request as the primary reference for client-side implementation.

cURL - cURL
# Generate token: echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64

curl --location 'https://api.bamboocardportal.com/api/integration/v1.0/accounts' \
  --header 'Authorization: Basic YOUR_BASE64_TOKEN' \
  --header 'Accept: application/json'

Example response

Use this sample payload to validate parsing, field mapping, and downstream handling.

200 OK
JSON
{
  "accounts": [
    {
      "id": 555,
      "currency": "USD",
      "balance": 100828.4848,
      "isActive": true,
      "sandboxMode": true
    },
    {
      "id": 783,
      "currency": "EUR",
      "balance": 0,
      "isActive": true,
      "sandboxMode": true
    }
  ]
}

Using AccountId in later calls

Get Accounts is the step that links catalog discovery to order placement.

1

Pick the correct account

Choose an account whose currency and environment match the order you intend to place.

2

Pass AccountId into Place Order

Use the selected accounts[].id value as AccountId in the POST /orders/checkout body.

3

Keep environments separate

Sandbox account IDs and live account IDs are different and cannot be mixed.

Operational notes

Account balances and environment flags affect whether Bamboo will accept an order.

Active accounts only

Inactive accounts cannot be used in Place Order even if the currency matches.

Balance is available spend

balance represents the available amount currently ready for order settlement.

Multiple currencies

A single client can receive more than one account when Bamboo has funded multiple settlement currencies.

Sandbox flag

sandboxMode tells you whether the returned account belongs to sandbox or production.

PreviousGet catalogNextPlace Order

On this page

Try it out

Open the interactive API panel to test this endpoint with your own credentials.