Retrieve wallet addresses

Beam maintains wallets to hold each of the enabled cryptocurrencies in your Beam account. Your wallet addresses rarely change so it is safe to call this API one time and cache the results.

  • Authentication is done through a Bearer token with your API key (see Introduction > Configure API Access)
  • You will need the wallet ID associated with each wallet later when using the create external fiat payment API.
  • You will also use the wallet address later when requesting crypto from your customer’s clients.
    • Note: For your payment processing platform, all of your customers will use the same wallets as payments are tracked via transaction IDs.

API Endpoint

GET /smb/wallets

Example

curl --request GET  
     --url <https://api.dev.getbeam.cash/smb/wallets>  
     --header 'Authorization: Bearer beam_sandbox_abc123'  
     --header 'Content-Type: application/json'

Response

{  
  "fiat": \[  
    {  
      "id": "ebbf9175-843f-40c4-95e7-9c414daae8d0",  
      "accountId": "865859ae-99d1-475a-aa7b-613dfa7bbc47",  
      "assetId": "usd",  
      "type": "Wire",  
      "balance": "15689.59",  
      "instructions": {...},  
        "subAccountsWire": \[]  
      },  
      "vendor": "Fortress",  
      "createdAt": "2024-06-13T09:56:55.588Z",  
      "updatedAt": "2024-12-12T14:54:08.583Z",  
      "asset": {  
        "id": "usd",  
        "symbol": "USD",  
        "type": "Fiat",  
        "enabled": true,  
        "usdOverrideValue": null,  
        "networkId": null,  
        "networkName": null,  
        "zerohashId": "USD",  
        "iconFileName": null,  
        "trmAssetId": null,  
        "bridgeAssetId": "usd",  
        "fortressAssetId": "usd",  
        "createdAt": "2023-11-22T15:15:11.549Z",  
        "updatedAt": "2023-11-22T15:15:11.549Z"  
      },  
      "locked": 300,  
      "total": 15989.59,  
      "disbursable": 15689.59,  
      "pending": 0  
    }  
  ],  
  "crypto": [  
    {  
      "id": "83a51025-2ed8-4450-856b-31bc642ca00a",  
      "address": "0x8969245A790068F8927208f851e0E50A11C0e5aC",  
      "symbol": "USDC",  
      "network": "Ethereum",  
      "balance": 0,  
      "locked": 0,  
      "pending": 0,  
      "total": 0,  
      "createdAt": "2024-01-22T19:56:37.257Z"  
    }  
  ]  
}