List agent's internal accounts

Retrieve the internal accounts belonging to the customer this agent operates on behalf of. Use this to discover available source accounts for transfers and quotes, and to verify which accounts are accessible under the agent’s accountRestrictions policy.

GET /agents/me/internal-accounts

List agent's internal accounts

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/internal-accounts \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "InternalAccount:12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
      "type": "INTERNAL_FIAT",
      "status": "ACTIVE",
      "balance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "totalBalance": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "fundingPaymentInstructions": [
        {
          "accountOrWalletInfo": {
            "accountType": "USD_ACCOUNT",
            "accountNumber": "1234567890",
            "routingNumber": "021000021",
            "bankName": "Chase Bank",
            "intermediaryBankName": "JPMorgan Chase Bank",
            "intermediaryRoutingNumber": "021000021",
            "fiToFiInformation": "/BNF/Invoice 4471",
            "bankAccountType": "CHECKING"
          },
          "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
          "isPlatformAccount": true
        }
      ],
      "createdAt": "2025-10-03T12:30:00Z",
      "updatedAt": "2025-10-03T12:30:00Z",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "onBehalfOfCustomerId": "Customer:019542f5-b3e7-1d02-0000-000000000002",
      "label": "invoice-4417",
      "sweepRule": {
        "destination": {
          "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
          "paymentRail": "ACH"
        },
        "minimumAmount": {
          "amount": 12550,
          "currency": {
            "code": "USD",
            "name": "United States Dollar",
            "symbol": "$",
            "decimals": 2
          }
        },
        "maximumAmount": {
          "amount": 12550,
          "currency": {
            "code": "USD",
            "name": "United States Dollar",
            "symbol": "$",
            "decimals": 2
          }
        },
        "purposeOfPayment": "SELF",
        "description": "Rent sweep",
        "remittanceInformation": "Unit 4B March",
        "platformFeeOverride": {
          "platformFixedFee": {
            "amount": 50,
            "currency": "USD"
          },
          "platformVariableFeeBps": 30
        }
      },
      "scaChallenge": {
        "id": "ScaChallenge:019542f5-b3e7-1d02-0000-000000000007",
        "expiresAt": "2025-10-03T12:05:00Z",
        "factor": "SMS_OTP",
        "availableFactors": [
          "SMS_OTP"
        ],
        "purpose": "PAYOUT",
        "passkeyAssertionOptions": {},
        "passkeyAllowedOrigins": [
          "https://app.example.com"
        ]
      },
      "strandedBalances": [
        {
          "amount": 12550,
          "currency": {
            "code": "USD",
            "name": "United States Dollar",
            "symbol": "$",
            "decimals": 2
          }
        }
      ],
      "privateEnabled": true,
      "cardCapabilities": {
        "supportsVelocityLimits": true,
        "supports3dSecurePassword": false,
        "supportsPanReveal": true,
        "supportsDigitalWalletTokenization": true
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Query Parameters

currency · string

Filter by currency code

type · enum<string>

Filter by internal account type. Use EMBEDDED_WALLET to find the self-custodial wallet provisioned for the customer, INTERNAL_FIAT / INTERNAL_CRYPTO for platform-managed holding accounts, or RULE_BASED for the additional account numbers issued with a sweep rule. Classification of an internal account.

• INTERNAL_FIAT: A Grid-managed fiat holding account (for example, the USD holding account used as the source for Payouts flows).
• INTERNAL_CRYPTO: A Grid-managed crypto holding account denominated in a stablecoin such as USDC.
• EMBEDDED_WALLET: A self-custodial Embedded Wallet provisioned for the customer. Outbound transfers require a session signature produced by the customer's device — see the Embedded Wallets guide.
• RULE_BASED: An additional account number for an existing account holder, with a routing rule attached, so incoming payments can be attributed to a specific payer and swept automatically. Created with POST /internal-accounts.
• BULK_SETTLEMENT: An account for receiving bulk payments (for example, a single settlement from a payment processor) that the platform then pays out to its customers. Only a platform can hold one, and funds in it can move only to the platform's customers.

Available options: INTERNAL_FIAT, INTERNAL_CRYPTO, EMBEDDED_WALLET, RULE_BASED, BULK_SETTLEMENT

limit · integer · default: 20

Maximum number of results to return (default 20, max 100)

Required range: 1 <= x <= 100

cursor · string

Cursor for pagination (returned from previous request)

Response

200

application/json

Successful operation

data · object[] · required

List of internal accounts matching the filter criteria

Show child attributes

hasMore · boolean · required

Indicates if more results are available beyond this page

nextCursor · string

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCount · integer

Total number of customers matching the criteria (excluding pagination)