Agent Operations

List agent's internal accounts

Changed on

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

Request

  • Base URL: https://api.lightspark.com/grid/2025-10-13
  • URL: https://api.lightspark.com/grid/2025-10-13/agents/me/internal-accounts
  • Auth: HTTP bearer

Query parameters

currencystring

Filter by currency code

type'INTERNAL_FIAT' | 'INTERNAL_CRYPTO' | 'EMBEDDED_WALLET' | 'RULE_BASED' | 'BULK_SETTLEMENT'

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.

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.

limitinteger

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

cursorstring

Cursor for pagination (returned from previous request)

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

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

totalCountinteger

Total number of customers matching the criteria (excluding pagination)

Changes

  • 556180e5b2aeRevision changes
    • warning

      added the new ACH_SAME_DAY enum value to the //////////// response property for the response status

    • warning

      added the new ACH_SAME_DAY enum value to the ////////// response property for the response status

    • warning

      added the new BULK_SETTLEMENT enum value to the // response property for the response status

    • info

      added the new enum value BULK_SETTLEMENT to the query request parameter type

  • 5b4d838613abRevision changes
    • warning

      removed the optional property ////////////// from the response with the status

    • info

      added the optional property /////////// to the response with the status