On this page

    1. Home
    2. API
    3. API Reference
    4. Account
    5. Account Wallets

    Account Wallets

    This endpoint returns a list of all wallets (both Circle-managed and external) that are linked to your URnetwork account for payouts and billing.


    GET /account/wallets

    Retrieve all registered wallets for the authenticated network.

    Request

    GET /account/wallets

    Headers:

    {
      "Host": "api.bringyour.com",
      "Authorization": "Bearer YOUR_JWT_TOKEN",
      "Accept": "application/json"
    }

    Response

    200 Success

    Status: 200 OK

    Content-Type: application/json

    {
      "wallets": [
        {
          "wallet_id": "string",
          "circle_wallet_id": "string",
          "network_id": "string",
          "wallet_type": "circle",
          "blockchain": "SOL",
          "wallet_address": "string",
          "active": true,
          "default_token_type": "USDC",
          "create_time": "string"
        }
      ]
    }

    Fields

    FieldTypeDescription
    walletsarrayA list of wallets associated with your network.
    wallets[].wallet_idstringUnique internal identifier for the wallet.
    wallets[].circle_wallet_idstringOptional. The external identifier if managed by Circle.
    wallets[].wallet_typestringEither circle or external.
    wallets[].blockchainstringThe blockchain network: SOL or MATIC.
    wallets[].wallet_addressstringThe public blockchain address.
    wallets[].activebooleanWhether the wallet is currently eligible for payouts.
    wallets[].default_token_typestringThe preferred token for transfers (e.g., USDC).
    wallets[].create_timestringISO 8601 timestamp of registration.

    Example

    HTTP Request

    GET /account/wallets HTTP/1.1
    Host: api.bringyour.com
    Authorization: Bearer YOUR_JWT_TOKEN
    Accept: application/json

    Successful HTTP Response

    {
      "wallets": [
        {
          "wallet_id": "w_98765",
          "wallet_type": "external",
          "blockchain": "SOL",
          "wallet_address": "HN7cABqL36vRRXYZ8Q4sG",
          "active": true,
          "default_token_type": "USDC",
          "create_time": "2024-12-01T10:00:00Z"
        }
      ]
    }


    Powered by Sudoc v2.5.0
    Hide table of contents